| 1 |
\hypertarget{classSimpleMatrix}{ |
| 2 |
\section{SimpleMatrix$<$ T $>$ Class Template Reference} |
| 3 |
\label{classSimpleMatrix}\index{SimpleMatrix@{SimpleMatrix}} |
| 4 |
} |
| 5 |
A simple matrix class. |
| 6 |
|
| 7 |
|
| 8 |
{\tt \#include $<$CommonDefs.h$>$} |
| 9 |
|
| 10 |
\subsection*{Public Member Functions} |
| 11 |
\begin{CompactItemize} |
| 12 |
\item |
| 13 |
\hyperlink{classSimpleMatrix_9333dc41698c48f4e35d48e27dfe58ef}{SimpleMatrix} (unsigned int nRows, unsigned int nCols, T elements=T()) |
| 14 |
\begin{CompactList}\small\item\em Constructor. \item\end{CompactList}\item |
| 15 |
std::vector$<$ T $>$ \& \hyperlink{classSimpleMatrix_7ee36ef98c7f896e38ec8a8a0c263c39}{operator\mbox{[}$\,$\mbox{]}} (int i) |
| 16 |
\begin{CompactList}\small\item\em Standard accessor. \item\end{CompactList}\item |
| 17 |
unsigned int \hyperlink{classSimpleMatrix_5cd169cdc38912c3cfb6d0c60e48e042}{GetNRows} () |
| 18 |
\begin{CompactList}\small\item\em Returns the number of rows. \item\end{CompactList}\item |
| 19 |
unsigned int \hyperlink{classSimpleMatrix_4f168e5b85899788746355ccad15e2fb}{GetNCols} () |
| 20 |
\begin{CompactList}\small\item\em Returns the number of columns. \item\end{CompactList}\end{CompactItemize} |
| 21 |
|
| 22 |
|
| 23 |
\subsection{Detailed Description} |
| 24 |
\subsubsection*{template$<$class T$>$ class SimpleMatrix$<$ T $>$} |
| 25 |
|
| 26 |
A simple matrix class. |
| 27 |
|
| 28 |
This class defines a matrix built by STL vectors. It is basically a variable-dimension vector of vectors; the dimension is defined at construction and cannot be changed in current implementation. It is intended as a container and not for algebraic manipulations. The class provides a standard access operator \mbox{[}\mbox{]}. |
| 29 |
|
| 30 |
\subsection{Constructor \& Destructor Documentation} |
| 31 |
\hypertarget{classSimpleMatrix_9333dc41698c48f4e35d48e27dfe58ef}{ |
| 32 |
\index{SimpleMatrix@{SimpleMatrix}!SimpleMatrix@{SimpleMatrix}} |
| 33 |
\index{SimpleMatrix@{SimpleMatrix}!SimpleMatrix@{SimpleMatrix}} |
| 34 |
\subsubsection[{SimpleMatrix}]{\setlength{\rightskip}{0pt plus 5cm}template$<$class T$>$ {\bf SimpleMatrix}$<$ T $>$::{\bf SimpleMatrix} (unsigned int {\em nRows}, \/ unsigned int {\em nCols}, \/ T {\em elements} = {\tt T()})\hspace{0.3cm}{\tt \mbox{[}inline\mbox{]}}}} |
| 35 |
\label{classSimpleMatrix_9333dc41698c48f4e35d48e27dfe58ef} |
| 36 |
|
| 37 |
|
| 38 |
Constructor. |
| 39 |
|
| 40 |
The constructor will build an nRows x nCols matrix, initialized with a default value. If T is a class with no default constructor, a default value for T must be provided, which will be replicated in every matrix element. |
| 41 |
|
| 42 |
\begin{Desc} |
| 43 |
\item[Parameters:] |
| 44 |
\begin{description} |
| 45 |
\item[{\em nRows}]The number of rows. \item[{\em nCols}]The number of columns \item[{\em elements}]The initialization value for the matrix elements. \end{description} |
| 46 |
\end{Desc} |
| 47 |
|
| 48 |
|
| 49 |
\subsection{Member Function Documentation} |
| 50 |
\hypertarget{classSimpleMatrix_4f168e5b85899788746355ccad15e2fb}{ |
| 51 |
\index{SimpleMatrix@{SimpleMatrix}!GetNCols@{GetNCols}} |
| 52 |
\index{GetNCols@{GetNCols}!SimpleMatrix@{SimpleMatrix}} |
| 53 |
\subsubsection[{GetNCols}]{\setlength{\rightskip}{0pt plus 5cm}template$<$class T$>$ unsigned int {\bf SimpleMatrix}$<$ T $>$::GetNCols ()\hspace{0.3cm}{\tt \mbox{[}inline\mbox{]}}}} |
| 54 |
\label{classSimpleMatrix_4f168e5b85899788746355ccad15e2fb} |
| 55 |
|
| 56 |
|
| 57 |
Returns the number of columns. |
| 58 |
|
| 59 |
\begin{Desc} |
| 60 |
\item[Returns:]The number of columns. \end{Desc} |
| 61 |
\hypertarget{classSimpleMatrix_5cd169cdc38912c3cfb6d0c60e48e042}{ |
| 62 |
\index{SimpleMatrix@{SimpleMatrix}!GetNRows@{GetNRows}} |
| 63 |
\index{GetNRows@{GetNRows}!SimpleMatrix@{SimpleMatrix}} |
| 64 |
\subsubsection[{GetNRows}]{\setlength{\rightskip}{0pt plus 5cm}template$<$class T$>$ unsigned int {\bf SimpleMatrix}$<$ T $>$::GetNRows ()\hspace{0.3cm}{\tt \mbox{[}inline\mbox{]}}}} |
| 65 |
\label{classSimpleMatrix_5cd169cdc38912c3cfb6d0c60e48e042} |
| 66 |
|
| 67 |
|
| 68 |
Returns the number of rows. |
| 69 |
|
| 70 |
\begin{Desc} |
| 71 |
\item[Returns:]The number of rows. \end{Desc} |
| 72 |
\hypertarget{classSimpleMatrix_7ee36ef98c7f896e38ec8a8a0c263c39}{ |
| 73 |
\index{SimpleMatrix@{SimpleMatrix}!operator\mbox{[}\mbox{]}@{operator[]}} |
| 74 |
\index{operator\mbox{[}\mbox{]}@{operator[]}!SimpleMatrix@{SimpleMatrix}} |
| 75 |
\subsubsection[{operator[]}]{\setlength{\rightskip}{0pt plus 5cm}template$<$class T$>$ std::vector$<$T$>$\& {\bf SimpleMatrix}$<$ T $>$::operator\mbox{[}$\,$\mbox{]} (int {\em i})\hspace{0.3cm}{\tt \mbox{[}inline\mbox{]}}}} |
| 76 |
\label{classSimpleMatrix_7ee36ef98c7f896e38ec8a8a0c263c39} |
| 77 |
|
| 78 |
|
| 79 |
Standard accessor. |
| 80 |
|
| 81 |
\begin{Desc} |
| 82 |
\item[Parameters:] |
| 83 |
\begin{description} |
| 84 |
\item[{\em i}]The desired row. \end{description} |
| 85 |
\end{Desc} |
| 86 |
\begin{Desc} |
| 87 |
\item[Returns:]The i-th row (a vector). \end{Desc} |
| 88 |
|
| 89 |
|
| 90 |
The documentation for this class was generated from the following file:\begin{CompactItemize} |
| 91 |
\item |
| 92 |
\hyperlink{CommonDefs_8h}{CommonDefs.h}\end{CompactItemize} |
Parent Directory
| 
Revision Log