diff options
Diffstat (limited to 'doc/latex/classmeow_1_1Vector.tex')
-rw-r--r-- | doc/latex/classmeow_1_1Vector.tex | 68 |
1 files changed, 37 insertions, 31 deletions
diff --git a/doc/latex/classmeow_1_1Vector.tex b/doc/latex/classmeow_1_1Vector.tex index e2abffd..8654438 100644 --- a/doc/latex/classmeow_1_1Vector.tex +++ b/doc/latex/classmeow_1_1Vector.tex @@ -10,6 +10,13 @@ {\ttfamily \#include \char`\"{}Vector.\-h\char`\"{}} +\subsection*{Public Types} +\begin{DoxyCompactItemize} +\item +typedef \hyperlink{classmeow_1_1Matrix}{Matrix}$<$ Scalar $>$\-::Entry\-Ref\-K \hyperlink{classmeow_1_1Vector_ac7464dd163607b1a6417e438a639d050}{Scalar\-Ref\-K} +\item +typedef \hyperlink{classmeow_1_1Matrix}{Matrix}$<$ Scalar $>$\-::Entry\-Ref \hyperlink{classmeow_1_1Vector_a29e75e2dd5e46da4c7b95354c8787a30}{Scalar\-Ref} +\end{DoxyCompactItemize} \subsection*{Public Member Functions} \begin{DoxyCompactItemize} \item @@ -19,8 +26,6 @@ \begin{DoxyCompactList}\small\item\em constructor \end{DoxyCompactList}\item \hyperlink{classmeow_1_1Vector_a34ca34c834e47288894cec2445e5b073}{Vector} (\hyperlink{classmeow_1_1Matrix}{Matrix}$<$ Scalar $>$ const \&m) \begin{DoxyCompactList}\small\item\em constructor \end{DoxyCompactList}\item -\hyperlink{classmeow_1_1Vector_af4966b6e2df19fa6d2752460b1e8afff}{Vector} (\hyperlink{classmeow_1_1Matrix}{Matrix}$<$ Scalar $>$ const \&m, size\-\_\-t i) -\begin{DoxyCompactList}\small\item\em constructor \end{DoxyCompactList}\item \hyperlink{classmeow_1_1Vector_a58f997cdc6b98a76ae13bba6d685d815}{Vector} (std\-::vector$<$ Scalar $>$ const \&v) \begin{DoxyCompactList}\small\item\em constructor \end{DoxyCompactList}\item \hyperlink{classmeow_1_1Vector_a5589e07881f9f6a7bb7c43630d30ecdd}{Vector} (size\-\_\-t d, Scalar const \&e) @@ -39,10 +44,12 @@ size\-\_\-t \hyperlink{classmeow_1_1Vector_ada37bc2df18e7c892d4b5e2ac34bf025}{di \begin{DoxyCompactList}\small\item\em resize the dimension \end{DoxyCompactList}\item bool \hyperlink{classmeow_1_1Vector_a98f150719042e458d52a1476ae9fd52e}{valid} () const \begin{DoxyCompactList}\small\item\em Return whether {\ttfamily dimension$>$0} is true or not. \end{DoxyCompactList}\item -Scalar \hyperlink{classmeow_1_1Vector_af5ecb8d9cc811a2d56e1725c4bfd30e8}{entry} (size\-\_\-t i) const +\hyperlink{classmeow_1_1Vector_ac7464dd163607b1a6417e438a639d050}{Scalar\-Ref\-K} \hyperlink{classmeow_1_1Vector_a2413f452c3d8b76208d99f7256c9ade8}{entry} (size\-\_\-t i) const \begin{DoxyCompactList}\small\item\em return {\itshape i} -\/th entry \end{DoxyCompactList}\item -Scalar \hyperlink{classmeow_1_1Vector_a5050e9117204a6dbdcc7cf5038845c00}{entry} (size\-\_\-t i, Scalar const \&s) +\hyperlink{classmeow_1_1Vector_ac7464dd163607b1a6417e438a639d050}{Scalar\-Ref\-K} \hyperlink{classmeow_1_1Vector_ab0a1b850f2db26637b88900ba2e1911a}{entry} (size\-\_\-t i, Scalar const \&s) \begin{DoxyCompactList}\small\item\em change {\itshape i} -\/th entry \end{DoxyCompactList}\item +\hyperlink{classmeow_1_1Vector_a29e75e2dd5e46da4c7b95354c8787a30}{Scalar\-Ref} \hyperlink{classmeow_1_1Vector_a35b4e136e93445279372f70e4caf00fe}{entry\-Get} (size\-\_\-t i) +\begin{DoxyCompactList}\small\item\em return {\itshape i} -\/th entry with non-\/constant type \end{DoxyCompactList}\item void \hyperlink{classmeow_1_1Vector_adc55ef7402cf4114ea5696df18545618}{entries} (size\-\_\-t i, size\-\_\-t j, Scalar const \&s) \begin{DoxyCompactList}\small\item\em change {\itshape i} -\/th to {\itshape j} -\/th entries \end{DoxyCompactList}\item \hyperlink{classmeow_1_1Vector}{Vector} \hyperlink{classmeow_1_1Vector_a70c2620d25f6a36dc6d6aa38851b1c7a}{sub\-Vector} (size\-\_\-t i, size\-\_\-t j) @@ -99,6 +106,15 @@ cat\-\_\-leopard \end{DoxyAuthor} +\subsection{Member Typedef Documentation} +\hypertarget{classmeow_1_1Vector_a29e75e2dd5e46da4c7b95354c8787a30}{\index{meow\-::\-Vector@{meow\-::\-Vector}!Scalar\-Ref@{Scalar\-Ref}} +\index{Scalar\-Ref@{Scalar\-Ref}!meow::Vector@{meow\-::\-Vector}} +\subsubsection[{Scalar\-Ref}]{\setlength{\rightskip}{0pt plus 5cm}template$<$class Scalar$>$ typedef {\bf Matrix}$<$Scalar$>$\-::Entry\-Ref {\bf meow\-::\-Vector}$<$ Scalar $>$\-::{\bf Scalar\-Ref}}}\label{classmeow_1_1Vector_a29e75e2dd5e46da4c7b95354c8787a30} +\hypertarget{classmeow_1_1Vector_ac7464dd163607b1a6417e438a639d050}{\index{meow\-::\-Vector@{meow\-::\-Vector}!Scalar\-Ref\-K@{Scalar\-Ref\-K}} +\index{Scalar\-Ref\-K@{Scalar\-Ref\-K}!meow::Vector@{meow\-::\-Vector}} +\subsubsection[{Scalar\-Ref\-K}]{\setlength{\rightskip}{0pt plus 5cm}template$<$class Scalar$>$ typedef {\bf Matrix}$<$Scalar$>$\-::Entry\-Ref\-K {\bf meow\-::\-Vector}$<$ Scalar $>$\-::{\bf Scalar\-Ref\-K}}}\label{classmeow_1_1Vector_ac7464dd163607b1a6417e438a639d050} + + \subsection{Constructor \& Destructor Documentation} \hypertarget{classmeow_1_1Vector_a68530affccd332248e476cc3e188cd61}{\index{meow\-::\-Vector@{meow\-::\-Vector}!Vector@{Vector}} \index{Vector@{Vector}!meow::Vector@{meow\-::\-Vector}} @@ -147,27 +163,6 @@ From matrix's first column \mbox{\tt in} & {\em m} & matrix \\ \hline \end{DoxyParams} -\hypertarget{classmeow_1_1Vector_af4966b6e2df19fa6d2752460b1e8afff}{\index{meow\-::\-Vector@{meow\-::\-Vector}!Vector@{Vector}} -\index{Vector@{Vector}!meow::Vector@{meow\-::\-Vector}} -\subsubsection[{Vector}]{\setlength{\rightskip}{0pt plus 5cm}template$<$class Scalar$>$ {\bf meow\-::\-Vector}$<$ Scalar $>$\-::{\bf Vector} ( -\begin{DoxyParamCaption} -\item[{{\bf Matrix}$<$ Scalar $>$ const \&}]{m, } -\item[{size\-\_\-t}]{i} -\end{DoxyParamCaption} -)\hspace{0.3cm}{\ttfamily [inline]}}}\label{classmeow_1_1Vector_af4966b6e2df19fa6d2752460b1e8afff} - - -constructor - -From matrix's {\itshape i-\/th} column - - -\begin{DoxyParams}[1]{Parameters} -\mbox{\tt in} & {\em m} & matrix \\ -\hline -\mbox{\tt in} & {\em i} & i-\/th \\ -\hline -\end{DoxyParams} \hypertarget{classmeow_1_1Vector_a58f997cdc6b98a76ae13bba6d685d815}{\index{meow\-::\-Vector@{meow\-::\-Vector}!Vector@{Vector}} \index{Vector@{Vector}!meow::Vector@{meow\-::\-Vector}} \subsubsection[{Vector}]{\setlength{\rightskip}{0pt plus 5cm}template$<$class Scalar$>$ {\bf meow\-::\-Vector}$<$ Scalar $>$\-::{\bf Vector} ( @@ -320,25 +315,25 @@ change {\itshape i} -\/th to {\itshape j} -\/th entries \mbox{\tt in} & {\em s} & new value \\ \hline \end{DoxyParams} -\hypertarget{classmeow_1_1Vector_af5ecb8d9cc811a2d56e1725c4bfd30e8}{\index{meow\-::\-Vector@{meow\-::\-Vector}!entry@{entry}} +\hypertarget{classmeow_1_1Vector_a2413f452c3d8b76208d99f7256c9ade8}{\index{meow\-::\-Vector@{meow\-::\-Vector}!entry@{entry}} \index{entry@{entry}!meow::Vector@{meow\-::\-Vector}} -\subsubsection[{entry}]{\setlength{\rightskip}{0pt plus 5cm}template$<$class Scalar$>$ Scalar {\bf meow\-::\-Vector}$<$ Scalar $>$\-::entry ( +\subsubsection[{entry}]{\setlength{\rightskip}{0pt plus 5cm}template$<$class Scalar$>$ {\bf Scalar\-Ref\-K} {\bf meow\-::\-Vector}$<$ Scalar $>$\-::entry ( \begin{DoxyParamCaption} \item[{size\-\_\-t}]{i} \end{DoxyParamCaption} -) const\hspace{0.3cm}{\ttfamily [inline]}}}\label{classmeow_1_1Vector_af5ecb8d9cc811a2d56e1725c4bfd30e8} +) const\hspace{0.3cm}{\ttfamily [inline]}}}\label{classmeow_1_1Vector_a2413f452c3d8b76208d99f7256c9ade8} return {\itshape i} -\/th entry -\hypertarget{classmeow_1_1Vector_a5050e9117204a6dbdcc7cf5038845c00}{\index{meow\-::\-Vector@{meow\-::\-Vector}!entry@{entry}} +\hypertarget{classmeow_1_1Vector_ab0a1b850f2db26637b88900ba2e1911a}{\index{meow\-::\-Vector@{meow\-::\-Vector}!entry@{entry}} \index{entry@{entry}!meow::Vector@{meow\-::\-Vector}} -\subsubsection[{entry}]{\setlength{\rightskip}{0pt plus 5cm}template$<$class Scalar$>$ Scalar {\bf meow\-::\-Vector}$<$ Scalar $>$\-::entry ( +\subsubsection[{entry}]{\setlength{\rightskip}{0pt plus 5cm}template$<$class Scalar$>$ {\bf Scalar\-Ref\-K} {\bf meow\-::\-Vector}$<$ Scalar $>$\-::entry ( \begin{DoxyParamCaption} \item[{size\-\_\-t}]{i, } \item[{Scalar const \&}]{s} \end{DoxyParamCaption} -)\hspace{0.3cm}{\ttfamily [inline]}}}\label{classmeow_1_1Vector_a5050e9117204a6dbdcc7cf5038845c00} +)\hspace{0.3cm}{\ttfamily [inline]}}}\label{classmeow_1_1Vector_ab0a1b850f2db26637b88900ba2e1911a} change {\itshape i} -\/th entry @@ -350,6 +345,17 @@ change {\itshape i} -\/th entry \mbox{\tt in} & {\em s} & new value \\ \hline \end{DoxyParams} +\hypertarget{classmeow_1_1Vector_a35b4e136e93445279372f70e4caf00fe}{\index{meow\-::\-Vector@{meow\-::\-Vector}!entry\-Get@{entry\-Get}} +\index{entry\-Get@{entry\-Get}!meow::Vector@{meow\-::\-Vector}} +\subsubsection[{entry\-Get}]{\setlength{\rightskip}{0pt plus 5cm}template$<$class Scalar$>$ {\bf Scalar\-Ref} {\bf meow\-::\-Vector}$<$ Scalar $>$\-::entry\-Get ( +\begin{DoxyParamCaption} +\item[{size\-\_\-t}]{i} +\end{DoxyParamCaption} +)\hspace{0.3cm}{\ttfamily [inline]}}}\label{classmeow_1_1Vector_a35b4e136e93445279372f70e4caf00fe} + + +return {\itshape i} -\/th entry with non-\/constant type + \hypertarget{classmeow_1_1Vector_afc7cc691dd00ab41fd56d798c13a6a27}{\index{meow\-::\-Vector@{meow\-::\-Vector}!length@{length}} \index{length@{length}!meow::Vector@{meow\-::\-Vector}} \subsubsection[{length}]{\setlength{\rightskip}{0pt plus 5cm}template$<$class Scalar$>$ Scalar {\bf meow\-::\-Vector}$<$ Scalar $>$\-::length ( |