Fixing, more & more

This commit is contained in:
blacklight 2009-08-09 11:17:39 +02:00
parent 7b16294784
commit b50b2c08ae
138 changed files with 23410 additions and 789 deletions

BIN
doc/latex/FreeSans.ttf Normal file

Binary file not shown.

39
doc/latex/Makefile Normal file
View file

@ -0,0 +1,39 @@
all: clean refman.dvi
ps: refman.ps
pdf: refman.pdf
ps_2on1: refman_2on1.ps
pdf_2on1: refman_2on1.pdf
refman.ps: refman.dvi
dvips -o refman.ps refman.dvi
refman.pdf: refman.ps
ps2pdf refman.ps refman.pdf
refman.dvi: refman.tex doxygen.sty
echo "Running latex..."
latex refman.tex
echo "Running makeindex..."
makeindex refman.idx
echo "Rerunning latex...."
latex refman.tex
latex_count=5 ; \
while egrep -s 'Rerun (LaTeX|to get cross-references right)' refman.log && [ $$latex_count -gt 0 ] ;\
do \
echo "Rerunning latex...." ;\
latex refman.tex ;\
latex_count=`expr $$latex_count - 1` ;\
done
refman_2on1.ps: refman.ps
psnup -2 refman.ps >refman_2on1.ps
refman_2on1.pdf: refman_2on1.ps
ps2pdf refman_2on1.ps refman_2on1.pdf
clean:
rm -f *.ps *.dvi *.aux *.toc *.idx *.ind *.ilg *.log *.out refman.pdf

385
doc/latex/Markup_8h.tex Normal file
View file

@ -0,0 +1,385 @@
\section{Markup.h File Reference}
\label{Markup_8h}\index{Markup.h@{Markup.h}}
{\tt \#include $<$stdlib.h$>$}\par
{\tt \#include $<$string.h$>$}\par
{\tt \#include $<$string$>$}\par
\subsection*{Classes}
\begin{CompactItemize}
\item
struct {\bf MCD\_\-CSTR}
\item
class {\bf CMarkup}
\item
struct {\bf CMarkup::ElemPos}
\item
struct {\bf CMarkup::NodePos}
\item
struct {\bf CMarkup::TokenPos}
\item
struct {\bf CMarkup::SavedPos}
\item
struct {\bf CMarkup::SavedPosMap}
\item
struct {\bf CMarkup::SavedPosMapArray}
\item
struct {\bf CMarkup::PosArray}
\item
struct {\bf CMarkup::NodeStack}
\item
struct {\bf CMarkup::FilePos}
\item
struct {\bf CMarkup::ConvertEncoding}
\end{CompactItemize}
\subsection*{Defines}
\begin{CompactItemize}
\item
\#define {\bf \_\-MARKUP\_\-H\_\-INCLUDED\_\-}
\item
\#define {\bf MARKUP\_\-STL}
\item
\#define {\bf MARKUP\_\-SIZEOFWCHAR}~2
\item
\#define {\bf MARKUP\_\-WINCONV}
\item
\#define {\bf MCD\_\-ACP}~0
\item
\#define {\bf MCD\_\-UTF8}~65001
\item
\#define {\bf MCD\_\-UTF16}~1200
\item
\#define {\bf MCD\_\-UTF32}~65005
\item
\#define {\bf MCD\_\-CHAR}~char
\item
\#define {\bf MCD\_\-PCSZ}~const char$\ast$
\item
\#define {\bf MCD\_\-PSZLEN}~(int)strlen
\item
\#define {\bf MCD\_\-PSZCHR}~strchr
\item
\#define {\bf MCD\_\-PSZSTR}~strstr
\item
\#define {\bf MCD\_\-PSZTOL}~strtol
\item
\#define {\bf MCD\_\-PSZNCMP}~strncmp
\item
\#define {\bf MCD\_\-SSZ}(sz)~sz
\item
\#define {\bf MCD\_\-PSZCPY}~strcpy
\item
\#define {\bf MCD\_\-PSZNCPY}~strncpy
\item
\#define {\bf MCD\_\-PSZCAT}~strcat
\item
\#define {\bf MCD\_\-SPRINTF}~sprintf
\item
\#define {\bf MCD\_\-FOPEN}(f, n, m)~f=fopen(n,m)
\item
\#define {\bf MCD\_\-T}(s)~s
\item
\#define {\bf MCD\_\-ENC}~MCD\_\-T(\char`\"{}UTF-8\char`\"{})
\item
\#define {\bf MCD\_\-CLEN}(p)~1
\item
\#define {\bf MCD\_\-STRERROR}~strerror(errno)
\item
\#define {\bf MCD\_\-STR}~std::string
\item
\#define {\bf MCD\_\-2PCSZ}(s)~s.c\_\-str()
\item
\#define {\bf MCD\_\-STRLENGTH}(s)~(int)s.size()
\item
\#define {\bf MCD\_\-STRCLEAR}(s)~s.erase()
\item
\#define {\bf MCD\_\-STRISEMPTY}(s)~s.empty()
\item
\#define {\bf MCD\_\-STRMID}(s, n, l)~s.substr(n,l)
\item
\#define {\bf MCD\_\-STRASSIGN}(s, p, n)~s.assign(p,n)
\item
\#define {\bf MCD\_\-STRCAPACITY}(s)~(int)s.capacity()
\item
\#define {\bf MCD\_\-STRINSERTREPLACE}(d, i, r, s)~d.replace(i,r,s)
\item
\#define {\bf MCD\_\-GETBUFFER}(s, n)~new MCD\_\-CHAR[n+1]; s.reserve(n)
\item
\#define {\bf MCD\_\-RELEASEBUFFER}(s, p, n)~s.assign(p,n); delete[$\,$]p
\item
\#define {\bf MCD\_\-BLDRESERVE}(s, n)~s.reserve(n)
\item
\#define {\bf MCD\_\-BLDCHECK}(s, n, d)~;
\item
\#define {\bf MCD\_\-BLDRELEASE}(s)~;
\item
\#define {\bf MCD\_\-BLDAPPENDN}(s, p, n)~s.append(p,n)
\item
\#define {\bf MCD\_\-BLDAPPEND}(s, p)~s.append(p)
\item
\#define {\bf MCD\_\-BLDAPPEND1}(s, c)~s+=(MCD\_\-CHAR)(c)
\item
\#define {\bf MCD\_\-STRTOINT}(s)~MCD\_\-PSZTOL(MCD\_\-2PCSZ(s),NULL,10)
\item
\#define {\bf MCD\_\-CSTR\_\-FILENAME}~{\bf MCD\_\-CSTR}
\item
\#define {\bf MCD\_\-T\_\-FILENAME}~MCD\_\-T
\item
\#define {\bf MCD\_\-PCSZ\_\-FILENAME}~MCD\_\-PCSZ
\item
\#define {\bf MARKUP\_\-SETDEBUGSTATE}
\end{CompactItemize}
\subsection{Define Documentation}
\index{Markup.h@{Markup.h}!\_\-MARKUP\_\-H\_\-INCLUDED\_\-@{\_\-MARKUP\_\-H\_\-INCLUDED\_\-}}
\index{\_\-MARKUP\_\-H\_\-INCLUDED\_\-@{\_\-MARKUP\_\-H\_\-INCLUDED\_\-}!Markup.h@{Markup.h}}
\subsubsection[\_\-MARKUP\_\-H\_\-INCLUDED\_\-]{\setlength{\rightskip}{0pt plus 5cm}\#define \_\-MARKUP\_\-H\_\-INCLUDED\_\-}\label{Markup_8h_964424c93c5bcf9f53d1bfb1f48dded8}
\index{Markup.h@{Markup.h}!MARKUP\_\-SETDEBUGSTATE@{MARKUP\_\-SETDEBUGSTATE}}
\index{MARKUP\_\-SETDEBUGSTATE@{MARKUP\_\-SETDEBUGSTATE}!Markup.h@{Markup.h}}
\subsubsection[MARKUP\_\-SETDEBUGSTATE]{\setlength{\rightskip}{0pt plus 5cm}\#define MARKUP\_\-SETDEBUGSTATE}\label{Markup_8h_eb217cbc320c044ab434a9765f3c43da}
Referenced by CMarkup::x\_\-SetPos().\index{Markup.h@{Markup.h}!MARKUP\_\-SIZEOFWCHAR@{MARKUP\_\-SIZEOFWCHAR}}
\index{MARKUP\_\-SIZEOFWCHAR@{MARKUP\_\-SIZEOFWCHAR}!Markup.h@{Markup.h}}
\subsubsection[MARKUP\_\-SIZEOFWCHAR]{\setlength{\rightskip}{0pt plus 5cm}\#define MARKUP\_\-SIZEOFWCHAR~2}\label{Markup_8h_56bf764d158432507ce70140a7a39796}
\index{Markup.h@{Markup.h}!MARKUP\_\-STL@{MARKUP\_\-STL}}
\index{MARKUP\_\-STL@{MARKUP\_\-STL}!Markup.h@{Markup.h}}
\subsubsection[MARKUP\_\-STL]{\setlength{\rightskip}{0pt plus 5cm}\#define MARKUP\_\-STL}\label{Markup_8h_068f185d8c3f5030193410463434700e}
\index{Markup.h@{Markup.h}!MARKUP\_\-WINCONV@{MARKUP\_\-WINCONV}}
\index{MARKUP\_\-WINCONV@{MARKUP\_\-WINCONV}!Markup.h@{Markup.h}}
\subsubsection[MARKUP\_\-WINCONV]{\setlength{\rightskip}{0pt plus 5cm}\#define MARKUP\_\-WINCONV}\label{Markup_8h_dbc6eaa1c00e7bd9a20a31e034dd2e81}
\index{Markup.h@{Markup.h}!MCD\_\-2PCSZ@{MCD\_\-2PCSZ}}
\index{MCD\_\-2PCSZ@{MCD\_\-2PCSZ}!Markup.h@{Markup.h}}
\subsubsection[MCD\_\-2PCSZ]{\setlength{\rightskip}{0pt plus 5cm}\#define MCD\_\-2PCSZ(s)~s.c\_\-str()}\label{Markup_8h_8308b5dc66582065497df0946227c24f}
Referenced by MCD\_\-CSTR::MCD\_\-CSTR().\index{Markup.h@{Markup.h}!MCD\_\-ACP@{MCD\_\-ACP}}
\index{MCD\_\-ACP@{MCD\_\-ACP}!Markup.h@{Markup.h}}
\subsubsection[MCD\_\-ACP]{\setlength{\rightskip}{0pt plus 5cm}\#define MCD\_\-ACP~0}\label{Markup_8h_4b7b55ce45b2dc0166e17835c36d24ae}
\index{Markup.h@{Markup.h}!MCD\_\-BLDAPPEND@{MCD\_\-BLDAPPEND}}
\index{MCD\_\-BLDAPPEND@{MCD\_\-BLDAPPEND}!Markup.h@{Markup.h}}
\subsubsection[MCD\_\-BLDAPPEND]{\setlength{\rightskip}{0pt plus 5cm}\#define MCD\_\-BLDAPPEND(s, \/ p)~s.append(p)}\label{Markup_8h_1b5b2dbff24ec07b7f947a92c79374db}
\index{Markup.h@{Markup.h}!MCD\_\-BLDAPPEND1@{MCD\_\-BLDAPPEND1}}
\index{MCD\_\-BLDAPPEND1@{MCD\_\-BLDAPPEND1}!Markup.h@{Markup.h}}
\subsubsection[MCD\_\-BLDAPPEND1]{\setlength{\rightskip}{0pt plus 5cm}\#define MCD\_\-BLDAPPEND1(s, \/ c)~s+=(MCD\_\-CHAR)(c)}\label{Markup_8h_66fdcace6236f2f212b819bbb607eb00}
\index{Markup.h@{Markup.h}!MCD\_\-BLDAPPENDN@{MCD\_\-BLDAPPENDN}}
\index{MCD\_\-BLDAPPENDN@{MCD\_\-BLDAPPENDN}!Markup.h@{Markup.h}}
\subsubsection[MCD\_\-BLDAPPENDN]{\setlength{\rightskip}{0pt plus 5cm}\#define MCD\_\-BLDAPPENDN(s, \/ p, \/ n)~s.append(p,n)}\label{Markup_8h_3fa052a44a1028c32ec80a98e2dc2ee2}
\index{Markup.h@{Markup.h}!MCD\_\-BLDCHECK@{MCD\_\-BLDCHECK}}
\index{MCD\_\-BLDCHECK@{MCD\_\-BLDCHECK}!Markup.h@{Markup.h}}
\subsubsection[MCD\_\-BLDCHECK]{\setlength{\rightskip}{0pt plus 5cm}\#define MCD\_\-BLDCHECK(s, \/ n, \/ d)~;}\label{Markup_8h_462dda37bd35bcc7de74c6f137678994}
\index{Markup.h@{Markup.h}!MCD\_\-BLDRELEASE@{MCD\_\-BLDRELEASE}}
\index{MCD\_\-BLDRELEASE@{MCD\_\-BLDRELEASE}!Markup.h@{Markup.h}}
\subsubsection[MCD\_\-BLDRELEASE]{\setlength{\rightskip}{0pt plus 5cm}\#define MCD\_\-BLDRELEASE(s)~;}\label{Markup_8h_9ed9b064f852a4ad5a9727b72f09c761}
\index{Markup.h@{Markup.h}!MCD\_\-BLDRESERVE@{MCD\_\-BLDRESERVE}}
\index{MCD\_\-BLDRESERVE@{MCD\_\-BLDRESERVE}!Markup.h@{Markup.h}}
\subsubsection[MCD\_\-BLDRESERVE]{\setlength{\rightskip}{0pt plus 5cm}\#define MCD\_\-BLDRESERVE(s, \/ n)~s.reserve(n)}\label{Markup_8h_3db4aba7b130d4d0ca7eece1314464e8}
\index{Markup.h@{Markup.h}!MCD\_\-CHAR@{MCD\_\-CHAR}}
\index{MCD\_\-CHAR@{MCD\_\-CHAR}!Markup.h@{Markup.h}}
\subsubsection[MCD\_\-CHAR]{\setlength{\rightskip}{0pt plus 5cm}\#define MCD\_\-CHAR~char}\label{Markup_8h_12bf56fe481c397f8df59076c90c45a6}
Referenced by CMarkup::TokenPos::StrNIACmp(), and CMarkup::x\_\-IntToStr().\index{Markup.h@{Markup.h}!MCD\_\-CLEN@{MCD\_\-CLEN}}
\index{MCD\_\-CLEN@{MCD\_\-CLEN}!Markup.h@{Markup.h}}
\subsubsection[MCD\_\-CLEN]{\setlength{\rightskip}{0pt plus 5cm}\#define MCD\_\-CLEN(p)~1}\label{Markup_8h_d56c92f847a54f85e183ebc96422db7b}
\index{Markup.h@{Markup.h}!MCD\_\-CSTR\_\-FILENAME@{MCD\_\-CSTR\_\-FILENAME}}
\index{MCD\_\-CSTR\_\-FILENAME@{MCD\_\-CSTR\_\-FILENAME}!Markup.h@{Markup.h}}
\subsubsection[MCD\_\-CSTR\_\-FILENAME]{\setlength{\rightskip}{0pt plus 5cm}\#define MCD\_\-CSTR\_\-FILENAME~{\bf MCD\_\-CSTR}}\label{Markup_8h_b7f2fa74461b566c44371deb46c73de2}
\index{Markup.h@{Markup.h}!MCD\_\-ENC@{MCD\_\-ENC}}
\index{MCD\_\-ENC@{MCD\_\-ENC}!Markup.h@{Markup.h}}
\subsubsection[MCD\_\-ENC]{\setlength{\rightskip}{0pt plus 5cm}\#define MCD\_\-ENC~MCD\_\-T(\char`\"{}UTF-8\char`\"{})}\label{Markup_8h_76b22bbde60fb0f34064d566e89c456a}
\index{Markup.h@{Markup.h}!MCD\_\-FOPEN@{MCD\_\-FOPEN}}
\index{MCD\_\-FOPEN@{MCD\_\-FOPEN}!Markup.h@{Markup.h}}
\subsubsection[MCD\_\-FOPEN]{\setlength{\rightskip}{0pt plus 5cm}\#define MCD\_\-FOPEN(f, \/ n, \/ m)~f=fopen(n,m)}\label{Markup_8h_f539ef4d57b2dc09eae1ff35115d30b3}
\index{Markup.h@{Markup.h}!MCD\_\-GETBUFFER@{MCD\_\-GETBUFFER}}
\index{MCD\_\-GETBUFFER@{MCD\_\-GETBUFFER}!Markup.h@{Markup.h}}
\subsubsection[MCD\_\-GETBUFFER]{\setlength{\rightskip}{0pt plus 5cm}\#define MCD\_\-GETBUFFER(s, \/ n)~new MCD\_\-CHAR[n+1]; s.reserve(n)}\label{Markup_8h_8bec93c42fdcd4f51326f897d2185aa8}
\index{Markup.h@{Markup.h}!MCD\_\-PCSZ@{MCD\_\-PCSZ}}
\index{MCD\_\-PCSZ@{MCD\_\-PCSZ}!Markup.h@{Markup.h}}
\subsubsection[MCD\_\-PCSZ]{\setlength{\rightskip}{0pt plus 5cm}\#define MCD\_\-PCSZ~const char$\ast$}\label{Markup_8h_edde484976c7ebb2e31d6be23e669128}
\index{Markup.h@{Markup.h}!MCD\_\-PCSZ\_\-FILENAME@{MCD\_\-PCSZ\_\-FILENAME}}
\index{MCD\_\-PCSZ\_\-FILENAME@{MCD\_\-PCSZ\_\-FILENAME}!Markup.h@{Markup.h}}
\subsubsection[MCD\_\-PCSZ\_\-FILENAME]{\setlength{\rightskip}{0pt plus 5cm}\#define MCD\_\-PCSZ\_\-FILENAME~MCD\_\-PCSZ}\label{Markup_8h_7dbef2772d51e540f1dfc521c1fa5866}
\index{Markup.h@{Markup.h}!MCD\_\-PSZCAT@{MCD\_\-PSZCAT}}
\index{MCD\_\-PSZCAT@{MCD\_\-PSZCAT}!Markup.h@{Markup.h}}
\subsubsection[MCD\_\-PSZCAT]{\setlength{\rightskip}{0pt plus 5cm}\#define MCD\_\-PSZCAT~strcat}\label{Markup_8h_1f111b6472a97a8308f47a42a5ca02c0}
\index{Markup.h@{Markup.h}!MCD\_\-PSZCHR@{MCD\_\-PSZCHR}}
\index{MCD\_\-PSZCHR@{MCD\_\-PSZCHR}!Markup.h@{Markup.h}}
\subsubsection[MCD\_\-PSZCHR]{\setlength{\rightskip}{0pt plus 5cm}\#define MCD\_\-PSZCHR~strchr}\label{Markup_8h_0b4f312ed85cdcdafc5ed8c88da98ce9}
Referenced by CMarkup::TokenPos::Match().\index{Markup.h@{Markup.h}!MCD\_\-PSZCPY@{MCD\_\-PSZCPY}}
\index{MCD\_\-PSZCPY@{MCD\_\-PSZCPY}!Markup.h@{Markup.h}}
\subsubsection[MCD\_\-PSZCPY]{\setlength{\rightskip}{0pt plus 5cm}\#define MCD\_\-PSZCPY~strcpy}\label{Markup_8h_ff4771eb9cee750223aa117b8cafdab6}
\index{Markup.h@{Markup.h}!MCD\_\-PSZLEN@{MCD\_\-PSZLEN}}
\index{MCD\_\-PSZLEN@{MCD\_\-PSZLEN}!Markup.h@{Markup.h}}
\subsubsection[MCD\_\-PSZLEN]{\setlength{\rightskip}{0pt plus 5cm}\#define MCD\_\-PSZLEN~(int)strlen}\label{Markup_8h_f8601b14e21b7fe9a4b55953ddbb75c2}
\index{Markup.h@{Markup.h}!MCD\_\-PSZNCMP@{MCD\_\-PSZNCMP}}
\index{MCD\_\-PSZNCMP@{MCD\_\-PSZNCMP}!Markup.h@{Markup.h}}
\subsubsection[MCD\_\-PSZNCMP]{\setlength{\rightskip}{0pt plus 5cm}\#define MCD\_\-PSZNCMP~strncmp}\label{Markup_8h_4e2907b0d2098130db8cffd774afef88}
Referenced by CMarkup::TokenPos::Match().\index{Markup.h@{Markup.h}!MCD\_\-PSZNCPY@{MCD\_\-PSZNCPY}}
\index{MCD\_\-PSZNCPY@{MCD\_\-PSZNCPY}!Markup.h@{Markup.h}}
\subsubsection[MCD\_\-PSZNCPY]{\setlength{\rightskip}{0pt plus 5cm}\#define MCD\_\-PSZNCPY~strncpy}\label{Markup_8h_6abfcd289e88bf2cd4a7e26abf231551}
\index{Markup.h@{Markup.h}!MCD\_\-PSZSTR@{MCD\_\-PSZSTR}}
\index{MCD\_\-PSZSTR@{MCD\_\-PSZSTR}!Markup.h@{Markup.h}}
\subsubsection[MCD\_\-PSZSTR]{\setlength{\rightskip}{0pt plus 5cm}\#define MCD\_\-PSZSTR~strstr}\label{Markup_8h_d63af44417f9dcdb5ee845a08cbd19d2}
\index{Markup.h@{Markup.h}!MCD\_\-PSZTOL@{MCD\_\-PSZTOL}}
\index{MCD\_\-PSZTOL@{MCD\_\-PSZTOL}!Markup.h@{Markup.h}}
\subsubsection[MCD\_\-PSZTOL]{\setlength{\rightskip}{0pt plus 5cm}\#define MCD\_\-PSZTOL~strtol}\label{Markup_8h_0f9f184175207bff11e204540c56b473}
\index{Markup.h@{Markup.h}!MCD\_\-RELEASEBUFFER@{MCD\_\-RELEASEBUFFER}}
\index{MCD\_\-RELEASEBUFFER@{MCD\_\-RELEASEBUFFER}!Markup.h@{Markup.h}}
\subsubsection[MCD\_\-RELEASEBUFFER]{\setlength{\rightskip}{0pt plus 5cm}\#define MCD\_\-RELEASEBUFFER(s, \/ p, \/ n)~s.assign(p,n); delete[$\,$]p}\label{Markup_8h_c7aebf04b6e902c953c2422b65cde140}
\index{Markup.h@{Markup.h}!MCD\_\-SPRINTF@{MCD\_\-SPRINTF}}
\index{MCD\_\-SPRINTF@{MCD\_\-SPRINTF}!Markup.h@{Markup.h}}
\subsubsection[MCD\_\-SPRINTF]{\setlength{\rightskip}{0pt plus 5cm}\#define MCD\_\-SPRINTF~sprintf}\label{Markup_8h_fdebb4fe97791f466e9e52337e36e707}
Referenced by CMarkup::x\_\-IntToStr().\index{Markup.h@{Markup.h}!MCD\_\-SSZ@{MCD\_\-SSZ}}
\index{MCD\_\-SSZ@{MCD\_\-SSZ}!Markup.h@{Markup.h}}
\subsubsection[MCD\_\-SSZ]{\setlength{\rightskip}{0pt plus 5cm}\#define MCD\_\-SSZ(sz)~sz}\label{Markup_8h_c327a6af700343d0cced4ed2bf855460}
Referenced by CMarkup::x\_\-IntToStr().\index{Markup.h@{Markup.h}!MCD\_\-STR@{MCD\_\-STR}}
\index{MCD\_\-STR@{MCD\_\-STR}!Markup.h@{Markup.h}}
\subsubsection[MCD\_\-STR]{\setlength{\rightskip}{0pt plus 5cm}\#define MCD\_\-STR~std::string}\label{Markup_8h_1b37b66197558752f7dfcdb82011648b}
Referenced by CMarkup::x\_\-IntToStr().\index{Markup.h@{Markup.h}!MCD\_\-STRASSIGN@{MCD\_\-STRASSIGN}}
\index{MCD\_\-STRASSIGN@{MCD\_\-STRASSIGN}!Markup.h@{Markup.h}}
\subsubsection[MCD\_\-STRASSIGN]{\setlength{\rightskip}{0pt plus 5cm}\#define MCD\_\-STRASSIGN(s, \/ p, \/ n)~s.assign(p,n)}\label{Markup_8h_25a39e06935325797827ef910d1e9c33}
\index{Markup.h@{Markup.h}!MCD\_\-STRCAPACITY@{MCD\_\-STRCAPACITY}}
\index{MCD\_\-STRCAPACITY@{MCD\_\-STRCAPACITY}!Markup.h@{Markup.h}}
\subsubsection[MCD\_\-STRCAPACITY]{\setlength{\rightskip}{0pt plus 5cm}\#define MCD\_\-STRCAPACITY(s)~(int)s.capacity()}\label{Markup_8h_86a80a1134afea2893d7f10fe7a94656}
\index{Markup.h@{Markup.h}!MCD\_\-STRCLEAR@{MCD\_\-STRCLEAR}}
\index{MCD\_\-STRCLEAR@{MCD\_\-STRCLEAR}!Markup.h@{Markup.h}}
\subsubsection[MCD\_\-STRCLEAR]{\setlength{\rightskip}{0pt plus 5cm}\#define MCD\_\-STRCLEAR(s)~s.erase()}\label{Markup_8h_f26261378df965f267408dad0fc32731}
\index{Markup.h@{Markup.h}!MCD\_\-STRERROR@{MCD\_\-STRERROR}}
\index{MCD\_\-STRERROR@{MCD\_\-STRERROR}!Markup.h@{Markup.h}}
\subsubsection[MCD\_\-STRERROR]{\setlength{\rightskip}{0pt plus 5cm}\#define MCD\_\-STRERROR~strerror(errno)}\label{Markup_8h_1930dded538d6aeb11899a588cbe0694}
\index{Markup.h@{Markup.h}!MCD\_\-STRINSERTREPLACE@{MCD\_\-STRINSERTREPLACE}}
\index{MCD\_\-STRINSERTREPLACE@{MCD\_\-STRINSERTREPLACE}!Markup.h@{Markup.h}}
\subsubsection[MCD\_\-STRINSERTREPLACE]{\setlength{\rightskip}{0pt plus 5cm}\#define MCD\_\-STRINSERTREPLACE(d, \/ i, \/ r, \/ s)~d.replace(i,r,s)}\label{Markup_8h_e858b63711717ae98a1ef06b8c992c46}
\index{Markup.h@{Markup.h}!MCD\_\-STRISEMPTY@{MCD\_\-STRISEMPTY}}
\index{MCD\_\-STRISEMPTY@{MCD\_\-STRISEMPTY}!Markup.h@{Markup.h}}
\subsubsection[MCD\_\-STRISEMPTY]{\setlength{\rightskip}{0pt plus 5cm}\#define MCD\_\-STRISEMPTY(s)~s.empty()}\label{Markup_8h_2790455cead9f63ecdd40f3a1391fdb4}
\index{Markup.h@{Markup.h}!MCD\_\-STRLENGTH@{MCD\_\-STRLENGTH}}
\index{MCD\_\-STRLENGTH@{MCD\_\-STRLENGTH}!Markup.h@{Markup.h}}
\subsubsection[MCD\_\-STRLENGTH]{\setlength{\rightskip}{0pt plus 5cm}\#define MCD\_\-STRLENGTH(s)~(int)s.size()}\label{Markup_8h_0cf539be69b737a377b5ba5080febc17}
\index{Markup.h@{Markup.h}!MCD\_\-STRMID@{MCD\_\-STRMID}}
\index{MCD\_\-STRMID@{MCD\_\-STRMID}!Markup.h@{Markup.h}}
\subsubsection[MCD\_\-STRMID]{\setlength{\rightskip}{0pt plus 5cm}\#define MCD\_\-STRMID(s, \/ n, \/ l)~s.substr(n,l)}\label{Markup_8h_9ac43f7dfd3f9b4a40fa2975a4289037}
\index{Markup.h@{Markup.h}!MCD\_\-STRTOINT@{MCD\_\-STRTOINT}}
\index{MCD\_\-STRTOINT@{MCD\_\-STRTOINT}!Markup.h@{Markup.h}}
\subsubsection[MCD\_\-STRTOINT]{\setlength{\rightskip}{0pt plus 5cm}\#define MCD\_\-STRTOINT(s)~MCD\_\-PSZTOL(MCD\_\-2PCSZ(s),NULL,10)}\label{Markup_8h_d943bd4174ba98a10524bc437d0c0d50}
\index{Markup.h@{Markup.h}!MCD\_\-T@{MCD\_\-T}}
\index{MCD\_\-T@{MCD\_\-T}!Markup.h@{Markup.h}}
\subsubsection[MCD\_\-T]{\setlength{\rightskip}{0pt plus 5cm}\#define MCD\_\-T(s)~s}\label{Markup_8h_3717b2fa88d73f5f346ec6efdfbe2032}
Referenced by CMarkup::TokenPos::Match(), and CMarkup::x\_\-IntToStr().\index{Markup.h@{Markup.h}!MCD\_\-T\_\-FILENAME@{MCD\_\-T\_\-FILENAME}}
\index{MCD\_\-T\_\-FILENAME@{MCD\_\-T\_\-FILENAME}!Markup.h@{Markup.h}}
\subsubsection[MCD\_\-T\_\-FILENAME]{\setlength{\rightskip}{0pt plus 5cm}\#define MCD\_\-T\_\-FILENAME~MCD\_\-T}\label{Markup_8h_c5dd80c2be80f6331999ca42ba047aca}
\index{Markup.h@{Markup.h}!MCD\_\-UTF16@{MCD\_\-UTF16}}
\index{MCD\_\-UTF16@{MCD\_\-UTF16}!Markup.h@{Markup.h}}
\subsubsection[MCD\_\-UTF16]{\setlength{\rightskip}{0pt plus 5cm}\#define MCD\_\-UTF16~1200}\label{Markup_8h_d9263b419662458249b697e27f9af6ee}
\index{Markup.h@{Markup.h}!MCD\_\-UTF32@{MCD\_\-UTF32}}
\index{MCD\_\-UTF32@{MCD\_\-UTF32}!Markup.h@{Markup.h}}
\subsubsection[MCD\_\-UTF32]{\setlength{\rightskip}{0pt plus 5cm}\#define MCD\_\-UTF32~65005}\label{Markup_8h_534d77c158c8f18fd0b5f238f8715a31}
\index{Markup.h@{Markup.h}!MCD\_\-UTF8@{MCD\_\-UTF8}}
\index{MCD\_\-UTF8@{MCD\_\-UTF8}!Markup.h@{Markup.h}}
\subsubsection[MCD\_\-UTF8]{\setlength{\rightskip}{0pt plus 5cm}\#define MCD\_\-UTF8~65001}\label{Markup_8h_ee5e990ae605088df779ccb343b44e66}

22
doc/latex/annotated.tex Normal file
View file

@ -0,0 +1,22 @@
\section{Class List}
Here are the classes, structs, unions and interfaces with brief descriptions:\begin{CompactList}
\item\contentsline{section}{{\bf CMarkup} }{\pageref{classCMarkup}}{}
\item\contentsline{section}{{\bf CMarkup::ConvertEncoding} }{\pageref{structCMarkup_1_1ConvertEncoding}}{}
\item\contentsline{section}{{\bf CMarkup::ElemPos} }{\pageref{structCMarkup_1_1ElemPos}}{}
\item\contentsline{section}{{\bf CMarkup::FilePos} }{\pageref{structCMarkup_1_1FilePos}}{}
\item\contentsline{section}{{\bf CMarkup::NodePos} }{\pageref{structCMarkup_1_1NodePos}}{}
\item\contentsline{section}{{\bf CMarkup::NodeStack} }{\pageref{structCMarkup_1_1NodeStack}}{}
\item\contentsline{section}{{\bf CMarkup::PosArray} }{\pageref{structCMarkup_1_1PosArray}}{}
\item\contentsline{section}{{\bf CMarkup::SavedPos} }{\pageref{structCMarkup_1_1SavedPos}}{}
\item\contentsline{section}{{\bf CMarkup::SavedPosMap} }{\pageref{structCMarkup_1_1SavedPosMap}}{}
\item\contentsline{section}{{\bf CMarkup::SavedPosMapArray} }{\pageref{structCMarkup_1_1SavedPosMapArray}}{}
\item\contentsline{section}{{\bf CMarkup::TokenPos} }{\pageref{structCMarkup_1_1TokenPos}}{}
\item\contentsline{section}{{\bf neuralpp::Layer} (Class for managing layers of neurons )}{\pageref{classneuralpp_1_1Layer}}{}
\item\contentsline{section}{{\bf MCD\_\-CSTR} }{\pageref{structMCD__CSTR}}{}
\item\contentsline{section}{{\bf neuralpp::netrecord} }{\pageref{structneuralpp_1_1netrecord}}{}
\item\contentsline{section}{{\bf neuralpp::NeuralNet} (Main project's class )}{\pageref{classneuralpp_1_1NeuralNet}}{}
\item\contentsline{section}{{\bf neuralpp::Neuron} (Class for managing neurons )}{\pageref{classneuralpp_1_1Neuron}}{}
\item\contentsline{section}{{\bf neuralpp::neuronrecord} }{\pageref{structneuralpp_1_1neuronrecord}}{}
\item\contentsline{section}{{\bf neuralpp::Synapsis} (Class for managing synapsis )}{\pageref{classneuralpp_1_1Synapsis}}{}
\item\contentsline{section}{{\bf neuralpp::synrecord} }{\pageref{structneuralpp_1_1synrecord}}{}
\end{CompactList}

1427
doc/latex/classCMarkup.tex Normal file

File diff suppressed because it is too large Load diff

View file

@ -0,0 +1,164 @@
\section{neuralpp::Layer Class Reference}
\label{classneuralpp_1_1Layer}\index{neuralpp::Layer@{neuralpp::Layer}}
Class for managing layers of neurons.
{\tt \#include $<$neural++.hpp$>$}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item
{\bf Layer} (size\_\-t sz, double($\ast$a)(double), double($\ast$d)(double))
\begin{CompactList}\small\item\em Constructor. \item\end{CompactList}\item
{\bf Layer} (vector$<$ {\bf Neuron} $>$ \&neurons, double($\ast$a)(double), double($\ast$d)(double))
\begin{CompactList}\small\item\em Alternative constructor. \item\end{CompactList}\item
{\bf Neuron} \& {\bf operator[$\,$]} (size\_\-t i)
\begin{CompactList}\small\item\em Redefinition for operator []. \item\end{CompactList}\item
void {\bf link} ({\bf Layer} \&l)
\begin{CompactList}\small\item\em It links a layer to another. \item\end{CompactList}\item
void {\bf setProp} (vector$<$ double $>$ \&v)
\begin{CompactList}\small\item\em It sets a vector of propagation values to all its neurons. \item\end{CompactList}\item
void {\bf setActv} (vector$<$ double $>$ \&v)
\begin{CompactList}\small\item\em It sets a vector of activation values to all its neurons. \item\end{CompactList}\item
void {\bf propagate} ()
\begin{CompactList}\small\item\em It propagates its activation values to the output layers. \item\end{CompactList}\item
size\_\-t {\bf size} ()
\end{CompactItemize}
\subsection*{Private Attributes}
\begin{CompactItemize}
\item
vector$<$ {\bf Neuron} $>$ {\bf elements}
\item
void($\ast$ {\bf update\_\-weights} )()
\item
double($\ast$ {\bf actv\_\-f} )(double)
\item
double($\ast$ {\bf deriv} )(double)
\end{CompactItemize}
\subsection{Detailed Description}
Class for managing layers of neurons.
Don't use this class directly unless you know what you're doing, use \doxyref{NeuralNet}{p.}{classneuralpp_1_1NeuralNet} instead
\subsection{Constructor \& Destructor Documentation}
\index{neuralpp::Layer@{neuralpp::Layer}!Layer@{Layer}}
\index{Layer@{Layer}!neuralpp::Layer@{neuralpp::Layer}}
\subsubsection[Layer]{\setlength{\rightskip}{0pt plus 5cm}neuralpp::Layer::Layer (size\_\-t {\em sz}, \/ double($\ast$)(double) {\em a}, \/ double($\ast$)(double) {\em d})}\label{classneuralpp_1_1Layer_411a4dc8a1bb2fe44fe7a69fa50fd764}
Constructor.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em sz}]Size of the layer \item[{\em a}]Activation function \item[{\em d}]Its derivate \end{description}
\end{Desc}
\index{neuralpp::Layer@{neuralpp::Layer}!Layer@{Layer}}
\index{Layer@{Layer}!neuralpp::Layer@{neuralpp::Layer}}
\subsubsection[Layer]{\setlength{\rightskip}{0pt plus 5cm}neuralpp::Layer::Layer (vector$<$ {\bf Neuron} $>$ \& {\em neurons}, \/ double($\ast$)(double) {\em a}, \/ double($\ast$)(double) {\em d})}\label{classneuralpp_1_1Layer_117d1c3b481641816e80ea36826d2107}
Alternative constructor.
It directly gets a vector of neurons to build the layer \begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em neurons}]Vector of neurons to be included in the layer \item[{\em a}]Activation function \item[{\em d}]Its derivate \end{description}
\end{Desc}
\subsection{Member Function Documentation}
\index{neuralpp::Layer@{neuralpp::Layer}!operator[]@{operator[]}}
\index{operator[]@{operator[]}!neuralpp::Layer@{neuralpp::Layer}}
\subsubsection[operator[]]{\setlength{\rightskip}{0pt plus 5cm}{\bf Neuron}\& neuralpp::Layer::operator[$\,$] (size\_\-t {\em i})}\label{classneuralpp_1_1Layer_45ff7554830558155c6fbce3b6827122}
Redefinition for operator [].
It gets the neuron at {\em i\/} \begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em i}]Index of the neuron to get in the layer \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]Reference to the i-th neuron \end{Desc}
\index{neuralpp::Layer@{neuralpp::Layer}!link@{link}}
\index{link@{link}!neuralpp::Layer@{neuralpp::Layer}}
\subsubsection[link]{\setlength{\rightskip}{0pt plus 5cm}void neuralpp::Layer::link ({\bf Layer} \& {\em l})}\label{classneuralpp_1_1Layer_ac33444fde14633fa1ad4acb024ad150}
It links a layer to another.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em l}]\doxyref{Layer}{p.}{classneuralpp_1_1Layer} to connect to the current as input layer \end{description}
\end{Desc}
\index{neuralpp::Layer@{neuralpp::Layer}!setProp@{setProp}}
\index{setProp@{setProp}!neuralpp::Layer@{neuralpp::Layer}}
\subsubsection[setProp]{\setlength{\rightskip}{0pt plus 5cm}void neuralpp::Layer::setProp (vector$<$ double $>$ \& {\em v})}\label{classneuralpp_1_1Layer_dbad95f635343a2998794113d7762cf7}
It sets a vector of propagation values to all its neurons.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em v}]Vector of values to write as propagation values \end{description}
\end{Desc}
\index{neuralpp::Layer@{neuralpp::Layer}!setActv@{setActv}}
\index{setActv@{setActv}!neuralpp::Layer@{neuralpp::Layer}}
\subsubsection[setActv]{\setlength{\rightskip}{0pt plus 5cm}void neuralpp::Layer::setActv (vector$<$ double $>$ \& {\em v})}\label{classneuralpp_1_1Layer_98f79281b680b1d18fd91fa5794c0899}
It sets a vector of activation values to all its neurons.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em v}]Vector of values to write as activation values \end{description}
\end{Desc}
\index{neuralpp::Layer@{neuralpp::Layer}!propagate@{propagate}}
\index{propagate@{propagate}!neuralpp::Layer@{neuralpp::Layer}}
\subsubsection[propagate]{\setlength{\rightskip}{0pt plus 5cm}void neuralpp::Layer::propagate ()}\label{classneuralpp_1_1Layer_fcfd306039dbaf91c9e2dcc8fc1f1ce1}
It propagates its activation values to the output layers.
\index{neuralpp::Layer@{neuralpp::Layer}!size@{size}}
\index{size@{size}!neuralpp::Layer@{neuralpp::Layer}}
\subsubsection[size]{\setlength{\rightskip}{0pt plus 5cm}size\_\-t neuralpp::Layer::size ()}\label{classneuralpp_1_1Layer_c8d2f7513e5d40518f9dddfd1e3ddcc5}
\begin{Desc}
\item[Returns:]Number of neurons in the layer \end{Desc}
\subsection{Member Data Documentation}
\index{neuralpp::Layer@{neuralpp::Layer}!elements@{elements}}
\index{elements@{elements}!neuralpp::Layer@{neuralpp::Layer}}
\subsubsection[elements]{\setlength{\rightskip}{0pt plus 5cm}vector$<${\bf Neuron}$>$ {\bf neuralpp::Layer::elements}\hspace{0.3cm}{\tt [private]}}\label{classneuralpp_1_1Layer_855685c9da56b06b629e13a2f8c719ce}
\index{neuralpp::Layer@{neuralpp::Layer}!update\_\-weights@{update\_\-weights}}
\index{update\_\-weights@{update\_\-weights}!neuralpp::Layer@{neuralpp::Layer}}
\subsubsection[update\_\-weights]{\setlength{\rightskip}{0pt plus 5cm}void($\ast$ {\bf neuralpp::Layer::update\_\-weights})()\hspace{0.3cm}{\tt [private]}}\label{classneuralpp_1_1Layer_c023a15a16353d0b4f44060a159f550f}
\index{neuralpp::Layer@{neuralpp::Layer}!actv\_\-f@{actv\_\-f}}
\index{actv\_\-f@{actv\_\-f}!neuralpp::Layer@{neuralpp::Layer}}
\subsubsection[actv\_\-f]{\setlength{\rightskip}{0pt plus 5cm}double($\ast$ {\bf neuralpp::Layer::actv\_\-f})(double)\hspace{0.3cm}{\tt [private]}}\label{classneuralpp_1_1Layer_824367da29f92253a027a7c5b4a4405e}
\index{neuralpp::Layer@{neuralpp::Layer}!deriv@{deriv}}
\index{deriv@{deriv}!neuralpp::Layer@{neuralpp::Layer}}
\subsubsection[deriv]{\setlength{\rightskip}{0pt plus 5cm}double($\ast$ {\bf neuralpp::Layer::deriv})(double)\hspace{0.3cm}{\tt [private]}}\label{classneuralpp_1_1Layer_a0207b14ba80aaf03502749ecb7d23fa}
The documentation for this class was generated from the following file:\begin{CompactItemize}
\item
{\bf neural++.hpp}\end{CompactItemize}

View file

@ -0,0 +1,408 @@
\section{neuralpp::NeuralNet Class Reference}
\label{classneuralpp_1_1NeuralNet}\index{neuralpp::NeuralNet@{neuralpp::NeuralNet}}
Main project's class.
{\tt \#include $<$neural++.hpp$>$}
\subsection*{Public Types}
\begin{CompactItemize}
\item
enum {\bf source} \{ {\bf file},
{\bf str}
\}
\begin{CompactList}\small\item\em Enum to choose the eventual training source for our network (XML from a file or from a string). \item\end{CompactList}\end{CompactItemize}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item
{\bf NeuralNet} ()
\begin{CompactList}\small\item\em Empty constructor for the class - it just makes nothing. \item\end{CompactList}\item
{\bf NeuralNet} (size\_\-t in\_\-size, size\_\-t hidden\_\-size, size\_\-t out\_\-size, double l, int e)
\begin{CompactList}\small\item\em Constructor. \item\end{CompactList}\item
{\bf NeuralNet} (const char $\ast$file) throw (NetworkFileNotFoundException)
\begin{CompactList}\small\item\em Constructor. \item\end{CompactList}\item
{\bf NeuralNet} (size\_\-t in\_\-size, size\_\-t hidden\_\-size, size\_\-t out\_\-size, double($\ast$actv)(double), double($\ast${\bf deriv})(double), double l, int e)
\begin{CompactList}\small\item\em Constructor. \item\end{CompactList}\item
double {\bf getOutput} ()
\begin{CompactList}\small\item\em It gets the output of the network (note: the layer output should contain an only neuron). \item\end{CompactList}\item
vector$<$ double $>$ {\bf getOutputs} ()
\begin{CompactList}\small\item\em It gets the output of the network in case the output layer contains more neurons. \item\end{CompactList}\item
double {\bf expected} ()
\begin{CompactList}\small\item\em It gets the value expected. \item\end{CompactList}\item
void {\bf setExpected} (double {\bf ex})
\begin{CompactList}\small\item\em It sets the value you expect from your network. \item\end{CompactList}\item
void {\bf update} ()
\begin{CompactList}\small\item\em It updates through back-propagation the weights of the synapsis and computes again the output value for {\em epochs\/} times, calling back updateWeights and commitChanges functions. \item\end{CompactList}\item
void {\bf propagate} ()
\begin{CompactList}\small\item\em It propagates values through the network. \item\end{CompactList}\item
void {\bf setInput} (vector$<$ double $>$ \&v)
\begin{CompactList}\small\item\em It sets the input for the network. \item\end{CompactList}\item
void {\bf link} ()
\begin{CompactList}\small\item\em It links the layers of the network (input, hidden, output). \item\end{CompactList}\item
bool {\bf save} (const char $\ast$fname)
\begin{CompactList}\small\item\em Save a trained neural network to a binary file. \item\end{CompactList}\item
void {\bf train} (string xml, {\bf source} xrc) throw (InvalidXMLException)
\begin{CompactList}\small\item\em Train a network using a training set loaded from an XML file. \item\end{CompactList}\end{CompactItemize}
\subsection*{Static Public Member Functions}
\begin{CompactItemize}
\item
static void {\bf initXML} (string \&xml)
\begin{CompactList}\small\item\em Initialize the training XML for the neural network. \item\end{CompactList}\item
static vector$<$ double $>$ {\bf split} (char delim, string str)
\begin{CompactList}\small\item\em Splits a string into a vector of doubles, given a delimitator. \item\end{CompactList}\item
static string {\bf XMLFromSet} (int id, string set)
\begin{CompactList}\small\item\em Get a training set from a string and copies it to an XML For example, these strings could be training sets for making sums: \char`\"{}2,3;5\char`\"{} - \char`\"{}5,6;11\char`\"{} - \char`\"{}2,2;4\char`\"{} - \char`\"{}4,5:9\char`\"{} This method called on the first string will return an XML such this: '$<$training id=\char`\"{}0\char`\"{}$>$$<$input id=\char`\"{}0\char`\"{}$>$2$<$/input$>$$<$input id=\char`\"{}1\char`\"{}$>$3$<$/input$>$$<$output id=\char`\"{}0\char`\"{}$>$5$<$/output$>$ \&lt/training$>$'. \item\end{CompactList}\item
static void {\bf closeXML} (string \&xml)
\begin{CompactList}\small\item\em Closes an open XML document generated by \char`\"{}initXML\char`\"{} and \char`\"{}XMLFromSet\char`\"{}. \item\end{CompactList}\end{CompactItemize}
\subsection*{Private Member Functions}
\begin{CompactItemize}
\item
void {\bf updateWeights} ()
\begin{CompactList}\small\item\em It updates the weights of the net's synapsis through back-propagation. \item\end{CompactList}\item
void {\bf commitChanges} ({\bf Layer} $\ast$l)
\begin{CompactList}\small\item\em It commits the changes made by \doxyref{updateWeights()}{p.}{classneuralpp_1_1NeuralNet_94169c89a7cd47122ab5dbf1d5c5e108} to the layer l. \item\end{CompactList}\item
double {\bf error} (double {\bf ex})
\begin{CompactList}\small\item\em It get the error made on the expected result as $|$v-v'$|$/v. \item\end{CompactList}\end{CompactItemize}
\subsection*{Private Attributes}
\begin{CompactItemize}
\item
int {\bf epochs}
\item
int {\bf ref\_\-epochs}
\item
double {\bf l\_\-rate}
\item
double {\bf ex}
\item
{\bf Layer} $\ast$ {\bf input}
\item
{\bf Layer} $\ast$ {\bf hidden}
\item
{\bf Layer} $\ast$ {\bf output}
\item
double($\ast$ {\bf actv\_\-f} )(double)
\begin{CompactList}\small\item\em Private pointer to function, containing the function to be used as activation function. \item\end{CompactList}\item
double($\ast$ {\bf deriv} )(double)
\begin{CompactList}\small\item\em Private pointer to function, containing the function to be used as derivate of the activation function. \item\end{CompactList}\end{CompactItemize}
\subsection{Detailed Description}
Main project's class.
Use $\ast$ONLY$\ast$ this class, unless you know what you're doing
\subsection{Member Enumeration Documentation}
\index{neuralpp::NeuralNet@{neuralpp::NeuralNet}!source@{source}}
\index{source@{source}!neuralpp::NeuralNet@{neuralpp::NeuralNet}}
\subsubsection[source]{\setlength{\rightskip}{0pt plus 5cm}enum {\bf neuralpp::NeuralNet::source}}\label{classneuralpp_1_1NeuralNet_94c36c94060e785ea67a0014c4182f8f}
Enum to choose the eventual training source for our network (XML from a file or from a string).
\begin{Desc}
\item[Enumerator: ]\par
\begin{description}
\index{file@{file}!neuralpp::NeuralNet@{neuralpp::NeuralNet}}\index{neuralpp::NeuralNet@{neuralpp::NeuralNet}!file@{file}}\item[{\em
file\label{classneuralpp_1_1NeuralNet_94c36c94060e785ea67a0014c4182f8f5ec2727c0756ddb097b53efe49b81afb}
}]\index{str@{str}!neuralpp::NeuralNet@{neuralpp::NeuralNet}}\index{neuralpp::NeuralNet@{neuralpp::NeuralNet}!str@{str}}\item[{\em
str\label{classneuralpp_1_1NeuralNet_94c36c94060e785ea67a0014c4182f8f6d06b4fe9414a158c97aee1a3679a904}
}]\end{description}
\end{Desc}
\subsection{Constructor \& Destructor Documentation}
\index{neuralpp::NeuralNet@{neuralpp::NeuralNet}!NeuralNet@{NeuralNet}}
\index{NeuralNet@{NeuralNet}!neuralpp::NeuralNet@{neuralpp::NeuralNet}}
\subsubsection[NeuralNet]{\setlength{\rightskip}{0pt plus 5cm}neuralpp::NeuralNet::NeuralNet ()\hspace{0.3cm}{\tt [inline]}}\label{classneuralpp_1_1NeuralNet_92b145f2f6f00bf1ba645ce2235882c2}
Empty constructor for the class - it just makes nothing.
\index{neuralpp::NeuralNet@{neuralpp::NeuralNet}!NeuralNet@{NeuralNet}}
\index{NeuralNet@{NeuralNet}!neuralpp::NeuralNet@{neuralpp::NeuralNet}}
\subsubsection[NeuralNet]{\setlength{\rightskip}{0pt plus 5cm}neuralpp::NeuralNet::NeuralNet (size\_\-t {\em in\_\-size}, \/ size\_\-t {\em hidden\_\-size}, \/ size\_\-t {\em out\_\-size}, \/ double {\em l}, \/ int {\em e})}\label{classneuralpp_1_1NeuralNet_c79534c7c0dfb20d1d03be2ad7569b78}
Constructor.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em in\_\-size}]Size of the input layer \item[{\em hidden\_\-size}]Size of the hidden layer \item[{\em out\_\-size}]Size of the output layer \item[{\em l}]learn rate (get it after doing some experiments, but generally try to keep its value quite low to be more accurate) \item[{\em e}]Epochs (cycles) to execute (the most you execute, the most the network can be accurate for its purpose) \end{description}
\end{Desc}
\index{neuralpp::NeuralNet@{neuralpp::NeuralNet}!NeuralNet@{NeuralNet}}
\index{NeuralNet@{NeuralNet}!neuralpp::NeuralNet@{neuralpp::NeuralNet}}
\subsubsection[NeuralNet]{\setlength{\rightskip}{0pt plus 5cm}neuralpp::NeuralNet::NeuralNet (const char $\ast$ {\em file}) throw (NetworkFileNotFoundException)}\label{classneuralpp_1_1NeuralNet_88380cb002edcccf11b59f6d3f6c94c9}
Constructor.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em file}]Binary file containing a neural network previously saved by \doxyref{save()}{p.}{classneuralpp_1_1NeuralNet_5db8d6ba4785f732da6e642b4f8f11a0} method \end{description}
\end{Desc}
\begin{Desc}
\item[Exceptions:]
\begin{description}
\item[{\em NetworkFileNotFoundException}]\end{description}
\end{Desc}
\index{neuralpp::NeuralNet@{neuralpp::NeuralNet}!NeuralNet@{NeuralNet}}
\index{NeuralNet@{NeuralNet}!neuralpp::NeuralNet@{neuralpp::NeuralNet}}
\subsubsection[NeuralNet]{\setlength{\rightskip}{0pt plus 5cm}neuralpp::NeuralNet::NeuralNet (size\_\-t {\em in\_\-size}, \/ size\_\-t {\em hidden\_\-size}, \/ size\_\-t {\em out\_\-size}, \/ double($\ast$)(double) {\em actv}, \/ double($\ast$)(double) {\em deriv}, \/ double {\em l}, \/ int {\em e})}\label{classneuralpp_1_1NeuralNet_b4b261f7f7fa93c45855288fd66cfdca}
Constructor.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em in\_\-size}]Size of the input layer \item[{\em hidden\_\-size}]Size of the hidden layer \item[{\em out\_\-size}]Size of the output layer \item[{\em actv}]Activation function to use (default: f(x)=x) \item[{\em deriv}]Derivate for the activation function to use (default: f'(x)=1) \item[{\em l}]learn rate (get it after doing some experiments, but generally try to keep its value quite low to be more accurate) \item[{\em e}]Epochs (cycles) to execute (the most you execute, the most the network can be accurate for its purpose) \end{description}
\end{Desc}
\subsection{Member Function Documentation}
\index{neuralpp::NeuralNet@{neuralpp::NeuralNet}!updateWeights@{updateWeights}}
\index{updateWeights@{updateWeights}!neuralpp::NeuralNet@{neuralpp::NeuralNet}}
\subsubsection[updateWeights]{\setlength{\rightskip}{0pt plus 5cm}void neuralpp::NeuralNet::updateWeights ()\hspace{0.3cm}{\tt [private]}}\label{classneuralpp_1_1NeuralNet_94169c89a7cd47122ab5dbf1d5c5e108}
It updates the weights of the net's synapsis through back-propagation.
In-class use only \index{neuralpp::NeuralNet@{neuralpp::NeuralNet}!commitChanges@{commitChanges}}
\index{commitChanges@{commitChanges}!neuralpp::NeuralNet@{neuralpp::NeuralNet}}
\subsubsection[commitChanges]{\setlength{\rightskip}{0pt plus 5cm}void neuralpp::NeuralNet::commitChanges ({\bf Layer} $\ast$ {\em l})\hspace{0.3cm}{\tt [private]}}\label{classneuralpp_1_1NeuralNet_62695a82dfb1df758a44150921aec8e0}
It commits the changes made by \doxyref{updateWeights()}{p.}{classneuralpp_1_1NeuralNet_94169c89a7cd47122ab5dbf1d5c5e108} to the layer l.
In-class use only \begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em l}]\doxyref{Layer}{p.}{classneuralpp_1_1Layer} to commit the changes \end{description}
\end{Desc}
\index{neuralpp::NeuralNet@{neuralpp::NeuralNet}!error@{error}}
\index{error@{error}!neuralpp::NeuralNet@{neuralpp::NeuralNet}}
\subsubsection[error]{\setlength{\rightskip}{0pt plus 5cm}double neuralpp::NeuralNet::error (double {\em ex})\hspace{0.3cm}{\tt [private]}}\label{classneuralpp_1_1NeuralNet_8a140d28e6dd4097470c7c138801ad01}
It get the error made on the expected result as $|$v-v'$|$/v.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em ex}]Expected value \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]Mean error \end{Desc}
\index{neuralpp::NeuralNet@{neuralpp::NeuralNet}!getOutput@{getOutput}}
\index{getOutput@{getOutput}!neuralpp::NeuralNet@{neuralpp::NeuralNet}}
\subsubsection[getOutput]{\setlength{\rightskip}{0pt plus 5cm}double neuralpp::NeuralNet::getOutput ()}\label{classneuralpp_1_1NeuralNet_7de7ee318eeb791d21a01e9e9e0e8c5a}
It gets the output of the network (note: the layer output should contain an only neuron).
\begin{Desc}
\item[Returns:]The output value of the network \end{Desc}
\index{neuralpp::NeuralNet@{neuralpp::NeuralNet}!getOutputs@{getOutputs}}
\index{getOutputs@{getOutputs}!neuralpp::NeuralNet@{neuralpp::NeuralNet}}
\subsubsection[getOutputs]{\setlength{\rightskip}{0pt plus 5cm}vector$<$double$>$ neuralpp::NeuralNet::getOutputs ()}\label{classneuralpp_1_1NeuralNet_a6b8bf3800b43b58843c65fc431207ae}
It gets the output of the network in case the output layer contains more neurons.
\begin{Desc}
\item[Returns:]A vector containing the output values of the network \end{Desc}
\index{neuralpp::NeuralNet@{neuralpp::NeuralNet}!expected@{expected}}
\index{expected@{expected}!neuralpp::NeuralNet@{neuralpp::NeuralNet}}
\subsubsection[expected]{\setlength{\rightskip}{0pt plus 5cm}double neuralpp::NeuralNet::expected ()}\label{classneuralpp_1_1NeuralNet_423fd38a61d79905dcc12da84c805114}
It gets the value expected.
Of course you should specify this when you build your network by using setExpected. \begin{Desc}
\item[Returns:]The expected output value for a certain training phase \end{Desc}
\index{neuralpp::NeuralNet@{neuralpp::NeuralNet}!setExpected@{setExpected}}
\index{setExpected@{setExpected}!neuralpp::NeuralNet@{neuralpp::NeuralNet}}
\subsubsection[setExpected]{\setlength{\rightskip}{0pt plus 5cm}void neuralpp::NeuralNet::setExpected (double {\em ex})}\label{classneuralpp_1_1NeuralNet_b6475762b7e9eab086befdc511f7c236}
It sets the value you expect from your network.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em ex}]Expected output value \end{description}
\end{Desc}
\index{neuralpp::NeuralNet@{neuralpp::NeuralNet}!update@{update}}
\index{update@{update}!neuralpp::NeuralNet@{neuralpp::NeuralNet}}
\subsubsection[update]{\setlength{\rightskip}{0pt plus 5cm}void neuralpp::NeuralNet::update ()}\label{classneuralpp_1_1NeuralNet_b0bd1daadb06980dff1f50d33a7c098e}
It updates through back-propagation the weights of the synapsis and computes again the output value for {\em epochs\/} times, calling back updateWeights and commitChanges functions.
\index{neuralpp::NeuralNet@{neuralpp::NeuralNet}!propagate@{propagate}}
\index{propagate@{propagate}!neuralpp::NeuralNet@{neuralpp::NeuralNet}}
\subsubsection[propagate]{\setlength{\rightskip}{0pt plus 5cm}void neuralpp::NeuralNet::propagate ()}\label{classneuralpp_1_1NeuralNet_c129c180647362da963758bfd1ba6890}
It propagates values through the network.
Use this when you want to give an already trained network some new values the get to the output \index{neuralpp::NeuralNet@{neuralpp::NeuralNet}!setInput@{setInput}}
\index{setInput@{setInput}!neuralpp::NeuralNet@{neuralpp::NeuralNet}}
\subsubsection[setInput]{\setlength{\rightskip}{0pt plus 5cm}void neuralpp::NeuralNet::setInput (vector$<$ double $>$ \& {\em v})}\label{classneuralpp_1_1NeuralNet_0de170e8ab561ad63d0739b4c4b74f68}
It sets the input for the network.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em v}]Vector of doubles, containing the values to give to your network \end{description}
\end{Desc}
\index{neuralpp::NeuralNet@{neuralpp::NeuralNet}!link@{link}}
\index{link@{link}!neuralpp::NeuralNet@{neuralpp::NeuralNet}}
\subsubsection[link]{\setlength{\rightskip}{0pt plus 5cm}void neuralpp::NeuralNet::link ()}\label{classneuralpp_1_1NeuralNet_46f23f462318a4ffc037a4e806364c3f}
It links the layers of the network (input, hidden, output).
Don't use unless you exactly know what you're doing, it is already called by the constructor \index{neuralpp::NeuralNet@{neuralpp::NeuralNet}!save@{save}}
\index{save@{save}!neuralpp::NeuralNet@{neuralpp::NeuralNet}}
\subsubsection[save]{\setlength{\rightskip}{0pt plus 5cm}bool neuralpp::NeuralNet::save (const char $\ast$ {\em fname})}\label{classneuralpp_1_1NeuralNet_5db8d6ba4785f732da6e642b4f8f11a0}
Save a trained neural network to a binary file.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em fname}]Binary file where you're going to save your network \end{description}
\end{Desc}
\index{neuralpp::NeuralNet@{neuralpp::NeuralNet}!train@{train}}
\index{train@{train}!neuralpp::NeuralNet@{neuralpp::NeuralNet}}
\subsubsection[train]{\setlength{\rightskip}{0pt plus 5cm}void neuralpp::NeuralNet::train (string {\em xml}, \/ {\bf source} {\em xrc}) throw (InvalidXMLException)}\label{classneuralpp_1_1NeuralNet_e8b8741d28bec1354db555eabe418cb6}
Train a network using a training set loaded from an XML file.
A sample XML file is available in examples/adder.xml \begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em xml}]XML file containing our training set \item[{\em src}]Source type from which the XML will be loaded (from a file [default] or from a string) \end{description}
\end{Desc}
\begin{Desc}
\item[Exceptions:]
\begin{description}
\item[{\em InvalidXMLException}]\end{description}
\end{Desc}
\index{neuralpp::NeuralNet@{neuralpp::NeuralNet}!initXML@{initXML}}
\index{initXML@{initXML}!neuralpp::NeuralNet@{neuralpp::NeuralNet}}
\subsubsection[initXML]{\setlength{\rightskip}{0pt plus 5cm}static void neuralpp::NeuralNet::initXML (string \& {\em xml})\hspace{0.3cm}{\tt [static]}}\label{classneuralpp_1_1NeuralNet_45c7645d4affe65752d37cd230afba24}
Initialize the training XML for the neural network.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em xml}]String that will contain the XML \end{description}
\end{Desc}
\index{neuralpp::NeuralNet@{neuralpp::NeuralNet}!split@{split}}
\index{split@{split}!neuralpp::NeuralNet@{neuralpp::NeuralNet}}
\subsubsection[split]{\setlength{\rightskip}{0pt plus 5cm}static vector$<$double$>$ neuralpp::NeuralNet::split (char {\em delim}, \/ string {\em str})\hspace{0.3cm}{\tt [static]}}\label{classneuralpp_1_1NeuralNet_e07af23ceb8666518da0c035bf1e0376}
Splits a string into a vector of doubles, given a delimitator.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em delim}]Delimitator \item[{\em str}]String to be splitted \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]Vector of doubles containing splitted values \end{Desc}
\index{neuralpp::NeuralNet@{neuralpp::NeuralNet}!XMLFromSet@{XMLFromSet}}
\index{XMLFromSet@{XMLFromSet}!neuralpp::NeuralNet@{neuralpp::NeuralNet}}
\subsubsection[XMLFromSet]{\setlength{\rightskip}{0pt plus 5cm}static string neuralpp::NeuralNet::XMLFromSet (int {\em id}, \/ string {\em set})\hspace{0.3cm}{\tt [static]}}\label{classneuralpp_1_1NeuralNet_4be31ecb0b543a192997bd83c6995ccb}
Get a training set from a string and copies it to an XML For example, these strings could be training sets for making sums: \char`\"{}2,3;5\char`\"{} - \char`\"{}5,6;11\char`\"{} - \char`\"{}2,2;4\char`\"{} - \char`\"{}4,5:9\char`\"{} This method called on the first string will return an XML such this: '$<$training id=\char`\"{}0\char`\"{}$>$$<$input id=\char`\"{}0\char`\"{}$>$2$<$/input$>$$<$input id=\char`\"{}1\char`\"{}$>$3$<$/input$>$$<$output id=\char`\"{}0\char`\"{}$>$5$<$/output$>$ \&lt/training$>$'.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em id}]ID for the given training set (0,1,..,n) \item[{\em set}]String containing input values and expected outputs \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]XML string \end{Desc}
\index{neuralpp::NeuralNet@{neuralpp::NeuralNet}!closeXML@{closeXML}}
\index{closeXML@{closeXML}!neuralpp::NeuralNet@{neuralpp::NeuralNet}}
\subsubsection[closeXML]{\setlength{\rightskip}{0pt plus 5cm}static void neuralpp::NeuralNet::closeXML (string \& {\em xml})\hspace{0.3cm}{\tt [static]}}\label{classneuralpp_1_1NeuralNet_28b9966c5f197b8e86d57dd104aa32a6}
Closes an open XML document generated by \char`\"{}initXML\char`\"{} and \char`\"{}XMLFromSet\char`\"{}.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em xml}]XML string to be closed \end{description}
\end{Desc}
\subsection{Member Data Documentation}
\index{neuralpp::NeuralNet@{neuralpp::NeuralNet}!epochs@{epochs}}
\index{epochs@{epochs}!neuralpp::NeuralNet@{neuralpp::NeuralNet}}
\subsubsection[epochs]{\setlength{\rightskip}{0pt plus 5cm}int {\bf neuralpp::NeuralNet::epochs}\hspace{0.3cm}{\tt [private]}}\label{classneuralpp_1_1NeuralNet_4cb52dae7b43d03fac73afca7b9f3a51}
\index{neuralpp::NeuralNet@{neuralpp::NeuralNet}!ref\_\-epochs@{ref\_\-epochs}}
\index{ref\_\-epochs@{ref\_\-epochs}!neuralpp::NeuralNet@{neuralpp::NeuralNet}}
\subsubsection[ref\_\-epochs]{\setlength{\rightskip}{0pt plus 5cm}int {\bf neuralpp::NeuralNet::ref\_\-epochs}\hspace{0.3cm}{\tt [private]}}\label{classneuralpp_1_1NeuralNet_4f88106c9e542c39eac43b4ca1974a2a}
\index{neuralpp::NeuralNet@{neuralpp::NeuralNet}!l\_\-rate@{l\_\-rate}}
\index{l\_\-rate@{l\_\-rate}!neuralpp::NeuralNet@{neuralpp::NeuralNet}}
\subsubsection[l\_\-rate]{\setlength{\rightskip}{0pt plus 5cm}double {\bf neuralpp::NeuralNet::l\_\-rate}\hspace{0.3cm}{\tt [private]}}\label{classneuralpp_1_1NeuralNet_6bd7be443e46b2fdbf1da2edb8e611ab}
\index{neuralpp::NeuralNet@{neuralpp::NeuralNet}!ex@{ex}}
\index{ex@{ex}!neuralpp::NeuralNet@{neuralpp::NeuralNet}}
\subsubsection[ex]{\setlength{\rightskip}{0pt plus 5cm}double {\bf neuralpp::NeuralNet::ex}\hspace{0.3cm}{\tt [private]}}\label{classneuralpp_1_1NeuralNet_261f5f68fcc5be54250cfa03945266dd}
\index{neuralpp::NeuralNet@{neuralpp::NeuralNet}!input@{input}}
\index{input@{input}!neuralpp::NeuralNet@{neuralpp::NeuralNet}}
\subsubsection[input]{\setlength{\rightskip}{0pt plus 5cm}{\bf Layer}$\ast$ {\bf neuralpp::NeuralNet::input}\hspace{0.3cm}{\tt [private]}}\label{classneuralpp_1_1NeuralNet_e2b4e8405f9d25edab395d61502bdba9}
\index{neuralpp::NeuralNet@{neuralpp::NeuralNet}!hidden@{hidden}}
\index{hidden@{hidden}!neuralpp::NeuralNet@{neuralpp::NeuralNet}}
\subsubsection[hidden]{\setlength{\rightskip}{0pt plus 5cm}{\bf Layer}$\ast$ {\bf neuralpp::NeuralNet::hidden}\hspace{0.3cm}{\tt [private]}}\label{classneuralpp_1_1NeuralNet_bbdaa1b6c0a1a95d2b18cd25fda2a266}
\index{neuralpp::NeuralNet@{neuralpp::NeuralNet}!output@{output}}
\index{output@{output}!neuralpp::NeuralNet@{neuralpp::NeuralNet}}
\subsubsection[output]{\setlength{\rightskip}{0pt plus 5cm}{\bf Layer}$\ast$ {\bf neuralpp::NeuralNet::output}\hspace{0.3cm}{\tt [private]}}\label{classneuralpp_1_1NeuralNet_fa9b2dbcbb39d0fc70f790ac24069a74}
\index{neuralpp::NeuralNet@{neuralpp::NeuralNet}!actv\_\-f@{actv\_\-f}}
\index{actv\_\-f@{actv\_\-f}!neuralpp::NeuralNet@{neuralpp::NeuralNet}}
\subsubsection[actv\_\-f]{\setlength{\rightskip}{0pt plus 5cm}double($\ast$ {\bf neuralpp::NeuralNet::actv\_\-f})(double)\hspace{0.3cm}{\tt [private]}}\label{classneuralpp_1_1NeuralNet_c1469e6afd87d85b82f14bc246f82457}
Private pointer to function, containing the function to be used as activation function.
\index{neuralpp::NeuralNet@{neuralpp::NeuralNet}!deriv@{deriv}}
\index{deriv@{deriv}!neuralpp::NeuralNet@{neuralpp::NeuralNet}}
\subsubsection[deriv]{\setlength{\rightskip}{0pt plus 5cm}double($\ast$ {\bf neuralpp::NeuralNet::deriv})(double)\hspace{0.3cm}{\tt [private]}}\label{classneuralpp_1_1NeuralNet_df44689f4e6201ca1ddc67655cce3576}
Private pointer to function, containing the function to be used as derivate of the activation function.
The documentation for this class was generated from the following file:\begin{CompactItemize}
\item
{\bf neural++.hpp}\end{CompactItemize}

View file

@ -0,0 +1,252 @@
\section{neuralpp::Neuron Class Reference}
\label{classneuralpp_1_1Neuron}\index{neuralpp::Neuron@{neuralpp::Neuron}}
Class for managing neurons.
{\tt \#include $<$neural++.hpp$>$}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item
{\bf Neuron} (double($\ast$a)(double), double($\ast$d)(double))
\begin{CompactList}\small\item\em Constructor. \item\end{CompactList}\item
{\bf Neuron} (vector$<$ {\bf Synapsis} $>$ {\bf in}, vector$<$ {\bf Synapsis} $>$ {\bf out}, double($\ast$a)(double), double($\ast$d)(double))
\begin{CompactList}\small\item\em Alternative constructor, that gets also the synapsis linked to the neuron. \item\end{CompactList}\item
{\bf Synapsis} \& {\bf synIn} (size\_\-t i)
\begin{CompactList}\small\item\em Get the i-th synapsis connected on the input of the neuron. \item\end{CompactList}\item
{\bf Synapsis} \& {\bf synOut} (size\_\-t i)
\begin{CompactList}\small\item\em Get the i-th synapsis connected on the output of the neuron. \item\end{CompactList}\item
void {\bf push\_\-in} ({\bf Synapsis} \&s)
\begin{CompactList}\small\item\em It pushes a new input synapsis. \item\end{CompactList}\item
void {\bf push\_\-out} ({\bf Synapsis} \&s)
\begin{CompactList}\small\item\em It pushes a new output synapsis. \item\end{CompactList}\item
void {\bf setActv} (double a)
\begin{CompactList}\small\item\em Change the activation value of the neuron. \item\end{CompactList}\item
void {\bf setProp} (double p)
\begin{CompactList}\small\item\em Change the propagation value of the neuron. \item\end{CompactList}\item
double {\bf getActv} ()
\begin{CompactList}\small\item\em Get the activation value of the neuron. \item\end{CompactList}\item
double {\bf getProp} ()
\begin{CompactList}\small\item\em Get the propagation value of the neuron. \item\end{CompactList}\item
double {\bf propagate} ()
\begin{CompactList}\small\item\em It propagates its activation value to the connected neurons. \item\end{CompactList}\item
size\_\-t {\bf nIn} ()
\begin{CompactList}\small\item\em Get the number of input synapsis for the neuron. \item\end{CompactList}\item
size\_\-t {\bf nOut} ()
\begin{CompactList}\small\item\em Get the number of output synapsis for the neuron. \item\end{CompactList}\item
void {\bf synClear} ()
\begin{CompactList}\small\item\em Remove input and output synapsis from a neuron. \item\end{CompactList}\end{CompactItemize}
\subsection*{Private Attributes}
\begin{CompactItemize}
\item
double {\bf actv\_\-val}
\item
double {\bf prop\_\-val}
\item
vector$<$ {\bf Synapsis} $>$ {\bf in}
\item
vector$<$ {\bf Synapsis} $>$ {\bf out}
\item
double($\ast$ {\bf actv\_\-f} )(double)
\item
double($\ast$ {\bf deriv} )(double)
\end{CompactItemize}
\subsection{Detailed Description}
Class for managing neurons.
Don't use this class directly unless you know what you're doing, use \doxyref{NeuralNet}{p.}{classneuralpp_1_1NeuralNet} instead
\subsection{Constructor \& Destructor Documentation}
\index{neuralpp::Neuron@{neuralpp::Neuron}!Neuron@{Neuron}}
\index{Neuron@{Neuron}!neuralpp::Neuron@{neuralpp::Neuron}}
\subsubsection[Neuron]{\setlength{\rightskip}{0pt plus 5cm}neuralpp::Neuron::Neuron (double($\ast$)(double) {\em a}, \/ double($\ast$)(double) {\em d})}\label{classneuralpp_1_1Neuron_c877424a295478e3464046ea43c2a7ad}
Constructor.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em a}]Activation function \item[{\em d}]Its derivate \end{description}
\end{Desc}
\index{neuralpp::Neuron@{neuralpp::Neuron}!Neuron@{Neuron}}
\index{Neuron@{Neuron}!neuralpp::Neuron@{neuralpp::Neuron}}
\subsubsection[Neuron]{\setlength{\rightskip}{0pt plus 5cm}neuralpp::Neuron::Neuron (vector$<$ {\bf Synapsis} $>$ {\em in}, \/ vector$<$ {\bf Synapsis} $>$ {\em out}, \/ double($\ast$)(double) {\em a}, \/ double($\ast$)(double) {\em d})}\label{classneuralpp_1_1Neuron_e25546d4f7126f106c2f3b2d8ed2c792}
Alternative constructor, that gets also the synapsis linked to the neuron.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em in}]Input synapses \item[{\em out}]Output synapses \item[{\em a}]Activation function \item[{\em d}]Derivate of the activation function \end{description}
\end{Desc}
\subsection{Member Function Documentation}
\index{neuralpp::Neuron@{neuralpp::Neuron}!synIn@{synIn}}
\index{synIn@{synIn}!neuralpp::Neuron@{neuralpp::Neuron}}
\subsubsection[synIn]{\setlength{\rightskip}{0pt plus 5cm}{\bf Synapsis}\& neuralpp::Neuron::synIn (size\_\-t {\em i})}\label{classneuralpp_1_1Neuron_29f2d9dcc4ca34f224d4dc39bb2f180a}
Get the i-th synapsis connected on the input of the neuron.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em i}]Index of the input synapsis to get \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]Reference to the i-th synapsis \end{Desc}
\index{neuralpp::Neuron@{neuralpp::Neuron}!synOut@{synOut}}
\index{synOut@{synOut}!neuralpp::Neuron@{neuralpp::Neuron}}
\subsubsection[synOut]{\setlength{\rightskip}{0pt plus 5cm}{\bf Synapsis}\& neuralpp::Neuron::synOut (size\_\-t {\em i})}\label{classneuralpp_1_1Neuron_655f1637e1b754461413ac7fc2ffeebe}
Get the i-th synapsis connected on the output of the neuron.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em i}]Index of the output synapsis to get \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]Reference to the i-th synapsis \end{Desc}
\index{neuralpp::Neuron@{neuralpp::Neuron}!push\_\-in@{push\_\-in}}
\index{push\_\-in@{push\_\-in}!neuralpp::Neuron@{neuralpp::Neuron}}
\subsubsection[push\_\-in]{\setlength{\rightskip}{0pt plus 5cm}void neuralpp::Neuron::push\_\-in ({\bf Synapsis} \& {\em s})}\label{classneuralpp_1_1Neuron_583ada6e1dd3f2e113415b4d89196e62}
It pushes a new input synapsis.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em s}]\doxyref{Synapsis}{p.}{classneuralpp_1_1Synapsis} to be pushed \end{description}
\end{Desc}
\index{neuralpp::Neuron@{neuralpp::Neuron}!push\_\-out@{push\_\-out}}
\index{push\_\-out@{push\_\-out}!neuralpp::Neuron@{neuralpp::Neuron}}
\subsubsection[push\_\-out]{\setlength{\rightskip}{0pt plus 5cm}void neuralpp::Neuron::push\_\-out ({\bf Synapsis} \& {\em s})}\label{classneuralpp_1_1Neuron_bca65db84f56f9d40694bfbcd25812cb}
It pushes a new output synapsis.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em s}]\doxyref{Synapsis}{p.}{classneuralpp_1_1Synapsis} to be pushed \end{description}
\end{Desc}
\index{neuralpp::Neuron@{neuralpp::Neuron}!setActv@{setActv}}
\index{setActv@{setActv}!neuralpp::Neuron@{neuralpp::Neuron}}
\subsubsection[setActv]{\setlength{\rightskip}{0pt plus 5cm}void neuralpp::Neuron::setActv (double {\em a})}\label{classneuralpp_1_1Neuron_ddf00ffef030b27ed11901aad08822bd}
Change the activation value of the neuron.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em a}]Activation value \end{description}
\end{Desc}
\index{neuralpp::Neuron@{neuralpp::Neuron}!setProp@{setProp}}
\index{setProp@{setProp}!neuralpp::Neuron@{neuralpp::Neuron}}
\subsubsection[setProp]{\setlength{\rightskip}{0pt plus 5cm}void neuralpp::Neuron::setProp (double {\em p})}\label{classneuralpp_1_1Neuron_aa6e58f073a76b3481fea9115a4e6ea6}
Change the propagation value of the neuron.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em p}]Propagation value \end{description}
\end{Desc}
\index{neuralpp::Neuron@{neuralpp::Neuron}!getActv@{getActv}}
\index{getActv@{getActv}!neuralpp::Neuron@{neuralpp::Neuron}}
\subsubsection[getActv]{\setlength{\rightskip}{0pt plus 5cm}double neuralpp::Neuron::getActv ()}\label{classneuralpp_1_1Neuron_55993867179f0ac7d1e0e2c460ceb611}
Get the activation value of the neuron.
\begin{Desc}
\item[Returns:]Activation value for the neuron \end{Desc}
\index{neuralpp::Neuron@{neuralpp::Neuron}!getProp@{getProp}}
\index{getProp@{getProp}!neuralpp::Neuron@{neuralpp::Neuron}}
\subsubsection[getProp]{\setlength{\rightskip}{0pt plus 5cm}double neuralpp::Neuron::getProp ()}\label{classneuralpp_1_1Neuron_57c022f82213f662e2a263fc134a3fc9}
Get the propagation value of the neuron.
\begin{Desc}
\item[Returns:]Propagation value for the neuron \end{Desc}
\index{neuralpp::Neuron@{neuralpp::Neuron}!propagate@{propagate}}
\index{propagate@{propagate}!neuralpp::Neuron@{neuralpp::Neuron}}
\subsubsection[propagate]{\setlength{\rightskip}{0pt plus 5cm}double neuralpp::Neuron::propagate ()}\label{classneuralpp_1_1Neuron_8b0ca61cd0e047c8691ab39aae56dbda}
It propagates its activation value to the connected neurons.
\index{neuralpp::Neuron@{neuralpp::Neuron}!nIn@{nIn}}
\index{nIn@{nIn}!neuralpp::Neuron@{neuralpp::Neuron}}
\subsubsection[nIn]{\setlength{\rightskip}{0pt plus 5cm}size\_\-t neuralpp::Neuron::nIn ()}\label{classneuralpp_1_1Neuron_ad97f1a082d5f969eb4c69ab454ecfbb}
Get the number of input synapsis for the neuron.
\begin{Desc}
\item[Returns:]Number of input synapsis \end{Desc}
\index{neuralpp::Neuron@{neuralpp::Neuron}!nOut@{nOut}}
\index{nOut@{nOut}!neuralpp::Neuron@{neuralpp::Neuron}}
\subsubsection[nOut]{\setlength{\rightskip}{0pt plus 5cm}size\_\-t neuralpp::Neuron::nOut ()}\label{classneuralpp_1_1Neuron_fe458021e3b20d58dc608fb94ae2135b}
Get the number of output synapsis for the neuron.
\begin{Desc}
\item[Returns:]Number of output synapsis \end{Desc}
\index{neuralpp::Neuron@{neuralpp::Neuron}!synClear@{synClear}}
\index{synClear@{synClear}!neuralpp::Neuron@{neuralpp::Neuron}}
\subsubsection[synClear]{\setlength{\rightskip}{0pt plus 5cm}void neuralpp::Neuron::synClear ()}\label{classneuralpp_1_1Neuron_2e2ccb69277fc3d992a3a3f2360ed154}
Remove input and output synapsis from a neuron.
\subsection{Member Data Documentation}
\index{neuralpp::Neuron@{neuralpp::Neuron}!actv\_\-val@{actv\_\-val}}
\index{actv\_\-val@{actv\_\-val}!neuralpp::Neuron@{neuralpp::Neuron}}
\subsubsection[actv\_\-val]{\setlength{\rightskip}{0pt plus 5cm}double {\bf neuralpp::Neuron::actv\_\-val}\hspace{0.3cm}{\tt [private]}}\label{classneuralpp_1_1Neuron_eec680c47272b2465e8d8a998c359853}
\index{neuralpp::Neuron@{neuralpp::Neuron}!prop\_\-val@{prop\_\-val}}
\index{prop\_\-val@{prop\_\-val}!neuralpp::Neuron@{neuralpp::Neuron}}
\subsubsection[prop\_\-val]{\setlength{\rightskip}{0pt plus 5cm}double {\bf neuralpp::Neuron::prop\_\-val}\hspace{0.3cm}{\tt [private]}}\label{classneuralpp_1_1Neuron_da75259de98b1a893c736666af6bfdc3}
\index{neuralpp::Neuron@{neuralpp::Neuron}!in@{in}}
\index{in@{in}!neuralpp::Neuron@{neuralpp::Neuron}}
\subsubsection[in]{\setlength{\rightskip}{0pt plus 5cm}vector$<$ {\bf Synapsis} $>$ {\bf neuralpp::Neuron::in}\hspace{0.3cm}{\tt [private]}}\label{classneuralpp_1_1Neuron_ead827210fa18c2baae03927b2c798ff}
\index{neuralpp::Neuron@{neuralpp::Neuron}!out@{out}}
\index{out@{out}!neuralpp::Neuron@{neuralpp::Neuron}}
\subsubsection[out]{\setlength{\rightskip}{0pt plus 5cm}vector$<$ {\bf Synapsis} $>$ {\bf neuralpp::Neuron::out}\hspace{0.3cm}{\tt [private]}}\label{classneuralpp_1_1Neuron_82a4297f84d6403e52a8386d26117b4f}
\index{neuralpp::Neuron@{neuralpp::Neuron}!actv\_\-f@{actv\_\-f}}
\index{actv\_\-f@{actv\_\-f}!neuralpp::Neuron@{neuralpp::Neuron}}
\subsubsection[actv\_\-f]{\setlength{\rightskip}{0pt plus 5cm}double($\ast$ {\bf neuralpp::Neuron::actv\_\-f})(double)\hspace{0.3cm}{\tt [private]}}\label{classneuralpp_1_1Neuron_198ddd0d11a26d0052d52b787d6a0df0}
\index{neuralpp::Neuron@{neuralpp::Neuron}!deriv@{deriv}}
\index{deriv@{deriv}!neuralpp::Neuron@{neuralpp::Neuron}}
\subsubsection[deriv]{\setlength{\rightskip}{0pt plus 5cm}double($\ast$ {\bf neuralpp::Neuron::deriv})(double)\hspace{0.3cm}{\tt [private]}}\label{classneuralpp_1_1Neuron_8b881889e40e9782c49b0efad2b1dde3}
The documentation for this class was generated from the following file:\begin{CompactItemize}
\item
{\bf neural++.hpp}\end{CompactItemize}

View file

@ -0,0 +1,218 @@
\section{neuralpp::Synapsis Class Reference}
\label{classneuralpp_1_1Synapsis}\index{neuralpp::Synapsis@{neuralpp::Synapsis}}
Class for managing synapsis.
{\tt \#include $<$neural++.hpp$>$}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item
{\bf Synapsis} ({\bf Neuron} $\ast$i, {\bf Neuron} $\ast$o, double w, double d)
\begin{CompactList}\small\item\em Constructor. \item\end{CompactList}\item
{\bf Synapsis} ({\bf Neuron} $\ast$i, {\bf Neuron} $\ast$o, double($\ast$a)(double), double($\ast$d)(double))
\begin{CompactList}\small\item\em Constructor. \item\end{CompactList}\item
{\bf Synapsis} ({\bf Neuron} $\ast$i, {\bf Neuron} $\ast$o, double w, double($\ast$a)(double), double($\ast$d)(double))
\begin{CompactList}\small\item\em Constructor. \item\end{CompactList}\item
{\bf Neuron} $\ast$ {\bf getIn} ()
\item
{\bf Neuron} $\ast$ {\bf getOut} ()
\item
void {\bf setWeight} (double w)
\begin{CompactList}\small\item\em Set the weight of the synapsis. \item\end{CompactList}\item
void {\bf setDelta} (double d)
\begin{CompactList}\small\item\em It sets the delta (how much to change the weight after an update) of the synapsis. \item\end{CompactList}\item
double {\bf getWeight} ()
\begin{CompactList}\small\item\em Return the weight of the synapsis. \item\end{CompactList}\item
double {\bf getDelta} ()
\begin{CompactList}\small\item\em Return the delta of the synapsis. \item\end{CompactList}\item
double {\bf getPrevDelta} ()
\begin{CompactList}\small\item\em Get the delta of the synapsis at the previous iteration. \item\end{CompactList}\item
double {\bf momentum} (int N, int x)
\begin{CompactList}\small\item\em Get the inertial momentum of a synapsis. \item\end{CompactList}\end{CompactItemize}
\subsection*{Private Attributes}
\begin{CompactItemize}
\item
double {\bf delta}
\item
double {\bf prev\_\-delta}
\item
double {\bf weight}
\item
{\bf Neuron} $\ast$ {\bf in}
\item
{\bf Neuron} $\ast$ {\bf out}
\item
double($\ast$ {\bf actv\_\-f} )(double)
\item
double($\ast$ {\bf deriv} )(double)
\end{CompactItemize}
\subsection{Detailed Description}
Class for managing synapsis.
Don't use this class directly unless you know what you're doing, use \doxyref{NeuralNet}{p.}{classneuralpp_1_1NeuralNet} instead
\subsection{Constructor \& Destructor Documentation}
\index{neuralpp::Synapsis@{neuralpp::Synapsis}!Synapsis@{Synapsis}}
\index{Synapsis@{Synapsis}!neuralpp::Synapsis@{neuralpp::Synapsis}}
\subsubsection[Synapsis]{\setlength{\rightskip}{0pt plus 5cm}neuralpp::Synapsis::Synapsis ({\bf Neuron} $\ast$ {\em i}, \/ {\bf Neuron} $\ast$ {\em o}, \/ double {\em w}, \/ double {\em d})}\label{classneuralpp_1_1Synapsis_0729de9e737b9967421edcfc4b410bd8}
Constructor.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em i}]Input neuron \item[{\em o}]Output neuron \item[{\em w}]Weight for the synapsis \item[{\em d}]Delta for the synapsis \end{description}
\end{Desc}
\index{neuralpp::Synapsis@{neuralpp::Synapsis}!Synapsis@{Synapsis}}
\index{Synapsis@{Synapsis}!neuralpp::Synapsis@{neuralpp::Synapsis}}
\subsubsection[Synapsis]{\setlength{\rightskip}{0pt plus 5cm}neuralpp::Synapsis::Synapsis ({\bf Neuron} $\ast$ {\em i}, \/ {\bf Neuron} $\ast$ {\em o}, \/ double($\ast$)(double) {\em a}, \/ double($\ast$)(double) {\em d})}\label{classneuralpp_1_1Synapsis_a75e0de57380141973c46dd83d9985e2}
Constructor.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em i}]Input neuron \item[{\em o}]Output neuron \item[{\em a}]Activation function \item[{\em d}]Derivate for activation function \end{description}
\end{Desc}
\index{neuralpp::Synapsis@{neuralpp::Synapsis}!Synapsis@{Synapsis}}
\index{Synapsis@{Synapsis}!neuralpp::Synapsis@{neuralpp::Synapsis}}
\subsubsection[Synapsis]{\setlength{\rightskip}{0pt plus 5cm}neuralpp::Synapsis::Synapsis ({\bf Neuron} $\ast$ {\em i}, \/ {\bf Neuron} $\ast$ {\em o}, \/ double {\em w}, \/ double($\ast$)(double) {\em a}, \/ double($\ast$)(double) {\em d})}\label{classneuralpp_1_1Synapsis_3b9714684c845beae5b3474428509663}
Constructor.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em i}]Input neuron \item[{\em o}]Output neuron \item[{\em w}]Weight for the synapsis (default: random) \item[{\em a}]Activation function \item[{\em d}]Derivate for activation function \end{description}
\end{Desc}
\subsection{Member Function Documentation}
\index{neuralpp::Synapsis@{neuralpp::Synapsis}!getIn@{getIn}}
\index{getIn@{getIn}!neuralpp::Synapsis@{neuralpp::Synapsis}}
\subsubsection[getIn]{\setlength{\rightskip}{0pt plus 5cm}{\bf Neuron}$\ast$ neuralpp::Synapsis::getIn ()}\label{classneuralpp_1_1Synapsis_5ba8a93a5741f4855390eb8a46e99435}
\begin{Desc}
\item[Returns:]Reference to input neuron of the synapsis \end{Desc}
\index{neuralpp::Synapsis@{neuralpp::Synapsis}!getOut@{getOut}}
\index{getOut@{getOut}!neuralpp::Synapsis@{neuralpp::Synapsis}}
\subsubsection[getOut]{\setlength{\rightskip}{0pt plus 5cm}{\bf Neuron}$\ast$ neuralpp::Synapsis::getOut ()}\label{classneuralpp_1_1Synapsis_61c9a04e03291a01f44520cef143cbdd}
\begin{Desc}
\item[Returns:]Reference to output neuron of the synapsis \end{Desc}
\index{neuralpp::Synapsis@{neuralpp::Synapsis}!setWeight@{setWeight}}
\index{setWeight@{setWeight}!neuralpp::Synapsis@{neuralpp::Synapsis}}
\subsubsection[setWeight]{\setlength{\rightskip}{0pt plus 5cm}void neuralpp::Synapsis::setWeight (double {\em w})}\label{classneuralpp_1_1Synapsis_acee77d0fdf9889464ab5ed27beae0ff}
Set the weight of the synapsis.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em w}]Weight to be set \end{description}
\end{Desc}
\index{neuralpp::Synapsis@{neuralpp::Synapsis}!setDelta@{setDelta}}
\index{setDelta@{setDelta}!neuralpp::Synapsis@{neuralpp::Synapsis}}
\subsubsection[setDelta]{\setlength{\rightskip}{0pt plus 5cm}void neuralpp::Synapsis::setDelta (double {\em d})}\label{classneuralpp_1_1Synapsis_429ad5b25930faf436a9d725582802e1}
It sets the delta (how much to change the weight after an update) of the synapsis.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em d}]Delta to be set \end{description}
\end{Desc}
\index{neuralpp::Synapsis@{neuralpp::Synapsis}!getWeight@{getWeight}}
\index{getWeight@{getWeight}!neuralpp::Synapsis@{neuralpp::Synapsis}}
\subsubsection[getWeight]{\setlength{\rightskip}{0pt plus 5cm}double neuralpp::Synapsis::getWeight ()}\label{classneuralpp_1_1Synapsis_aa79c16ec6b59949e5d2f75a3f10d530}
Return the weight of the synapsis.
\begin{Desc}
\item[Returns:]Weight of the synapsis \end{Desc}
\index{neuralpp::Synapsis@{neuralpp::Synapsis}!getDelta@{getDelta}}
\index{getDelta@{getDelta}!neuralpp::Synapsis@{neuralpp::Synapsis}}
\subsubsection[getDelta]{\setlength{\rightskip}{0pt plus 5cm}double neuralpp::Synapsis::getDelta ()}\label{classneuralpp_1_1Synapsis_18f15b920609be8b818d43a0227aada5}
Return the delta of the synapsis.
\begin{Desc}
\item[Returns:]Delta of the synapsis \end{Desc}
\index{neuralpp::Synapsis@{neuralpp::Synapsis}!getPrevDelta@{getPrevDelta}}
\index{getPrevDelta@{getPrevDelta}!neuralpp::Synapsis@{neuralpp::Synapsis}}
\subsubsection[getPrevDelta]{\setlength{\rightskip}{0pt plus 5cm}double neuralpp::Synapsis::getPrevDelta ()}\label{classneuralpp_1_1Synapsis_2fe3e9ec97542f1476d8b9306aa09756}
Get the delta of the synapsis at the previous iteration.
\begin{Desc}
\item[Returns:]The previous delta \end{Desc}
\index{neuralpp::Synapsis@{neuralpp::Synapsis}!momentum@{momentum}}
\index{momentum@{momentum}!neuralpp::Synapsis@{neuralpp::Synapsis}}
\subsubsection[momentum]{\setlength{\rightskip}{0pt plus 5cm}double neuralpp::Synapsis::momentum (int {\em N}, \/ int {\em x})}\label{classneuralpp_1_1Synapsis_ecdb17182de791f7fdd417232e184350}
Get the inertial momentum of a synapsis.
This value is inversely proportional to the number of steps done in the learning phase (quite high at the beginning, decreasing to zero towards the end of the learning algorithm), and is needed to avoid strong oscillations in output values at the beginning, caused by the random values assigned to the synaptical weights \begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em N}]The number of iterations the network must have to adjust the output values \item[{\em x}]The number of iterations already taken \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]The inertial momentum of the synapsis \end{Desc}
\subsection{Member Data Documentation}
\index{neuralpp::Synapsis@{neuralpp::Synapsis}!delta@{delta}}
\index{delta@{delta}!neuralpp::Synapsis@{neuralpp::Synapsis}}
\subsubsection[delta]{\setlength{\rightskip}{0pt plus 5cm}double {\bf neuralpp::Synapsis::delta}\hspace{0.3cm}{\tt [private]}}\label{classneuralpp_1_1Synapsis_617fdc4305f8f1850eac267a7ee22660}
\index{neuralpp::Synapsis@{neuralpp::Synapsis}!prev\_\-delta@{prev\_\-delta}}
\index{prev\_\-delta@{prev\_\-delta}!neuralpp::Synapsis@{neuralpp::Synapsis}}
\subsubsection[prev\_\-delta]{\setlength{\rightskip}{0pt plus 5cm}double {\bf neuralpp::Synapsis::prev\_\-delta}\hspace{0.3cm}{\tt [private]}}\label{classneuralpp_1_1Synapsis_65471cd6c9ef87609dfa4b0e5fafa708}
\index{neuralpp::Synapsis@{neuralpp::Synapsis}!weight@{weight}}
\index{weight@{weight}!neuralpp::Synapsis@{neuralpp::Synapsis}}
\subsubsection[weight]{\setlength{\rightskip}{0pt plus 5cm}double {\bf neuralpp::Synapsis::weight}\hspace{0.3cm}{\tt [private]}}\label{classneuralpp_1_1Synapsis_0bc523a8135ebbb5c0da932939d30ed7}
\index{neuralpp::Synapsis@{neuralpp::Synapsis}!in@{in}}
\index{in@{in}!neuralpp::Synapsis@{neuralpp::Synapsis}}
\subsubsection[in]{\setlength{\rightskip}{0pt plus 5cm}{\bf Neuron}$\ast$ {\bf neuralpp::Synapsis::in}\hspace{0.3cm}{\tt [private]}}\label{classneuralpp_1_1Synapsis_83d41c158054b08bd05051736e89a0ad}
\index{neuralpp::Synapsis@{neuralpp::Synapsis}!out@{out}}
\index{out@{out}!neuralpp::Synapsis@{neuralpp::Synapsis}}
\subsubsection[out]{\setlength{\rightskip}{0pt plus 5cm}{\bf Neuron}$\ast$ {\bf neuralpp::Synapsis::out}\hspace{0.3cm}{\tt [private]}}\label{classneuralpp_1_1Synapsis_fb219e05038fa0da20db1082ab0500be}
\index{neuralpp::Synapsis@{neuralpp::Synapsis}!actv\_\-f@{actv\_\-f}}
\index{actv\_\-f@{actv\_\-f}!neuralpp::Synapsis@{neuralpp::Synapsis}}
\subsubsection[actv\_\-f]{\setlength{\rightskip}{0pt plus 5cm}double($\ast$ {\bf neuralpp::Synapsis::actv\_\-f})(double)\hspace{0.3cm}{\tt [private]}}\label{classneuralpp_1_1Synapsis_2539b9eef2ff0f3522aea8d89e394f02}
\index{neuralpp::Synapsis@{neuralpp::Synapsis}!deriv@{deriv}}
\index{deriv@{deriv}!neuralpp::Synapsis@{neuralpp::Synapsis}}
\subsubsection[deriv]{\setlength{\rightskip}{0pt plus 5cm}double($\ast$ {\bf neuralpp::Synapsis::deriv})(double)\hspace{0.3cm}{\tt [private]}}\label{classneuralpp_1_1Synapsis_2940b370c283aa1b63890666942c26bf}
The documentation for this class was generated from the following file:\begin{CompactItemize}
\item
{\bf neural++.hpp}\end{CompactItemize}

78
doc/latex/doxygen.sty Normal file
View file

@ -0,0 +1,78 @@
\NeedsTeXFormat{LaTeX2e}
\ProvidesPackage{doxygen}
\RequirePackage{calc}
\RequirePackage{array}
\pagestyle{fancyplain}
\newcommand{\clearemptydoublepage}{\newpage{\pagestyle{empty}\cleardoublepage}}
\renewcommand{\chaptermark}[1]{\markboth{#1}{}}
\renewcommand{\sectionmark}[1]{\markright{\thesection\ #1}}
\lhead[\fancyplain{}{\bfseries\thepage}]
{\fancyplain{}{\bfseries\rightmark}}
\rhead[\fancyplain{}{\bfseries\leftmark}]
{\fancyplain{}{\bfseries\thepage}}
\rfoot[\fancyplain{}{\bfseries\scriptsize Generated on Sun Aug 9 11:11:17 2009 for Neural++ by Doxygen }]{}
\lfoot[]{\fancyplain{}{\bfseries\scriptsize Generated on Sun Aug 9 11:11:17 2009 for Neural++ by Doxygen }}
\cfoot{}
\newenvironment{Code}
{\footnotesize}
{\normalsize}
\newcommand{\doxyref}[3]{\textbf{#1} (\textnormal{#2}\,\pageref{#3})}
\newenvironment{DocInclude}
{\footnotesize}
{\normalsize}
\newenvironment{VerbInclude}
{\footnotesize}
{\normalsize}
\newenvironment{Image}
{\begin{figure}[H]}
{\end{figure}}
\newenvironment{ImageNoCaption}{}{}
\newenvironment{CompactList}
{\begin{list}{}{
\setlength{\leftmargin}{0.5cm}
\setlength{\itemsep}{0pt}
\setlength{\parsep}{0pt}
\setlength{\topsep}{0pt}
\renewcommand{\makelabel}{\hfill}}}
{\end{list}}
\newenvironment{CompactItemize}
{
\begin{itemize}
\setlength{\itemsep}{-3pt}
\setlength{\parsep}{0pt}
\setlength{\topsep}{0pt}
\setlength{\partopsep}{0pt}
}
{\end{itemize}}
\newcommand{\PBS}[1]{\let\temp=\\#1\let\\=\temp}
\newlength{\tmplength}
\newenvironment{TabularC}[1]
{
\setlength{\tmplength}
{\linewidth/(#1)-\tabcolsep*2-\arrayrulewidth*(#1+1)/(#1)}
\par\begin{tabular*}{\linewidth}
{*{#1}{|>{\PBS\raggedright\hspace{0pt}}p{\the\tmplength}}|}
}
{\end{tabular*}\par}
\newcommand{\entrylabel}[1]{
{\parbox[b]{\labelwidth-4pt}{\makebox[0pt][l]{\textbf{#1}}\vspace{1.5\baselineskip}}}}
\newenvironment{Desc}
{\begin{list}{}
{
\settowidth{\labelwidth}{40pt}
\setlength{\leftmargin}{\labelwidth}
\setlength{\parsep}{0pt}
\setlength{\itemsep}{-4pt}
\renewcommand{\makelabel}{\entrylabel}
}
}
{\end{list}}
\newenvironment{Indent}
{\begin{list}{}{\setlength{\leftmargin}{0.5cm}}
\item[]\ignorespaces}
{\unskip\end{list}}
\setlength{\parindent}{0cm}
\setlength{\parskip}{0.2cm}
\addtocounter{secnumdepth}{1}
\sloppy
\usepackage[T1]{fontenc}

6
doc/latex/files.tex Normal file
View file

@ -0,0 +1,6 @@
\section{File List}
Here is a list of all files with brief descriptions:\begin{CompactList}
\item\contentsline{section}{{\bf Markup.h} }{\pageref{Markup_8h}}{}
\item\contentsline{section}{{\bf neural++.hpp} }{\pageref{neural_09_09_8hpp}}{}
\item\contentsline{section}{{\bf neural++\_\-exception.hpp} }{\pageref{neural_09_09__exception_8hpp}}{}
\end{CompactList}

View file

@ -0,0 +1,26 @@
\section{neuralpp Namespace Reference}
\label{namespaceneuralpp}\index{neuralpp@{neuralpp}}
Main namespace for the library.
\subsection*{Classes}
\begin{CompactItemize}
\item
class {\bf NeuralNet}
\begin{CompactList}\small\item\em Main project's class. \item\end{CompactList}\item
class {\bf Synapsis}
\begin{CompactList}\small\item\em Class for managing synapsis. \item\end{CompactList}\item
class {\bf Neuron}
\begin{CompactList}\small\item\em Class for managing neurons. \item\end{CompactList}\item
class {\bf Layer}
\begin{CompactList}\small\item\em Class for managing layers of neurons. \item\end{CompactList}\item
struct {\bf netrecord}
\item
struct {\bf neuronrecord}
\item
struct {\bf synrecord}
\end{CompactItemize}
\subsection{Detailed Description}
Main namespace for the library.

4
doc/latex/namespaces.tex Normal file
View file

@ -0,0 +1,4 @@
\section{Namespace List}
Here is a list of all namespaces with brief descriptions:\begin{CompactList}
\item\contentsline{section}{{\bf neuralpp} (Main namespace for the library )}{\pageref{namespaceneuralpp}}{}
\end{CompactList}

View file

@ -0,0 +1,54 @@
\section{neural++.hpp File Reference}
\label{neural_09_09_8hpp}\index{neural++.hpp@{neural++.hpp}}
{\tt \#include $<$vector$>$}\par
{\tt \#include $<$string$>$}\par
{\tt \#include $<$cmath$>$}\par
{\tt \#include $<$ctime$>$}\par
{\tt \#include $<$cstdio$>$}\par
{\tt \#include \char`\"{}neural++\_\-exception.hpp\char`\"{}}\par
\subsection*{Namespaces}
\begin{CompactItemize}
\item
namespace {\bf neuralpp}
\end{CompactItemize}
\subsection*{Classes}
\begin{CompactItemize}
\item
class {\bf neuralpp::NeuralNet}
\begin{CompactList}\small\item\em Main project's class. \item\end{CompactList}\item
class {\bf neuralpp::Synapsis}
\begin{CompactList}\small\item\em Class for managing synapsis. \item\end{CompactList}\item
class {\bf neuralpp::Neuron}
\begin{CompactList}\small\item\em Class for managing neurons. \item\end{CompactList}\item
class {\bf neuralpp::Layer}
\begin{CompactList}\small\item\em Class for managing layers of neurons. \item\end{CompactList}\item
struct {\bf neuralpp::netrecord}
\item
struct {\bf neuralpp::neuronrecord}
\item
struct {\bf neuralpp::synrecord}
\end{CompactItemize}
\subsection*{Defines}
\begin{CompactItemize}
\item
\#define {\bf RAND}~( abs( sin(rand()) ) )
\begin{CompactList}\small\item\em Default rand value: $|$sin(rand)$|$, always $>$= 0 and $<$= 1. \item\end{CompactList}\item
\#define {\bf BETA0}~0.7
\begin{CompactList}\small\item\em Initial value for the inertial momentum of the synapses. \item\end{CompactList}\end{CompactItemize}
\subsection{Define Documentation}
\index{neural++.hpp@{neural++.hpp}!BETA0@{BETA0}}
\index{BETA0@{BETA0}!neural++.hpp@{neural++.hpp}}
\subsubsection[BETA0]{\setlength{\rightskip}{0pt plus 5cm}\#define BETA0~0.7}\label{neural_09_09_8hpp_05e2bb5b9fc32f0b6b4d84fe43177d72}
Initial value for the inertial momentum of the synapses.
\index{neural++.hpp@{neural++.hpp}!RAND@{RAND}}
\index{RAND@{RAND}!neural++.hpp@{neural++.hpp}}
\subsubsection[RAND]{\setlength{\rightskip}{0pt plus 5cm}\#define RAND~( abs( sin(rand()) ) )}\label{neural_09_09_8hpp_839a9222721835f53c5b248241f535f4}
Default rand value: $|$sin(rand)$|$, always $>$= 0 and $<$= 1.

View file

@ -0,0 +1,2 @@
\section{neural++\_\-exception.hpp File Reference}
\label{neural_09_09__exception_8hpp}\index{neural++\_\-exception.hpp@{neural++\_\-exception.hpp}}

64
doc/latex/refman.tex Normal file
View file

@ -0,0 +1,64 @@
\documentclass[a4paper]{book}
\usepackage{a4wide}
\usepackage{makeidx}
\usepackage{fancyhdr}
\usepackage{graphicx}
\usepackage{multicol}
\usepackage{float}
\usepackage{textcomp}
\usepackage{alltt}
\usepackage[utf8]{inputenc}
\usepackage{doxygen}
\makeindex
\setcounter{tocdepth}{3}
\renewcommand{\footrulewidth}{0.4pt}
\begin{document}
\begin{titlepage}
\vspace*{7cm}
\begin{center}
{\Large Neural++ \\[1ex]\large 0.3 }\\
\vspace*{1cm}
{\large Generated by Doxygen 1.5.6}\\
\vspace*{0.5cm}
{\small Sun Aug 9 11:11:17 2009}\\
\end{center}
\end{titlepage}
\clearemptydoublepage
\pagenumbering{roman}
\tableofcontents
\clearemptydoublepage
\pagenumbering{arabic}
\chapter{Namespace Index}
\input{namespaces}
\chapter{Class Index}
\input{annotated}
\chapter{File Index}
\input{files}
\chapter{Namespace Documentation}
\input{namespaceneuralpp}
\chapter{Class Documentation}
\input{classCMarkup}
\include{structCMarkup_1_1ConvertEncoding}
\include{structCMarkup_1_1ElemPos}
\include{structCMarkup_1_1FilePos}
\include{structCMarkup_1_1NodePos}
\include{structCMarkup_1_1NodeStack}
\include{structCMarkup_1_1PosArray}
\include{structCMarkup_1_1SavedPos}
\include{structCMarkup_1_1SavedPosMap}
\include{structCMarkup_1_1SavedPosMapArray}
\include{structCMarkup_1_1TokenPos}
\include{classneuralpp_1_1Layer}
\include{structMCD__CSTR}
\include{structneuralpp_1_1netrecord}
\include{classneuralpp_1_1NeuralNet}
\include{classneuralpp_1_1Neuron}
\include{structneuralpp_1_1neuronrecord}
\include{classneuralpp_1_1Synapsis}
\include{structneuralpp_1_1synrecord}
\chapter{File Documentation}
\input{Markup_8h}
\include{neural_09_09_8hpp}
\include{neural_09_09__exception_8hpp}
\printindex
\end{document}

View file

@ -0,0 +1,84 @@
\section{CMarkup::ConvertEncoding Struct Reference}
\label{structCMarkup_1_1ConvertEncoding}\index{CMarkup::ConvertEncoding@{CMarkup::ConvertEncoding}}
{\tt \#include $<$Markup.h$>$}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item
{\bf ConvertEncoding} ({\bf MCD\_\-CSTR} pszToEncoding, {\bf MCD\_\-CSTR} pszFromEncoding, const void $\ast$pFromBuffer, int nFromBufferLen)
\end{CompactItemize}
\subsection*{Public Attributes}
\begin{CompactItemize}
\item
MCD\_\-STR {\bf strToEncoding}
\item
MCD\_\-STR {\bf strFromEncoding}
\item
const void $\ast$ {\bf pFrom}
\item
int {\bf nFromLen}
\item
int {\bf nToCount}
\item
int {\bf nFailedChars}
\end{CompactItemize}
\subsection{Constructor \& Destructor Documentation}
\index{CMarkup::ConvertEncoding@{CMarkup::ConvertEncoding}!ConvertEncoding@{ConvertEncoding}}
\index{ConvertEncoding@{ConvertEncoding}!CMarkup::ConvertEncoding@{CMarkup::ConvertEncoding}}
\subsubsection[ConvertEncoding]{\setlength{\rightskip}{0pt plus 5cm}CMarkup::ConvertEncoding::ConvertEncoding ({\bf MCD\_\-CSTR} {\em pszToEncoding}, \/ {\bf MCD\_\-CSTR} {\em pszFromEncoding}, \/ const void $\ast$ {\em pFromBuffer}, \/ int {\em nFromBufferLen})\hspace{0.3cm}{\tt [inline]}}\label{structCMarkup_1_1ConvertEncoding_52cfe3e75ff550c9ed4f4b472280192b}
References nFailedChars, nFromLen, nToCount, pFrom, strFromEncoding, and strToEncoding.
\subsection{Member Data Documentation}
\index{CMarkup::ConvertEncoding@{CMarkup::ConvertEncoding}!strToEncoding@{strToEncoding}}
\index{strToEncoding@{strToEncoding}!CMarkup::ConvertEncoding@{CMarkup::ConvertEncoding}}
\subsubsection[strToEncoding]{\setlength{\rightskip}{0pt plus 5cm}MCD\_\-STR {\bf CMarkup::ConvertEncoding::strToEncoding}}\label{structCMarkup_1_1ConvertEncoding_cc2420305e7cfa6c9d18f7ce9daa4313}
Referenced by ConvertEncoding().\index{CMarkup::ConvertEncoding@{CMarkup::ConvertEncoding}!strFromEncoding@{strFromEncoding}}
\index{strFromEncoding@{strFromEncoding}!CMarkup::ConvertEncoding@{CMarkup::ConvertEncoding}}
\subsubsection[strFromEncoding]{\setlength{\rightskip}{0pt plus 5cm}MCD\_\-STR {\bf CMarkup::ConvertEncoding::strFromEncoding}}\label{structCMarkup_1_1ConvertEncoding_8ab5d602610c46eb26d0fbf8a39b2da8}
Referenced by ConvertEncoding().\index{CMarkup::ConvertEncoding@{CMarkup::ConvertEncoding}!pFrom@{pFrom}}
\index{pFrom@{pFrom}!CMarkup::ConvertEncoding@{CMarkup::ConvertEncoding}}
\subsubsection[pFrom]{\setlength{\rightskip}{0pt plus 5cm}const void$\ast$ {\bf CMarkup::ConvertEncoding::pFrom}}\label{structCMarkup_1_1ConvertEncoding_9647b6f60d353bd8af2ff462ff451b4d}
Referenced by ConvertEncoding().\index{CMarkup::ConvertEncoding@{CMarkup::ConvertEncoding}!nFromLen@{nFromLen}}
\index{nFromLen@{nFromLen}!CMarkup::ConvertEncoding@{CMarkup::ConvertEncoding}}
\subsubsection[nFromLen]{\setlength{\rightskip}{0pt plus 5cm}int {\bf CMarkup::ConvertEncoding::nFromLen}}\label{structCMarkup_1_1ConvertEncoding_4b5e6d28cc2e909e2ac0d164cd00d53c}
Referenced by ConvertEncoding().\index{CMarkup::ConvertEncoding@{CMarkup::ConvertEncoding}!nToCount@{nToCount}}
\index{nToCount@{nToCount}!CMarkup::ConvertEncoding@{CMarkup::ConvertEncoding}}
\subsubsection[nToCount]{\setlength{\rightskip}{0pt plus 5cm}int {\bf CMarkup::ConvertEncoding::nToCount}}\label{structCMarkup_1_1ConvertEncoding_9fe87df87a339214df5e30bce32edcf4}
Referenced by ConvertEncoding().\index{CMarkup::ConvertEncoding@{CMarkup::ConvertEncoding}!nFailedChars@{nFailedChars}}
\index{nFailedChars@{nFailedChars}!CMarkup::ConvertEncoding@{CMarkup::ConvertEncoding}}
\subsubsection[nFailedChars]{\setlength{\rightskip}{0pt plus 5cm}int {\bf CMarkup::ConvertEncoding::nFailedChars}}\label{structCMarkup_1_1ConvertEncoding_bfd8cc96d41531109b9301b4d28a695f}
Referenced by ConvertEncoding().
The documentation for this struct was generated from the following file:\begin{CompactItemize}
\item
{\bf Markup.h}\end{CompactItemize}

View file

@ -0,0 +1,221 @@
\section{CMarkup::ElemPos Struct Reference}
\label{structCMarkup_1_1ElemPos}\index{CMarkup::ElemPos@{CMarkup::ElemPos}}
{\tt \#include $<$Markup.h$>$}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item
{\bf ElemPos} ()
\item
{\bf ElemPos} (const {\bf ElemPos} \&pos)
\item
int {\bf StartTagLen} () const
\item
void {\bf SetStartTagLen} (int n)
\item
void {\bf AdjustStartTagLen} (int n)
\item
int {\bf EndTagLen} () const
\item
void {\bf SetEndTagLen} (int n)
\item
bool {\bf IsEmptyElement} ()
\item
int {\bf StartContent} () const
\item
int {\bf ContentLen} () const
\item
int {\bf StartAfter} () const
\item
int {\bf Level} () const
\item
void {\bf SetLevel} (int nLev)
\item
void {\bf ClearVirtualParent} ()
\end{CompactItemize}
\subsection*{Public Attributes}
\begin{CompactItemize}
\item
int {\bf nStart}
\item
int {\bf nLength}
\item
unsigned int {\bf nStartTagLen}: 22
\item
unsigned int {\bf nEndTagLen}: 10
\item
int {\bf nFlags}
\item
int {\bf iElemParent}
\item
int {\bf iElemChild}
\item
int {\bf iElemNext}
\item
int {\bf iElemPrev}
\end{CompactItemize}
\subsection{Constructor \& Destructor Documentation}
\index{CMarkup::ElemPos@{CMarkup::ElemPos}!ElemPos@{ElemPos}}
\index{ElemPos@{ElemPos}!CMarkup::ElemPos@{CMarkup::ElemPos}}
\subsubsection[ElemPos]{\setlength{\rightskip}{0pt plus 5cm}CMarkup::ElemPos::ElemPos ()\hspace{0.3cm}{\tt [inline]}}\label{structCMarkup_1_1ElemPos_7ba7e4930d77275e80e38ea151b2807b}
\index{CMarkup::ElemPos@{CMarkup::ElemPos}!ElemPos@{ElemPos}}
\index{ElemPos@{ElemPos}!CMarkup::ElemPos@{CMarkup::ElemPos}}
\subsubsection[ElemPos]{\setlength{\rightskip}{0pt plus 5cm}CMarkup::ElemPos::ElemPos (const {\bf ElemPos} \& {\em pos})\hspace{0.3cm}{\tt [inline]}}\label{structCMarkup_1_1ElemPos_739a02a2c992cde556999155bee37e21}
\subsection{Member Function Documentation}
\index{CMarkup::ElemPos@{CMarkup::ElemPos}!StartTagLen@{StartTagLen}}
\index{StartTagLen@{StartTagLen}!CMarkup::ElemPos@{CMarkup::ElemPos}}
\subsubsection[StartTagLen]{\setlength{\rightskip}{0pt plus 5cm}int CMarkup::ElemPos::StartTagLen () const\hspace{0.3cm}{\tt [inline]}}\label{structCMarkup_1_1ElemPos_987926f5677976e6288e5b4c3a224d96}
References nStartTagLen.
Referenced by ContentLen(), IsEmptyElement(), and StartContent().\index{CMarkup::ElemPos@{CMarkup::ElemPos}!SetStartTagLen@{SetStartTagLen}}
\index{SetStartTagLen@{SetStartTagLen}!CMarkup::ElemPos@{CMarkup::ElemPos}}
\subsubsection[SetStartTagLen]{\setlength{\rightskip}{0pt plus 5cm}void CMarkup::ElemPos::SetStartTagLen (int {\em n})\hspace{0.3cm}{\tt [inline]}}\label{structCMarkup_1_1ElemPos_6f366b2f636e221db004bf44fd952912}
References nStartTagLen.\index{CMarkup::ElemPos@{CMarkup::ElemPos}!AdjustStartTagLen@{AdjustStartTagLen}}
\index{AdjustStartTagLen@{AdjustStartTagLen}!CMarkup::ElemPos@{CMarkup::ElemPos}}
\subsubsection[AdjustStartTagLen]{\setlength{\rightskip}{0pt plus 5cm}void CMarkup::ElemPos::AdjustStartTagLen (int {\em n})\hspace{0.3cm}{\tt [inline]}}\label{structCMarkup_1_1ElemPos_3140f418c80056cb8aba69a270c6a71d}
References nStartTagLen.\index{CMarkup::ElemPos@{CMarkup::ElemPos}!EndTagLen@{EndTagLen}}
\index{EndTagLen@{EndTagLen}!CMarkup::ElemPos@{CMarkup::ElemPos}}
\subsubsection[EndTagLen]{\setlength{\rightskip}{0pt plus 5cm}int CMarkup::ElemPos::EndTagLen () const\hspace{0.3cm}{\tt [inline]}}\label{structCMarkup_1_1ElemPos_d9d0ad0c48a129555d1052e98e4f71bd}
References nEndTagLen.
Referenced by ContentLen().\index{CMarkup::ElemPos@{CMarkup::ElemPos}!SetEndTagLen@{SetEndTagLen}}
\index{SetEndTagLen@{SetEndTagLen}!CMarkup::ElemPos@{CMarkup::ElemPos}}
\subsubsection[SetEndTagLen]{\setlength{\rightskip}{0pt plus 5cm}void CMarkup::ElemPos::SetEndTagLen (int {\em n})\hspace{0.3cm}{\tt [inline]}}\label{structCMarkup_1_1ElemPos_e427d1e0e53cfd0fe1c278f34c585bc9}
References nEndTagLen.\index{CMarkup::ElemPos@{CMarkup::ElemPos}!IsEmptyElement@{IsEmptyElement}}
\index{IsEmptyElement@{IsEmptyElement}!CMarkup::ElemPos@{CMarkup::ElemPos}}
\subsubsection[IsEmptyElement]{\setlength{\rightskip}{0pt plus 5cm}bool CMarkup::ElemPos::IsEmptyElement ()\hspace{0.3cm}{\tt [inline]}}\label{structCMarkup_1_1ElemPos_97093aa0ddbd691dd00c91c945a3e98a}
References nLength, and StartTagLen().\index{CMarkup::ElemPos@{CMarkup::ElemPos}!StartContent@{StartContent}}
\index{StartContent@{StartContent}!CMarkup::ElemPos@{CMarkup::ElemPos}}
\subsubsection[StartContent]{\setlength{\rightskip}{0pt plus 5cm}int CMarkup::ElemPos::StartContent () const\hspace{0.3cm}{\tt [inline]}}\label{structCMarkup_1_1ElemPos_853d5e4a5c6b03643e7210671385896c}
References nStart, and StartTagLen().\index{CMarkup::ElemPos@{CMarkup::ElemPos}!ContentLen@{ContentLen}}
\index{ContentLen@{ContentLen}!CMarkup::ElemPos@{CMarkup::ElemPos}}
\subsubsection[ContentLen]{\setlength{\rightskip}{0pt plus 5cm}int CMarkup::ElemPos::ContentLen () const\hspace{0.3cm}{\tt [inline]}}\label{structCMarkup_1_1ElemPos_9099635ab9239103aa930b2f1a456d2d}
References EndTagLen(), nLength, and StartTagLen().\index{CMarkup::ElemPos@{CMarkup::ElemPos}!StartAfter@{StartAfter}}
\index{StartAfter@{StartAfter}!CMarkup::ElemPos@{CMarkup::ElemPos}}
\subsubsection[StartAfter]{\setlength{\rightskip}{0pt plus 5cm}int CMarkup::ElemPos::StartAfter () const\hspace{0.3cm}{\tt [inline]}}\label{structCMarkup_1_1ElemPos_e1e21b6e27db22eda6178898d2aa42d3}
References nLength, and nStart.\index{CMarkup::ElemPos@{CMarkup::ElemPos}!Level@{Level}}
\index{Level@{Level}!CMarkup::ElemPos@{CMarkup::ElemPos}}
\subsubsection[Level]{\setlength{\rightskip}{0pt plus 5cm}int CMarkup::ElemPos::Level () const\hspace{0.3cm}{\tt [inline]}}\label{structCMarkup_1_1ElemPos_cdea1fc74ed96d413138c6c2d9b0a4f7}
References nFlags.\index{CMarkup::ElemPos@{CMarkup::ElemPos}!SetLevel@{SetLevel}}
\index{SetLevel@{SetLevel}!CMarkup::ElemPos@{CMarkup::ElemPos}}
\subsubsection[SetLevel]{\setlength{\rightskip}{0pt plus 5cm}void CMarkup::ElemPos::SetLevel (int {\em nLev})\hspace{0.3cm}{\tt [inline]}}\label{structCMarkup_1_1ElemPos_625d84902ebb86bda4d5c5720f00e885}
References nFlags.\index{CMarkup::ElemPos@{CMarkup::ElemPos}!ClearVirtualParent@{ClearVirtualParent}}
\index{ClearVirtualParent@{ClearVirtualParent}!CMarkup::ElemPos@{CMarkup::ElemPos}}
\subsubsection[ClearVirtualParent]{\setlength{\rightskip}{0pt plus 5cm}void CMarkup::ElemPos::ClearVirtualParent ()\hspace{0.3cm}{\tt [inline]}}\label{structCMarkup_1_1ElemPos_b70cf4ad47e44a2d4c7f6c06a2ff0659}
\subsection{Member Data Documentation}
\index{CMarkup::ElemPos@{CMarkup::ElemPos}!nStart@{nStart}}
\index{nStart@{nStart}!CMarkup::ElemPos@{CMarkup::ElemPos}}
\subsubsection[nStart]{\setlength{\rightskip}{0pt plus 5cm}int {\bf CMarkup::ElemPos::nStart}}\label{structCMarkup_1_1ElemPos_37cbff8b4e0d5b086970efb1bc9b70fe}
Referenced by StartAfter(), and StartContent().\index{CMarkup::ElemPos@{CMarkup::ElemPos}!nLength@{nLength}}
\index{nLength@{nLength}!CMarkup::ElemPos@{CMarkup::ElemPos}}
\subsubsection[nLength]{\setlength{\rightskip}{0pt plus 5cm}int {\bf CMarkup::ElemPos::nLength}}\label{structCMarkup_1_1ElemPos_d9d89d7af0f4cb69b0b1f4d0b5d4953f}
Referenced by ContentLen(), IsEmptyElement(), and StartAfter().\index{CMarkup::ElemPos@{CMarkup::ElemPos}!nStartTagLen@{nStartTagLen}}
\index{nStartTagLen@{nStartTagLen}!CMarkup::ElemPos@{CMarkup::ElemPos}}
\subsubsection[nStartTagLen]{\setlength{\rightskip}{0pt plus 5cm}unsigned int {\bf CMarkup::ElemPos::nStartTagLen}}\label{structCMarkup_1_1ElemPos_c929700bbc1ec8b928253235dd5038af}
Referenced by AdjustStartTagLen(), SetStartTagLen(), and StartTagLen().\index{CMarkup::ElemPos@{CMarkup::ElemPos}!nEndTagLen@{nEndTagLen}}
\index{nEndTagLen@{nEndTagLen}!CMarkup::ElemPos@{CMarkup::ElemPos}}
\subsubsection[nEndTagLen]{\setlength{\rightskip}{0pt plus 5cm}unsigned int {\bf CMarkup::ElemPos::nEndTagLen}}\label{structCMarkup_1_1ElemPos_a53ebdfa2aecc621f9cdde9c247d3357}
Referenced by EndTagLen(), and SetEndTagLen().\index{CMarkup::ElemPos@{CMarkup::ElemPos}!nFlags@{nFlags}}
\index{nFlags@{nFlags}!CMarkup::ElemPos@{CMarkup::ElemPos}}
\subsubsection[nFlags]{\setlength{\rightskip}{0pt plus 5cm}int {\bf CMarkup::ElemPos::nFlags}}\label{structCMarkup_1_1ElemPos_586bb5a2dc7f48ac1417ffd07319a9c9}
Referenced by Level(), and SetLevel().\index{CMarkup::ElemPos@{CMarkup::ElemPos}!iElemParent@{iElemParent}}
\index{iElemParent@{iElemParent}!CMarkup::ElemPos@{CMarkup::ElemPos}}
\subsubsection[iElemParent]{\setlength{\rightskip}{0pt plus 5cm}int {\bf CMarkup::ElemPos::iElemParent}}\label{structCMarkup_1_1ElemPos_e579f35b6cdee1609c6835eddf2b5b03}
\index{CMarkup::ElemPos@{CMarkup::ElemPos}!iElemChild@{iElemChild}}
\index{iElemChild@{iElemChild}!CMarkup::ElemPos@{CMarkup::ElemPos}}
\subsubsection[iElemChild]{\setlength{\rightskip}{0pt plus 5cm}int {\bf CMarkup::ElemPos::iElemChild}}\label{structCMarkup_1_1ElemPos_3449b75f915ff4900af177d9a91d91d1}
\index{CMarkup::ElemPos@{CMarkup::ElemPos}!iElemNext@{iElemNext}}
\index{iElemNext@{iElemNext}!CMarkup::ElemPos@{CMarkup::ElemPos}}
\subsubsection[iElemNext]{\setlength{\rightskip}{0pt plus 5cm}int {\bf CMarkup::ElemPos::iElemNext}}\label{structCMarkup_1_1ElemPos_c61f6c9ee6421801e94d7df7afa4f1ed}
\index{CMarkup::ElemPos@{CMarkup::ElemPos}!iElemPrev@{iElemPrev}}
\index{iElemPrev@{iElemPrev}!CMarkup::ElemPos@{CMarkup::ElemPos}}
\subsubsection[iElemPrev]{\setlength{\rightskip}{0pt plus 5cm}int {\bf CMarkup::ElemPos::iElemPrev}}\label{structCMarkup_1_1ElemPos_45534bddcab1f12a8452a070368488ca}
The documentation for this struct was generated from the following file:\begin{CompactItemize}
\item
{\bf Markup.h}\end{CompactItemize}

View file

@ -0,0 +1,84 @@
\section{CMarkup::FilePos Struct Reference}
\label{structCMarkup_1_1FilePos}\index{CMarkup::FilePos@{CMarkup::FilePos}}
{\tt \#include $<$Markup.h$>$}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item
{\bf FilePos} ()
\end{CompactItemize}
\subsection*{Public Attributes}
\begin{CompactItemize}
\item
FILE $\ast$ {\bf fp}
\item
int {\bf nDocFlags}
\item
int {\bf nFileByteLen}
\item
int {\bf nReadByteLen}
\item
int {\bf nFileCharUnitSize}
\item
int {\bf nFileTextLen}
\item
MCD\_\-STR {\bf strIOResult}
\item
MCD\_\-STR {\bf strEncoding}
\end{CompactItemize}
\subsection{Constructor \& Destructor Documentation}
\index{CMarkup::FilePos@{CMarkup::FilePos}!FilePos@{FilePos}}
\index{FilePos@{FilePos}!CMarkup::FilePos@{CMarkup::FilePos}}
\subsubsection[FilePos]{\setlength{\rightskip}{0pt plus 5cm}CMarkup::FilePos::FilePos ()\hspace{0.3cm}{\tt [inline]}}\label{structCMarkup_1_1FilePos_88d083c8aee934fd42de2950a31d3682}
\subsection{Member Data Documentation}
\index{CMarkup::FilePos@{CMarkup::FilePos}!fp@{fp}}
\index{fp@{fp}!CMarkup::FilePos@{CMarkup::FilePos}}
\subsubsection[fp]{\setlength{\rightskip}{0pt plus 5cm}FILE$\ast$ {\bf CMarkup::FilePos::fp}}\label{structCMarkup_1_1FilePos_d5d7584cf09fa60ef62f5c764e1ee158}
\index{CMarkup::FilePos@{CMarkup::FilePos}!nDocFlags@{nDocFlags}}
\index{nDocFlags@{nDocFlags}!CMarkup::FilePos@{CMarkup::FilePos}}
\subsubsection[nDocFlags]{\setlength{\rightskip}{0pt plus 5cm}int {\bf CMarkup::FilePos::nDocFlags}}\label{structCMarkup_1_1FilePos_f3c61a69075b838325939fd0e4955751}
\index{CMarkup::FilePos@{CMarkup::FilePos}!nFileByteLen@{nFileByteLen}}
\index{nFileByteLen@{nFileByteLen}!CMarkup::FilePos@{CMarkup::FilePos}}
\subsubsection[nFileByteLen]{\setlength{\rightskip}{0pt plus 5cm}int {\bf CMarkup::FilePos::nFileByteLen}}\label{structCMarkup_1_1FilePos_abf2b7dc4b6f910fe45ada3a8d367405}
\index{CMarkup::FilePos@{CMarkup::FilePos}!nReadByteLen@{nReadByteLen}}
\index{nReadByteLen@{nReadByteLen}!CMarkup::FilePos@{CMarkup::FilePos}}
\subsubsection[nReadByteLen]{\setlength{\rightskip}{0pt plus 5cm}int {\bf CMarkup::FilePos::nReadByteLen}}\label{structCMarkup_1_1FilePos_37e43f21dfee719038602c84756c8059}
\index{CMarkup::FilePos@{CMarkup::FilePos}!nFileCharUnitSize@{nFileCharUnitSize}}
\index{nFileCharUnitSize@{nFileCharUnitSize}!CMarkup::FilePos@{CMarkup::FilePos}}
\subsubsection[nFileCharUnitSize]{\setlength{\rightskip}{0pt plus 5cm}int {\bf CMarkup::FilePos::nFileCharUnitSize}}\label{structCMarkup_1_1FilePos_406f0760fdd5875ace5111b1d6908a99}
\index{CMarkup::FilePos@{CMarkup::FilePos}!nFileTextLen@{nFileTextLen}}
\index{nFileTextLen@{nFileTextLen}!CMarkup::FilePos@{CMarkup::FilePos}}
\subsubsection[nFileTextLen]{\setlength{\rightskip}{0pt plus 5cm}int {\bf CMarkup::FilePos::nFileTextLen}}\label{structCMarkup_1_1FilePos_3635096138ee3ce3ce5f9327b20438a4}
\index{CMarkup::FilePos@{CMarkup::FilePos}!strIOResult@{strIOResult}}
\index{strIOResult@{strIOResult}!CMarkup::FilePos@{CMarkup::FilePos}}
\subsubsection[strIOResult]{\setlength{\rightskip}{0pt plus 5cm}MCD\_\-STR {\bf CMarkup::FilePos::strIOResult}}\label{structCMarkup_1_1FilePos_62db77f82233f3244272eb973a9ecfc8}
\index{CMarkup::FilePos@{CMarkup::FilePos}!strEncoding@{strEncoding}}
\index{strEncoding@{strEncoding}!CMarkup::FilePos@{CMarkup::FilePos}}
\subsubsection[strEncoding]{\setlength{\rightskip}{0pt plus 5cm}MCD\_\-STR {\bf CMarkup::FilePos::strEncoding}}\label{structCMarkup_1_1FilePos_b507cbd49031186d4b3fbf7d2d009c75}
The documentation for this struct was generated from the following file:\begin{CompactItemize}
\item
{\bf Markup.h}\end{CompactItemize}

View file

@ -0,0 +1,80 @@
\section{CMarkup::NodePos Struct Reference}
\label{structCMarkup_1_1NodePos}\index{CMarkup::NodePos@{CMarkup::NodePos}}
{\tt \#include $<$Markup.h$>$}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item
{\bf NodePos} ()
\item
{\bf NodePos} (int n)
\end{CompactItemize}
\subsection*{Public Attributes}
\begin{CompactItemize}
\item
int {\bf nNodeType}
\item
int {\bf nStart}
\item
int {\bf nLength}
\item
int {\bf nNodeFlags}
\item
MCD\_\-STR {\bf strMeta}
\end{CompactItemize}
\subsection{Constructor \& Destructor Documentation}
\index{CMarkup::NodePos@{CMarkup::NodePos}!NodePos@{NodePos}}
\index{NodePos@{NodePos}!CMarkup::NodePos@{CMarkup::NodePos}}
\subsubsection[NodePos]{\setlength{\rightskip}{0pt plus 5cm}CMarkup::NodePos::NodePos ()\hspace{0.3cm}{\tt [inline]}}\label{structCMarkup_1_1NodePos_81589c934561c891174be880864053b6}
\index{CMarkup::NodePos@{CMarkup::NodePos}!NodePos@{NodePos}}
\index{NodePos@{NodePos}!CMarkup::NodePos@{CMarkup::NodePos}}
\subsubsection[NodePos]{\setlength{\rightskip}{0pt plus 5cm}CMarkup::NodePos::NodePos (int {\em n})\hspace{0.3cm}{\tt [inline]}}\label{structCMarkup_1_1NodePos_aaecb8354ffd5605e80432377fa2ac4c}
References nLength, nNodeFlags, nNodeType, and nStart.
\subsection{Member Data Documentation}
\index{CMarkup::NodePos@{CMarkup::NodePos}!nNodeType@{nNodeType}}
\index{nNodeType@{nNodeType}!CMarkup::NodePos@{CMarkup::NodePos}}
\subsubsection[nNodeType]{\setlength{\rightskip}{0pt plus 5cm}int {\bf CMarkup::NodePos::nNodeType}}\label{structCMarkup_1_1NodePos_09c12f805d9906e3805a6d76d9333740}
Referenced by NodePos().\index{CMarkup::NodePos@{CMarkup::NodePos}!nStart@{nStart}}
\index{nStart@{nStart}!CMarkup::NodePos@{CMarkup::NodePos}}
\subsubsection[nStart]{\setlength{\rightskip}{0pt plus 5cm}int {\bf CMarkup::NodePos::nStart}}\label{structCMarkup_1_1NodePos_c1939dd0ed1d2ecb35eb35bd2e88f69c}
Referenced by NodePos().\index{CMarkup::NodePos@{CMarkup::NodePos}!nLength@{nLength}}
\index{nLength@{nLength}!CMarkup::NodePos@{CMarkup::NodePos}}
\subsubsection[nLength]{\setlength{\rightskip}{0pt plus 5cm}int {\bf CMarkup::NodePos::nLength}}\label{structCMarkup_1_1NodePos_c2001e0315fb0cd1d038612e36d4b82e}
Referenced by NodePos().\index{CMarkup::NodePos@{CMarkup::NodePos}!nNodeFlags@{nNodeFlags}}
\index{nNodeFlags@{nNodeFlags}!CMarkup::NodePos@{CMarkup::NodePos}}
\subsubsection[nNodeFlags]{\setlength{\rightskip}{0pt plus 5cm}int {\bf CMarkup::NodePos::nNodeFlags}}\label{structCMarkup_1_1NodePos_dc46483d996c2a009779ea80bd123115}
Referenced by NodePos().\index{CMarkup::NodePos@{CMarkup::NodePos}!strMeta@{strMeta}}
\index{strMeta@{strMeta}!CMarkup::NodePos@{CMarkup::NodePos}}
\subsubsection[strMeta]{\setlength{\rightskip}{0pt plus 5cm}MCD\_\-STR {\bf CMarkup::NodePos::strMeta}}\label{structCMarkup_1_1NodePos_b9b37d8614b6980a935157199558c261}
The documentation for this struct was generated from the following file:\begin{CompactItemize}
\item
{\bf Markup.h}\end{CompactItemize}

View file

@ -0,0 +1,137 @@
\section{CMarkup::NodeStack Struct Reference}
\label{structCMarkup_1_1NodeStack}\index{CMarkup::NodeStack@{CMarkup::NodeStack}}
{\tt \#include $<$Markup.h$>$}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item
{\bf NodeStack} ()
\item
{\bf $\sim$NodeStack} ()
\item
{\bf NodePos} \& {\bf Top} ()
\item
{\bf NodePos} \& {\bf At} (int n)
\item
void {\bf Add} ()
\item
void {\bf Remove} ()
\item
int {\bf TopIndex} ()
\end{CompactItemize}
\subsection*{Protected Member Functions}
\begin{CompactItemize}
\item
void {\bf Alloc} (int nNewSize)
\item
void {\bf Copy} ({\bf NodePos} $\ast$pNNew)
\end{CompactItemize}
\subsection*{Protected Attributes}
\begin{CompactItemize}
\item
{\bf NodePos} $\ast$ {\bf pN}
\item
int {\bf nSize}
\item
int {\bf nTop}
\end{CompactItemize}
\subsection{Constructor \& Destructor Documentation}
\index{CMarkup::NodeStack@{CMarkup::NodeStack}!NodeStack@{NodeStack}}
\index{NodeStack@{NodeStack}!CMarkup::NodeStack@{CMarkup::NodeStack}}
\subsubsection[NodeStack]{\setlength{\rightskip}{0pt plus 5cm}CMarkup::NodeStack::NodeStack ()\hspace{0.3cm}{\tt [inline]}}\label{structCMarkup_1_1NodeStack_de0c540ed4a133345e7c8ec6e05b0b11}
References nSize, nTop, and pN.\index{CMarkup::NodeStack@{CMarkup::NodeStack}!$\sim$NodeStack@{$\sim$NodeStack}}
\index{$\sim$NodeStack@{$\sim$NodeStack}!CMarkup::NodeStack@{CMarkup::NodeStack}}
\subsubsection[$\sim$NodeStack]{\setlength{\rightskip}{0pt plus 5cm}CMarkup::NodeStack::$\sim$NodeStack ()\hspace{0.3cm}{\tt [inline]}}\label{structCMarkup_1_1NodeStack_6bd62bb0b4c4596016a00eade46cd5ca}
References pN.
\subsection{Member Function Documentation}
\index{CMarkup::NodeStack@{CMarkup::NodeStack}!Top@{Top}}
\index{Top@{Top}!CMarkup::NodeStack@{CMarkup::NodeStack}}
\subsubsection[Top]{\setlength{\rightskip}{0pt plus 5cm}{\bf NodePos}\& CMarkup::NodeStack::Top ()\hspace{0.3cm}{\tt [inline]}}\label{structCMarkup_1_1NodeStack_6be20984a9a499498312be0688c54bc5}
References nTop, and pN.\index{CMarkup::NodeStack@{CMarkup::NodeStack}!At@{At}}
\index{At@{At}!CMarkup::NodeStack@{CMarkup::NodeStack}}
\subsubsection[At]{\setlength{\rightskip}{0pt plus 5cm}{\bf NodePos}\& CMarkup::NodeStack::At (int {\em n})\hspace{0.3cm}{\tt [inline]}}\label{structCMarkup_1_1NodeStack_909848e1d3a591d21820d8ba4f03ee0d}
References pN.\index{CMarkup::NodeStack@{CMarkup::NodeStack}!Add@{Add}}
\index{Add@{Add}!CMarkup::NodeStack@{CMarkup::NodeStack}}
\subsubsection[Add]{\setlength{\rightskip}{0pt plus 5cm}void CMarkup::NodeStack::Add ()\hspace{0.3cm}{\tt [inline]}}\label{structCMarkup_1_1NodeStack_623cec96b6f3f3e246902d32f62244f8}
References Alloc(), nSize, and nTop.\index{CMarkup::NodeStack@{CMarkup::NodeStack}!Remove@{Remove}}
\index{Remove@{Remove}!CMarkup::NodeStack@{CMarkup::NodeStack}}
\subsubsection[Remove]{\setlength{\rightskip}{0pt plus 5cm}void CMarkup::NodeStack::Remove ()\hspace{0.3cm}{\tt [inline]}}\label{structCMarkup_1_1NodeStack_4782babbf126c3ff7d3568455e571282}
References nTop.\index{CMarkup::NodeStack@{CMarkup::NodeStack}!TopIndex@{TopIndex}}
\index{TopIndex@{TopIndex}!CMarkup::NodeStack@{CMarkup::NodeStack}}
\subsubsection[TopIndex]{\setlength{\rightskip}{0pt plus 5cm}int CMarkup::NodeStack::TopIndex ()\hspace{0.3cm}{\tt [inline]}}\label{structCMarkup_1_1NodeStack_4e9aad88e12b7bbabdbb3fd65fc51585}
References nTop.\index{CMarkup::NodeStack@{CMarkup::NodeStack}!Alloc@{Alloc}}
\index{Alloc@{Alloc}!CMarkup::NodeStack@{CMarkup::NodeStack}}
\subsubsection[Alloc]{\setlength{\rightskip}{0pt plus 5cm}void CMarkup::NodeStack::Alloc (int {\em nNewSize})\hspace{0.3cm}{\tt [inline, protected]}}\label{structCMarkup_1_1NodeStack_ac640e8a348792b4008057f02a3781ff}
References Copy(), and nSize.
Referenced by Add().\index{CMarkup::NodeStack@{CMarkup::NodeStack}!Copy@{Copy}}
\index{Copy@{Copy}!CMarkup::NodeStack@{CMarkup::NodeStack}}
\subsubsection[Copy]{\setlength{\rightskip}{0pt plus 5cm}void CMarkup::NodeStack::Copy ({\bf NodePos} $\ast$ {\em pNNew})\hspace{0.3cm}{\tt [inline, protected]}}\label{structCMarkup_1_1NodeStack_499a05e053b785df518fb0b6124fd0ee}
Referenced by Alloc().
\subsection{Member Data Documentation}
\index{CMarkup::NodeStack@{CMarkup::NodeStack}!pN@{pN}}
\index{pN@{pN}!CMarkup::NodeStack@{CMarkup::NodeStack}}
\subsubsection[pN]{\setlength{\rightskip}{0pt plus 5cm}{\bf NodePos}$\ast$ {\bf CMarkup::NodeStack::pN}\hspace{0.3cm}{\tt [protected]}}\label{structCMarkup_1_1NodeStack_636ddd56b9f0c53d1d8fb98d154b8ce3}
Referenced by At(), NodeStack(), Top(), and $\sim$NodeStack().\index{CMarkup::NodeStack@{CMarkup::NodeStack}!nSize@{nSize}}
\index{nSize@{nSize}!CMarkup::NodeStack@{CMarkup::NodeStack}}
\subsubsection[nSize]{\setlength{\rightskip}{0pt plus 5cm}int {\bf CMarkup::NodeStack::nSize}\hspace{0.3cm}{\tt [protected]}}\label{structCMarkup_1_1NodeStack_7031af9e6f3ceca049b5467b1fd7e478}
Referenced by Add(), Alloc(), and NodeStack().\index{CMarkup::NodeStack@{CMarkup::NodeStack}!nTop@{nTop}}
\index{nTop@{nTop}!CMarkup::NodeStack@{CMarkup::NodeStack}}
\subsubsection[nTop]{\setlength{\rightskip}{0pt plus 5cm}int {\bf CMarkup::NodeStack::nTop}\hspace{0.3cm}{\tt [protected]}}\label{structCMarkup_1_1NodeStack_f3e08fa5dce853a6267da9f77ef3f986}
Referenced by Add(), NodeStack(), Remove(), Top(), and TopIndex().
The documentation for this struct was generated from the following file:\begin{CompactItemize}
\item
{\bf Markup.h}\end{CompactItemize}

View file

@ -0,0 +1,152 @@
\section{CMarkup::PosArray Struct Reference}
\label{structCMarkup_1_1PosArray}\index{CMarkup::PosArray@{CMarkup::PosArray}}
{\tt \#include $<$Markup.h$>$}
\subsection*{Public Types}
\begin{CompactItemize}
\item
enum \{ {\bf PA\_\-SEGBITS} = 16,
{\bf PA\_\-SEGMASK} = 0xffff
\}
\end{CompactItemize}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item
{\bf PosArray} ()
\item
{\bf $\sim$PosArray} ()
\item
void {\bf RemoveAll} ()
\item
void {\bf Release} ()
\item
void {\bf Clear} ()
\item
int {\bf GetSize} () const
\item
int {\bf SegsUsed} () const
\item
{\bf ElemPos} \& {\bf operator[$\,$]} (int n) const
\end{CompactItemize}
\subsection*{Public Attributes}
\begin{CompactItemize}
\item
{\bf ElemPos} $\ast$$\ast$ {\bf pSegs}
\item
int {\bf nSize}
\item
int {\bf nSegs}
\end{CompactItemize}
\subsection{Member Enumeration Documentation}
\subsubsection["@1]{\setlength{\rightskip}{0pt plus 5cm}anonymous enum}\label{structCMarkup_1_1PosArray_af05e51d7ab82e581ed815b584e55b18}
\begin{Desc}
\item[Enumerator: ]\par
\begin{description}
\index{PA\_\-SEGBITS@{PA\_\-SEGBITS}!CMarkup::PosArray@{CMarkup::PosArray}}\index{CMarkup::PosArray@{CMarkup::PosArray}!PA\_\-SEGBITS@{PA\_\-SEGBITS}}\item[{\em
PA\_\-SEGBITS\label{structCMarkup_1_1PosArray_af05e51d7ab82e581ed815b584e55b18844e08ddf7ab861559a9b0096fb54a7e}
}]\index{PA\_\-SEGMASK@{PA\_\-SEGMASK}!CMarkup::PosArray@{CMarkup::PosArray}}\index{CMarkup::PosArray@{CMarkup::PosArray}!PA\_\-SEGMASK@{PA\_\-SEGMASK}}\item[{\em
PA\_\-SEGMASK\label{structCMarkup_1_1PosArray_af05e51d7ab82e581ed815b584e55b186165b6a4471f37709d3f9b0a9e86c38b}
}]\end{description}
\end{Desc}
\subsection{Constructor \& Destructor Documentation}
\index{CMarkup::PosArray@{CMarkup::PosArray}!PosArray@{PosArray}}
\index{PosArray@{PosArray}!CMarkup::PosArray@{CMarkup::PosArray}}
\subsubsection[PosArray]{\setlength{\rightskip}{0pt plus 5cm}CMarkup::PosArray::PosArray ()\hspace{0.3cm}{\tt [inline]}}\label{structCMarkup_1_1PosArray_f207a1d7e582779e134ea06fd1084b23}
References Clear().\index{CMarkup::PosArray@{CMarkup::PosArray}!$\sim$PosArray@{$\sim$PosArray}}
\index{$\sim$PosArray@{$\sim$PosArray}!CMarkup::PosArray@{CMarkup::PosArray}}
\subsubsection[$\sim$PosArray]{\setlength{\rightskip}{0pt plus 5cm}CMarkup::PosArray::$\sim$PosArray ()\hspace{0.3cm}{\tt [inline]}}\label{structCMarkup_1_1PosArray_9f26a70cee21e757fe372201c57fc117}
References Release().
\subsection{Member Function Documentation}
\index{CMarkup::PosArray@{CMarkup::PosArray}!RemoveAll@{RemoveAll}}
\index{RemoveAll@{RemoveAll}!CMarkup::PosArray@{CMarkup::PosArray}}
\subsubsection[RemoveAll]{\setlength{\rightskip}{0pt plus 5cm}void CMarkup::PosArray::RemoveAll ()\hspace{0.3cm}{\tt [inline]}}\label{structCMarkup_1_1PosArray_dad1d0185a26fad9bd391e3c85634103}
References Clear(), and Release().\index{CMarkup::PosArray@{CMarkup::PosArray}!Release@{Release}}
\index{Release@{Release}!CMarkup::PosArray@{CMarkup::PosArray}}
\subsubsection[Release]{\setlength{\rightskip}{0pt plus 5cm}void CMarkup::PosArray::Release ()\hspace{0.3cm}{\tt [inline]}}\label{structCMarkup_1_1PosArray_02ad3473569ecb5ba38b2327e30be38b}
References pSegs, and SegsUsed().
Referenced by RemoveAll(), and $\sim$PosArray().\index{CMarkup::PosArray@{CMarkup::PosArray}!Clear@{Clear}}
\index{Clear@{Clear}!CMarkup::PosArray@{CMarkup::PosArray}}
\subsubsection[Clear]{\setlength{\rightskip}{0pt plus 5cm}void CMarkup::PosArray::Clear ()\hspace{0.3cm}{\tt [inline]}}\label{structCMarkup_1_1PosArray_b87a18a088c434843048b9d0ecca05aa}
References nSegs, nSize, and pSegs.
Referenced by PosArray(), and RemoveAll().\index{CMarkup::PosArray@{CMarkup::PosArray}!GetSize@{GetSize}}
\index{GetSize@{GetSize}!CMarkup::PosArray@{CMarkup::PosArray}}
\subsubsection[GetSize]{\setlength{\rightskip}{0pt plus 5cm}int CMarkup::PosArray::GetSize () const\hspace{0.3cm}{\tt [inline]}}\label{structCMarkup_1_1PosArray_5da61b8563bfa2e82bf4c785bb166f62}
References nSize.
Referenced by CMarkup::x\_\-GetFreePos().\index{CMarkup::PosArray@{CMarkup::PosArray}!SegsUsed@{SegsUsed}}
\index{SegsUsed@{SegsUsed}!CMarkup::PosArray@{CMarkup::PosArray}}
\subsubsection[SegsUsed]{\setlength{\rightskip}{0pt plus 5cm}int CMarkup::PosArray::SegsUsed () const\hspace{0.3cm}{\tt [inline]}}\label{structCMarkup_1_1PosArray_0310976aa8e777cb84ab02ddbae8864c}
References nSize, and PA\_\-SEGBITS.
Referenced by Release().\index{CMarkup::PosArray@{CMarkup::PosArray}!operator[]@{operator[]}}
\index{operator[]@{operator[]}!CMarkup::PosArray@{CMarkup::PosArray}}
\subsubsection[operator[]]{\setlength{\rightskip}{0pt plus 5cm}{\bf ElemPos}\& CMarkup::PosArray::operator[$\,$] (int {\em n}) const\hspace{0.3cm}{\tt [inline]}}\label{structCMarkup_1_1PosArray_6317965f42dadc70f55c99b547e5d83d}
\subsection{Member Data Documentation}
\index{CMarkup::PosArray@{CMarkup::PosArray}!pSegs@{pSegs}}
\index{pSegs@{pSegs}!CMarkup::PosArray@{CMarkup::PosArray}}
\subsubsection[pSegs]{\setlength{\rightskip}{0pt plus 5cm}{\bf ElemPos}$\ast$$\ast$ {\bf CMarkup::PosArray::pSegs}}\label{structCMarkup_1_1PosArray_461f4252ee89f9cfd48d9e2c5ab64baf}
Referenced by Clear(), and Release().\index{CMarkup::PosArray@{CMarkup::PosArray}!nSize@{nSize}}
\index{nSize@{nSize}!CMarkup::PosArray@{CMarkup::PosArray}}
\subsubsection[nSize]{\setlength{\rightskip}{0pt plus 5cm}int {\bf CMarkup::PosArray::nSize}}\label{structCMarkup_1_1PosArray_f7a261e70c4060b8ef5070c0a5e12092}
Referenced by Clear(), GetSize(), and SegsUsed().\index{CMarkup::PosArray@{CMarkup::PosArray}!nSegs@{nSegs}}
\index{nSegs@{nSegs}!CMarkup::PosArray@{CMarkup::PosArray}}
\subsubsection[nSegs]{\setlength{\rightskip}{0pt plus 5cm}int {\bf CMarkup::PosArray::nSegs}}\label{structCMarkup_1_1PosArray_0994a05167565499a77d9d9d09711029}
Referenced by Clear().
The documentation for this struct was generated from the following file:\begin{CompactItemize}
\item
{\bf Markup.h}\end{CompactItemize}

View file

@ -0,0 +1,78 @@
\section{CMarkup::SavedPos Struct Reference}
\label{structCMarkup_1_1SavedPos}\index{CMarkup::SavedPos@{CMarkup::SavedPos}}
{\tt \#include $<$Markup.h$>$}
\subsection*{Public Types}
\begin{CompactItemize}
\item
enum \{ {\bf SPM\_\-MAIN} = 1,
{\bf SPM\_\-CHILD} = 2,
{\bf SPM\_\-USED} = 4,
{\bf SPM\_\-LAST} = 8
\}
\end{CompactItemize}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item
{\bf SavedPos} ()
\end{CompactItemize}
\subsection*{Public Attributes}
\begin{CompactItemize}
\item
MCD\_\-STR {\bf strName}
\item
int {\bf iPos}
\item
int {\bf nSavedPosFlags}
\end{CompactItemize}
\subsection{Member Enumeration Documentation}
\subsubsection["@0]{\setlength{\rightskip}{0pt plus 5cm}anonymous enum}\label{structCMarkup_1_1SavedPos_28ed16429117003133c33fa8fcaa7924}
\begin{Desc}
\item[Enumerator: ]\par
\begin{description}
\index{SPM\_\-MAIN@{SPM\_\-MAIN}!CMarkup::SavedPos@{CMarkup::SavedPos}}\index{CMarkup::SavedPos@{CMarkup::SavedPos}!SPM\_\-MAIN@{SPM\_\-MAIN}}\item[{\em
SPM\_\-MAIN\label{structCMarkup_1_1SavedPos_28ed16429117003133c33fa8fcaa7924ce631ba78506ef55979fb730b54ae8f3}
}]\index{SPM\_\-CHILD@{SPM\_\-CHILD}!CMarkup::SavedPos@{CMarkup::SavedPos}}\index{CMarkup::SavedPos@{CMarkup::SavedPos}!SPM\_\-CHILD@{SPM\_\-CHILD}}\item[{\em
SPM\_\-CHILD\label{structCMarkup_1_1SavedPos_28ed16429117003133c33fa8fcaa792437b333ca861ee132a96570e3261ed48f}
}]\index{SPM\_\-USED@{SPM\_\-USED}!CMarkup::SavedPos@{CMarkup::SavedPos}}\index{CMarkup::SavedPos@{CMarkup::SavedPos}!SPM\_\-USED@{SPM\_\-USED}}\item[{\em
SPM\_\-USED\label{structCMarkup_1_1SavedPos_28ed16429117003133c33fa8fcaa7924bc202c266163ba746501ff656c189bf3}
}]\index{SPM\_\-LAST@{SPM\_\-LAST}!CMarkup::SavedPos@{CMarkup::SavedPos}}\index{CMarkup::SavedPos@{CMarkup::SavedPos}!SPM\_\-LAST@{SPM\_\-LAST}}\item[{\em
SPM\_\-LAST\label{structCMarkup_1_1SavedPos_28ed16429117003133c33fa8fcaa7924147badf6cfd07fa7a92ba92a43df245f}
}]\end{description}
\end{Desc}
\subsection{Constructor \& Destructor Documentation}
\index{CMarkup::SavedPos@{CMarkup::SavedPos}!SavedPos@{SavedPos}}
\index{SavedPos@{SavedPos}!CMarkup::SavedPos@{CMarkup::SavedPos}}
\subsubsection[SavedPos]{\setlength{\rightskip}{0pt plus 5cm}CMarkup::SavedPos::SavedPos ()\hspace{0.3cm}{\tt [inline]}}\label{structCMarkup_1_1SavedPos_203b3a22eb86b1131985a6631e3d3c47}
\subsection{Member Data Documentation}
\index{CMarkup::SavedPos@{CMarkup::SavedPos}!strName@{strName}}
\index{strName@{strName}!CMarkup::SavedPos@{CMarkup::SavedPos}}
\subsubsection[strName]{\setlength{\rightskip}{0pt plus 5cm}MCD\_\-STR {\bf CMarkup::SavedPos::strName}}\label{structCMarkup_1_1SavedPos_3613f5e8854f961ed02173d22099db4c}
\index{CMarkup::SavedPos@{CMarkup::SavedPos}!iPos@{iPos}}
\index{iPos@{iPos}!CMarkup::SavedPos@{CMarkup::SavedPos}}
\subsubsection[iPos]{\setlength{\rightskip}{0pt plus 5cm}int {\bf CMarkup::SavedPos::iPos}}\label{structCMarkup_1_1SavedPos_649563d0d7c11bf2fdebbc0dbe396321}
\index{CMarkup::SavedPos@{CMarkup::SavedPos}!nSavedPosFlags@{nSavedPosFlags}}
\index{nSavedPosFlags@{nSavedPosFlags}!CMarkup::SavedPos@{CMarkup::SavedPos}}
\subsubsection[nSavedPosFlags]{\setlength{\rightskip}{0pt plus 5cm}int {\bf CMarkup::SavedPos::nSavedPosFlags}}\label{structCMarkup_1_1SavedPos_66a572e011303ea2a3716f7328ad9ec5}
The documentation for this struct was generated from the following file:\begin{CompactItemize}
\item
{\bf Markup.h}\end{CompactItemize}

View file

@ -0,0 +1,57 @@
\section{CMarkup::SavedPosMap Struct Reference}
\label{structCMarkup_1_1SavedPosMap}\index{CMarkup::SavedPosMap@{CMarkup::SavedPosMap}}
{\tt \#include $<$Markup.h$>$}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item
{\bf SavedPosMap} (int nSize)
\item
{\bf $\sim$SavedPosMap} ()
\end{CompactItemize}
\subsection*{Public Attributes}
\begin{CompactItemize}
\item
{\bf SavedPos} $\ast$$\ast$ {\bf pTable}
\item
int {\bf nMapSize}
\end{CompactItemize}
\subsection{Constructor \& Destructor Documentation}
\index{CMarkup::SavedPosMap@{CMarkup::SavedPosMap}!SavedPosMap@{SavedPosMap}}
\index{SavedPosMap@{SavedPosMap}!CMarkup::SavedPosMap@{CMarkup::SavedPosMap}}
\subsubsection[SavedPosMap]{\setlength{\rightskip}{0pt plus 5cm}CMarkup::SavedPosMap::SavedPosMap (int {\em nSize})\hspace{0.3cm}{\tt [inline]}}\label{structCMarkup_1_1SavedPosMap_681e409f964bbd86a088358dffaeb808}
References nMapSize, and pTable.\index{CMarkup::SavedPosMap@{CMarkup::SavedPosMap}!$\sim$SavedPosMap@{$\sim$SavedPosMap}}
\index{$\sim$SavedPosMap@{$\sim$SavedPosMap}!CMarkup::SavedPosMap@{CMarkup::SavedPosMap}}
\subsubsection[$\sim$SavedPosMap]{\setlength{\rightskip}{0pt plus 5cm}CMarkup::SavedPosMap::$\sim$SavedPosMap ()\hspace{0.3cm}{\tt [inline]}}\label{structCMarkup_1_1SavedPosMap_b3a7ef305893ba4b6752dea003997c96}
References nMapSize, and pTable.
\subsection{Member Data Documentation}
\index{CMarkup::SavedPosMap@{CMarkup::SavedPosMap}!pTable@{pTable}}
\index{pTable@{pTable}!CMarkup::SavedPosMap@{CMarkup::SavedPosMap}}
\subsubsection[pTable]{\setlength{\rightskip}{0pt plus 5cm}{\bf SavedPos}$\ast$$\ast$ {\bf CMarkup::SavedPosMap::pTable}}\label{structCMarkup_1_1SavedPosMap_8ebb44e96f6781e5d1d044a18a3d989d}
Referenced by SavedPosMap(), and $\sim$SavedPosMap().\index{CMarkup::SavedPosMap@{CMarkup::SavedPosMap}!nMapSize@{nMapSize}}
\index{nMapSize@{nMapSize}!CMarkup::SavedPosMap@{CMarkup::SavedPosMap}}
\subsubsection[nMapSize]{\setlength{\rightskip}{0pt plus 5cm}int {\bf CMarkup::SavedPosMap::nMapSize}}\label{structCMarkup_1_1SavedPosMap_b5b1c02cb1321c0f1007dc3cd01a34c7}
Referenced by SavedPosMap(), and $\sim$SavedPosMap().
The documentation for this struct was generated from the following file:\begin{CompactItemize}
\item
{\bf Markup.h}\end{CompactItemize}

View file

@ -0,0 +1,62 @@
\section{CMarkup::SavedPosMapArray Struct Reference}
\label{structCMarkup_1_1SavedPosMapArray}\index{CMarkup::SavedPosMapArray@{CMarkup::SavedPosMapArray}}
{\tt \#include $<$Markup.h$>$}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item
{\bf SavedPosMapArray} ()
\item
{\bf $\sim$SavedPosMapArray} ()
\item
void {\bf RemoveAll} ()
\end{CompactItemize}
\subsection*{Public Attributes}
\begin{CompactItemize}
\item
{\bf SavedPosMap} $\ast$$\ast$ {\bf pMaps}
\end{CompactItemize}
\subsection{Constructor \& Destructor Documentation}
\index{CMarkup::SavedPosMapArray@{CMarkup::SavedPosMapArray}!SavedPosMapArray@{SavedPosMapArray}}
\index{SavedPosMapArray@{SavedPosMapArray}!CMarkup::SavedPosMapArray@{CMarkup::SavedPosMapArray}}
\subsubsection[SavedPosMapArray]{\setlength{\rightskip}{0pt plus 5cm}CMarkup::SavedPosMapArray::SavedPosMapArray ()\hspace{0.3cm}{\tt [inline]}}\label{structCMarkup_1_1SavedPosMapArray_0fca988b3417d41ccf3e2b3e8fef7483}
References pMaps.\index{CMarkup::SavedPosMapArray@{CMarkup::SavedPosMapArray}!$\sim$SavedPosMapArray@{$\sim$SavedPosMapArray}}
\index{$\sim$SavedPosMapArray@{$\sim$SavedPosMapArray}!CMarkup::SavedPosMapArray@{CMarkup::SavedPosMapArray}}
\subsubsection[$\sim$SavedPosMapArray]{\setlength{\rightskip}{0pt plus 5cm}CMarkup::SavedPosMapArray::$\sim$SavedPosMapArray ()\hspace{0.3cm}{\tt [inline]}}\label{structCMarkup_1_1SavedPosMapArray_6be57f9ebe160aebb464957caa30ddd6}
References RemoveAll().
\subsection{Member Function Documentation}
\index{CMarkup::SavedPosMapArray@{CMarkup::SavedPosMapArray}!RemoveAll@{RemoveAll}}
\index{RemoveAll@{RemoveAll}!CMarkup::SavedPosMapArray@{CMarkup::SavedPosMapArray}}
\subsubsection[RemoveAll]{\setlength{\rightskip}{0pt plus 5cm}void CMarkup::SavedPosMapArray::RemoveAll ()\hspace{0.3cm}{\tt [inline]}}\label{structCMarkup_1_1SavedPosMapArray_a6db2f1af7ecae5af27aab25e399b94c}
References pMaps.
Referenced by $\sim$SavedPosMapArray().
\subsection{Member Data Documentation}
\index{CMarkup::SavedPosMapArray@{CMarkup::SavedPosMapArray}!pMaps@{pMaps}}
\index{pMaps@{pMaps}!CMarkup::SavedPosMapArray@{CMarkup::SavedPosMapArray}}
\subsubsection[pMaps]{\setlength{\rightskip}{0pt plus 5cm}{\bf SavedPosMap}$\ast$$\ast$ {\bf CMarkup::SavedPosMapArray::pMaps}}\label{structCMarkup_1_1SavedPosMapArray_719491211d9de2fe06bfadc9a37daf46}
Referenced by RemoveAll(), and SavedPosMapArray().
The documentation for this struct was generated from the following file:\begin{CompactItemize}
\item
{\bf Markup.h}\end{CompactItemize}

View file

@ -0,0 +1,132 @@
\section{CMarkup::TokenPos Struct Reference}
\label{structCMarkup_1_1TokenPos}\index{CMarkup::TokenPos@{CMarkup::TokenPos}}
{\tt \#include $<$Markup.h$>$}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item
{\bf TokenPos} ({\bf MCD\_\-CSTR} sz, int n)
\item
void {\bf Clear} ()
\item
int {\bf Length} () const
\item
int {\bf StrNIACmp} (MCD\_\-PCSZ p1, MCD\_\-PCSZ p2, int n)
\item
bool {\bf Match} ({\bf MCD\_\-CSTR} szName)
\end{CompactItemize}
\subsection*{Public Attributes}
\begin{CompactItemize}
\item
int {\bf nL}
\item
int {\bf nR}
\item
int {\bf nNext}
\item
MCD\_\-PCSZ {\bf pDoc}
\item
int {\bf nTokenFlags}
\item
int {\bf nPreSpaceStart}
\item
int {\bf nPreSpaceLength}
\end{CompactItemize}
\subsection{Constructor \& Destructor Documentation}
\index{CMarkup::TokenPos@{CMarkup::TokenPos}!TokenPos@{TokenPos}}
\index{TokenPos@{TokenPos}!CMarkup::TokenPos@{CMarkup::TokenPos}}
\subsubsection[TokenPos]{\setlength{\rightskip}{0pt plus 5cm}CMarkup::TokenPos::TokenPos ({\bf MCD\_\-CSTR} {\em sz}, \/ int {\em n})\hspace{0.3cm}{\tt [inline]}}\label{structCMarkup_1_1TokenPos_797a3f5d9664c52971cf210166c3636a}
References Clear(), nTokenFlags, and pDoc.
\subsection{Member Function Documentation}
\index{CMarkup::TokenPos@{CMarkup::TokenPos}!Clear@{Clear}}
\index{Clear@{Clear}!CMarkup::TokenPos@{CMarkup::TokenPos}}
\subsubsection[Clear]{\setlength{\rightskip}{0pt plus 5cm}void CMarkup::TokenPos::Clear ()\hspace{0.3cm}{\tt [inline]}}\label{structCMarkup_1_1TokenPos_cb390ed8ab1226cbd8c9b9a19088d55c}
References nL, nNext, and nR.
Referenced by TokenPos().\index{CMarkup::TokenPos@{CMarkup::TokenPos}!Length@{Length}}
\index{Length@{Length}!CMarkup::TokenPos@{CMarkup::TokenPos}}
\subsubsection[Length]{\setlength{\rightskip}{0pt plus 5cm}int CMarkup::TokenPos::Length () const\hspace{0.3cm}{\tt [inline]}}\label{structCMarkup_1_1TokenPos_b033dc8e88a8f83748ff6c44df05bb04}
References nL, and nR.\index{CMarkup::TokenPos@{CMarkup::TokenPos}!StrNIACmp@{StrNIACmp}}
\index{StrNIACmp@{StrNIACmp}!CMarkup::TokenPos@{CMarkup::TokenPos}}
\subsubsection[StrNIACmp]{\setlength{\rightskip}{0pt plus 5cm}int CMarkup::TokenPos::StrNIACmp (MCD\_\-PCSZ {\em p1}, \/ MCD\_\-PCSZ {\em p2}, \/ int {\em n})\hspace{0.3cm}{\tt [inline]}}\label{structCMarkup_1_1TokenPos_c3a37f7294cd763aed0f37749095d3db}
References MCD\_\-CHAR.
Referenced by Match().\index{CMarkup::TokenPos@{CMarkup::TokenPos}!Match@{Match}}
\index{Match@{Match}!CMarkup::TokenPos@{CMarkup::TokenPos}}
\subsubsection[Match]{\setlength{\rightskip}{0pt plus 5cm}bool CMarkup::TokenPos::Match ({\bf MCD\_\-CSTR} {\em szName})\hspace{0.3cm}{\tt [inline]}}\label{structCMarkup_1_1TokenPos_199e0772dc846b95670797f0a32ec9ab}
References MCD\_\-PSZCHR, MCD\_\-PSZNCMP, MCD\_\-T, CMarkup::MDF\_\-IGNORECASE, nL, nR, nTokenFlags, pDoc, and StrNIACmp().
\subsection{Member Data Documentation}
\index{CMarkup::TokenPos@{CMarkup::TokenPos}!nL@{nL}}
\index{nL@{nL}!CMarkup::TokenPos@{CMarkup::TokenPos}}
\subsubsection[nL]{\setlength{\rightskip}{0pt plus 5cm}int {\bf CMarkup::TokenPos::nL}}\label{structCMarkup_1_1TokenPos_c4c71680b3f09845b5346bf1285a214f}
Referenced by Clear(), Length(), and Match().\index{CMarkup::TokenPos@{CMarkup::TokenPos}!nR@{nR}}
\index{nR@{nR}!CMarkup::TokenPos@{CMarkup::TokenPos}}
\subsubsection[nR]{\setlength{\rightskip}{0pt plus 5cm}int {\bf CMarkup::TokenPos::nR}}\label{structCMarkup_1_1TokenPos_fb58afc56664b9646fc79b9ec2a51b10}
Referenced by Clear(), Length(), and Match().\index{CMarkup::TokenPos@{CMarkup::TokenPos}!nNext@{nNext}}
\index{nNext@{nNext}!CMarkup::TokenPos@{CMarkup::TokenPos}}
\subsubsection[nNext]{\setlength{\rightskip}{0pt plus 5cm}int {\bf CMarkup::TokenPos::nNext}}\label{structCMarkup_1_1TokenPos_72b20974f7b55aa5d804a769f8a3f985}
Referenced by Clear().\index{CMarkup::TokenPos@{CMarkup::TokenPos}!pDoc@{pDoc}}
\index{pDoc@{pDoc}!CMarkup::TokenPos@{CMarkup::TokenPos}}
\subsubsection[pDoc]{\setlength{\rightskip}{0pt plus 5cm}MCD\_\-PCSZ {\bf CMarkup::TokenPos::pDoc}}\label{structCMarkup_1_1TokenPos_90a1052c162afcd07fc3974b95888a7e}
Referenced by Match(), and TokenPos().\index{CMarkup::TokenPos@{CMarkup::TokenPos}!nTokenFlags@{nTokenFlags}}
\index{nTokenFlags@{nTokenFlags}!CMarkup::TokenPos@{CMarkup::TokenPos}}
\subsubsection[nTokenFlags]{\setlength{\rightskip}{0pt plus 5cm}int {\bf CMarkup::TokenPos::nTokenFlags}}\label{structCMarkup_1_1TokenPos_8eb640fe33ed145eb078e8214c0ea62b}
Referenced by Match(), and TokenPos().\index{CMarkup::TokenPos@{CMarkup::TokenPos}!nPreSpaceStart@{nPreSpaceStart}}
\index{nPreSpaceStart@{nPreSpaceStart}!CMarkup::TokenPos@{CMarkup::TokenPos}}
\subsubsection[nPreSpaceStart]{\setlength{\rightskip}{0pt plus 5cm}int {\bf CMarkup::TokenPos::nPreSpaceStart}}\label{structCMarkup_1_1TokenPos_2d81fc5b589c491b450f73167ed9993d}
\index{CMarkup::TokenPos@{CMarkup::TokenPos}!nPreSpaceLength@{nPreSpaceLength}}
\index{nPreSpaceLength@{nPreSpaceLength}!CMarkup::TokenPos@{CMarkup::TokenPos}}
\subsubsection[nPreSpaceLength]{\setlength{\rightskip}{0pt plus 5cm}int {\bf CMarkup::TokenPos::nPreSpaceLength}}\label{structCMarkup_1_1TokenPos_455b67b62cfd4d6f6ffafc7b8bbc9971}
The documentation for this struct was generated from the following file:\begin{CompactItemize}
\item
{\bf Markup.h}\end{CompactItemize}

View file

@ -0,0 +1,67 @@
\section{MCD\_\-CSTR Struct Reference}
\label{structMCD__CSTR}\index{MCD\_\-CSTR@{MCD\_\-CSTR}}
{\tt \#include $<$Markup.h$>$}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item
{\bf MCD\_\-CSTR} ()
\item
{\bf MCD\_\-CSTR} (MCD\_\-PCSZ p)
\item
{\bf MCD\_\-CSTR} (const MCD\_\-STR \&s)
\item
{\bf operator MCD\_\-PCSZ} () const
\end{CompactItemize}
\subsection*{Public Attributes}
\begin{CompactItemize}
\item
MCD\_\-PCSZ {\bf pcsz}
\end{CompactItemize}
\subsection{Constructor \& Destructor Documentation}
\index{MCD\_\-CSTR@{MCD\_\-CSTR}!MCD\_\-CSTR@{MCD\_\-CSTR}}
\index{MCD\_\-CSTR@{MCD\_\-CSTR}!MCD_CSTR@{MCD\_\-CSTR}}
\subsubsection[MCD\_\-CSTR]{\setlength{\rightskip}{0pt plus 5cm}MCD\_\-CSTR::MCD\_\-CSTR ()\hspace{0.3cm}{\tt [inline]}}\label{structMCD__CSTR_527942329419b01535431646e136eaa1}
References pcsz.\index{MCD\_\-CSTR@{MCD\_\-CSTR}!MCD\_\-CSTR@{MCD\_\-CSTR}}
\index{MCD\_\-CSTR@{MCD\_\-CSTR}!MCD_CSTR@{MCD\_\-CSTR}}
\subsubsection[MCD\_\-CSTR]{\setlength{\rightskip}{0pt plus 5cm}MCD\_\-CSTR::MCD\_\-CSTR (MCD\_\-PCSZ {\em p})\hspace{0.3cm}{\tt [inline]}}\label{structMCD__CSTR_f0cb7482427cfab856ee18c8ac50e5fa}
References pcsz.\index{MCD\_\-CSTR@{MCD\_\-CSTR}!MCD\_\-CSTR@{MCD\_\-CSTR}}
\index{MCD\_\-CSTR@{MCD\_\-CSTR}!MCD_CSTR@{MCD\_\-CSTR}}
\subsubsection[MCD\_\-CSTR]{\setlength{\rightskip}{0pt plus 5cm}MCD\_\-CSTR::MCD\_\-CSTR (const MCD\_\-STR \& {\em s})\hspace{0.3cm}{\tt [inline]}}\label{structMCD__CSTR_dc766d196d878fa2eccad9843463508b}
References MCD\_\-2PCSZ, and pcsz.
\subsection{Member Function Documentation}
\index{MCD\_\-CSTR@{MCD\_\-CSTR}!operator MCD\_\-PCSZ@{operator MCD\_\-PCSZ}}
\index{operator MCD\_\-PCSZ@{operator MCD\_\-PCSZ}!MCD_CSTR@{MCD\_\-CSTR}}
\subsubsection[operator MCD\_\-PCSZ]{\setlength{\rightskip}{0pt plus 5cm}MCD\_\-CSTR::operator MCD\_\-PCSZ () const\hspace{0.3cm}{\tt [inline]}}\label{structMCD__CSTR_69c3b0c4b7d049b0eaadcc5822f647ac}
\subsection{Member Data Documentation}
\index{MCD\_\-CSTR@{MCD\_\-CSTR}!pcsz@{pcsz}}
\index{pcsz@{pcsz}!MCD_CSTR@{MCD\_\-CSTR}}
\subsubsection[pcsz]{\setlength{\rightskip}{0pt plus 5cm}MCD\_\-PCSZ {\bf MCD\_\-CSTR::pcsz}}\label{structMCD__CSTR_98868bd66f13bc4be31eab000d45335e}
Referenced by MCD\_\-CSTR().
The documentation for this struct was generated from the following file:\begin{CompactItemize}
\item
{\bf Markup.h}\end{CompactItemize}

View file

@ -0,0 +1,57 @@
\section{neuralpp::netrecord Struct Reference}
\label{structneuralpp_1_1netrecord}\index{neuralpp::netrecord@{neuralpp::netrecord}}
{\tt \#include $<$neural++.hpp$>$}
\subsection*{Public Attributes}
\begin{CompactItemize}
\item
int {\bf input\_\-size}
\item
int {\bf hidden\_\-size}
\item
int {\bf output\_\-size}
\item
int {\bf epochs}
\item
double {\bf l\_\-rate}
\item
double {\bf ex}
\end{CompactItemize}
\subsection{Member Data Documentation}
\index{neuralpp::netrecord@{neuralpp::netrecord}!input\_\-size@{input\_\-size}}
\index{input\_\-size@{input\_\-size}!neuralpp::netrecord@{neuralpp::netrecord}}
\subsubsection[input\_\-size]{\setlength{\rightskip}{0pt plus 5cm}int {\bf neuralpp::netrecord::input\_\-size}}\label{structneuralpp_1_1netrecord_e1f480bfef05033accef40f77c09fa87}
\index{neuralpp::netrecord@{neuralpp::netrecord}!hidden\_\-size@{hidden\_\-size}}
\index{hidden\_\-size@{hidden\_\-size}!neuralpp::netrecord@{neuralpp::netrecord}}
\subsubsection[hidden\_\-size]{\setlength{\rightskip}{0pt plus 5cm}int {\bf neuralpp::netrecord::hidden\_\-size}}\label{structneuralpp_1_1netrecord_3c1728ac66c37f6ac85c404d4f55552e}
\index{neuralpp::netrecord@{neuralpp::netrecord}!output\_\-size@{output\_\-size}}
\index{output\_\-size@{output\_\-size}!neuralpp::netrecord@{neuralpp::netrecord}}
\subsubsection[output\_\-size]{\setlength{\rightskip}{0pt plus 5cm}int {\bf neuralpp::netrecord::output\_\-size}}\label{structneuralpp_1_1netrecord_95f2b0651dd3a0e5e7201ff354e401b4}
\index{neuralpp::netrecord@{neuralpp::netrecord}!epochs@{epochs}}
\index{epochs@{epochs}!neuralpp::netrecord@{neuralpp::netrecord}}
\subsubsection[epochs]{\setlength{\rightskip}{0pt plus 5cm}int {\bf neuralpp::netrecord::epochs}}\label{structneuralpp_1_1netrecord_ab0149ed5ea0694e88213a07cd4427d1}
\index{neuralpp::netrecord@{neuralpp::netrecord}!l\_\-rate@{l\_\-rate}}
\index{l\_\-rate@{l\_\-rate}!neuralpp::netrecord@{neuralpp::netrecord}}
\subsubsection[l\_\-rate]{\setlength{\rightskip}{0pt plus 5cm}double {\bf neuralpp::netrecord::l\_\-rate}}\label{structneuralpp_1_1netrecord_a4f793a39a40144e811fef4d3d2d2b30}
\index{neuralpp::netrecord@{neuralpp::netrecord}!ex@{ex}}
\index{ex@{ex}!neuralpp::netrecord@{neuralpp::netrecord}}
\subsubsection[ex]{\setlength{\rightskip}{0pt plus 5cm}double {\bf neuralpp::netrecord::ex}}\label{structneuralpp_1_1netrecord_dcc44fde3f67058d26ef2d5cbd0904e6}
The documentation for this struct was generated from the following file:\begin{CompactItemize}
\item
{\bf neural++.hpp}\end{CompactItemize}

View file

@ -0,0 +1,29 @@
\section{neuralpp::neuronrecord Struct Reference}
\label{structneuralpp_1_1neuronrecord}\index{neuralpp::neuronrecord@{neuralpp::neuronrecord}}
{\tt \#include $<$neural++.hpp$>$}
\subsection*{Public Attributes}
\begin{CompactItemize}
\item
double {\bf prop}
\item
double {\bf actv}
\end{CompactItemize}
\subsection{Member Data Documentation}
\index{neuralpp::neuronrecord@{neuralpp::neuronrecord}!prop@{prop}}
\index{prop@{prop}!neuralpp::neuronrecord@{neuralpp::neuronrecord}}
\subsubsection[prop]{\setlength{\rightskip}{0pt plus 5cm}double {\bf neuralpp::neuronrecord::prop}}\label{structneuralpp_1_1neuronrecord_30b298a95939b88b565fefc2dc57e89d}
\index{neuralpp::neuronrecord@{neuralpp::neuronrecord}!actv@{actv}}
\index{actv@{actv}!neuralpp::neuronrecord@{neuralpp::neuronrecord}}
\subsubsection[actv]{\setlength{\rightskip}{0pt plus 5cm}double {\bf neuralpp::neuronrecord::actv}}\label{structneuralpp_1_1neuronrecord_15201b190584987255d81d4b7e773375}
The documentation for this struct was generated from the following file:\begin{CompactItemize}
\item
{\bf neural++.hpp}\end{CompactItemize}

View file

@ -0,0 +1,29 @@
\section{neuralpp::synrecord Struct Reference}
\label{structneuralpp_1_1synrecord}\index{neuralpp::synrecord@{neuralpp::synrecord}}
{\tt \#include $<$neural++.hpp$>$}
\subsection*{Public Attributes}
\begin{CompactItemize}
\item
double {\bf w}
\item
double {\bf d}
\end{CompactItemize}
\subsection{Member Data Documentation}
\index{neuralpp::synrecord@{neuralpp::synrecord}!w@{w}}
\index{w@{w}!neuralpp::synrecord@{neuralpp::synrecord}}
\subsubsection[w]{\setlength{\rightskip}{0pt plus 5cm}double {\bf neuralpp::synrecord::w}}\label{structneuralpp_1_1synrecord_81a7dbc97eecbf5bc85cac46373a78d2}
\index{neuralpp::synrecord@{neuralpp::synrecord}!d@{d}}
\index{d@{d}!neuralpp::synrecord@{neuralpp::synrecord}}
\subsubsection[d]{\setlength{\rightskip}{0pt plus 5cm}double {\bf neuralpp::synrecord::d}}\label{structneuralpp_1_1synrecord_3a862082dfa0edffce84936818bab374}
The documentation for this struct was generated from the following file:\begin{CompactItemize}
\item
{\bf neural++.hpp}\end{CompactItemize}