| 1 |
pam-fi |
1.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 |
|
|
\subsection*{Private Attributes} |
| 22 |
|
|
\begin{CompactItemize} |
| 23 |
|
|
\item |
| 24 |
|
|
std::vector$<$ std::vector$<$ T $>$ $>$ \hyperlink{classSimpleMatrix_ddb323741e9ed620a46436037c8d819a}{\_\-matrix} |
| 25 |
|
|
\item |
| 26 |
|
|
unsigned int \hyperlink{classSimpleMatrix_984429d26745802dcb3e001ff75246bc}{\_\-nRows} |
| 27 |
|
|
\item |
| 28 |
|
|
unsigned int \hyperlink{classSimpleMatrix_8ea505fb218d273214c2ae6ef45bbc82}{\_\-nCols} |
| 29 |
|
|
\end{CompactItemize} |
| 30 |
|
|
|
| 31 |
|
|
|
| 32 |
|
|
\subsection{Detailed Description} |
| 33 |
|
|
\subsubsection*{template$<$class T$>$ class SimpleMatrix$<$ T $>$} |
| 34 |
|
|
|
| 35 |
|
|
A simple matrix class. |
| 36 |
|
|
|
| 37 |
|
|
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{]}. |
| 38 |
|
|
|
| 39 |
|
|
Definition at line 45 of file CommonDefs.h. |
| 40 |
|
|
|
| 41 |
|
|
\subsection{Constructor \& Destructor Documentation} |
| 42 |
|
|
\hypertarget{classSimpleMatrix_9333dc41698c48f4e35d48e27dfe58ef}{ |
| 43 |
|
|
\index{SimpleMatrix@{SimpleMatrix}!SimpleMatrix@{SimpleMatrix}} |
| 44 |
|
|
\index{SimpleMatrix@{SimpleMatrix}!SimpleMatrix@{SimpleMatrix}} |
| 45 |
|
|
\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{]}}}} |
| 46 |
|
|
\label{classSimpleMatrix_9333dc41698c48f4e35d48e27dfe58ef} |
| 47 |
|
|
|
| 48 |
|
|
|
| 49 |
|
|
Constructor. |
| 50 |
|
|
|
| 51 |
|
|
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. |
| 52 |
|
|
|
| 53 |
|
|
\begin{Desc} |
| 54 |
|
|
\item[Parameters:] |
| 55 |
|
|
\begin{description} |
| 56 |
|
|
\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} |
| 57 |
|
|
\end{Desc} |
| 58 |
|
|
|
| 59 |
|
|
|
| 60 |
|
|
Definition at line 58 of file CommonDefs.h. |
| 61 |
|
|
|
| 62 |
|
|
\subsection{Member Function Documentation} |
| 63 |
|
|
\hypertarget{classSimpleMatrix_4f168e5b85899788746355ccad15e2fb}{ |
| 64 |
|
|
\index{SimpleMatrix@{SimpleMatrix}!GetNCols@{GetNCols}} |
| 65 |
|
|
\index{GetNCols@{GetNCols}!SimpleMatrix@{SimpleMatrix}} |
| 66 |
|
|
\subsubsection[{GetNCols}]{\setlength{\rightskip}{0pt plus 5cm}template$<$class T$>$ unsigned int {\bf SimpleMatrix}$<$ T $>$::GetNCols ()\hspace{0.3cm}{\tt \mbox{[}inline\mbox{]}}}} |
| 67 |
|
|
\label{classSimpleMatrix_4f168e5b85899788746355ccad15e2fb} |
| 68 |
|
|
|
| 69 |
|
|
|
| 70 |
|
|
Returns the number of columns. |
| 71 |
|
|
|
| 72 |
|
|
\begin{Desc} |
| 73 |
|
|
\item[Returns:]The number of columns. \end{Desc} |
| 74 |
|
|
|
| 75 |
|
|
|
| 76 |
|
|
Definition at line 84 of file CommonDefs.h.\hypertarget{classSimpleMatrix_5cd169cdc38912c3cfb6d0c60e48e042}{ |
| 77 |
|
|
\index{SimpleMatrix@{SimpleMatrix}!GetNRows@{GetNRows}} |
| 78 |
|
|
\index{GetNRows@{GetNRows}!SimpleMatrix@{SimpleMatrix}} |
| 79 |
|
|
\subsubsection[{GetNRows}]{\setlength{\rightskip}{0pt plus 5cm}template$<$class T$>$ unsigned int {\bf SimpleMatrix}$<$ T $>$::GetNRows ()\hspace{0.3cm}{\tt \mbox{[}inline\mbox{]}}}} |
| 80 |
|
|
\label{classSimpleMatrix_5cd169cdc38912c3cfb6d0c60e48e042} |
| 81 |
|
|
|
| 82 |
|
|
|
| 83 |
|
|
Returns the number of rows. |
| 84 |
|
|
|
| 85 |
|
|
\begin{Desc} |
| 86 |
|
|
\item[Returns:]The number of rows. \end{Desc} |
| 87 |
|
|
|
| 88 |
|
|
|
| 89 |
|
|
Definition at line 76 of file CommonDefs.h.\hypertarget{classSimpleMatrix_7ee36ef98c7f896e38ec8a8a0c263c39}{ |
| 90 |
|
|
\index{SimpleMatrix@{SimpleMatrix}!operator\mbox{[}\mbox{]}@{operator[]}} |
| 91 |
|
|
\index{operator\mbox{[}\mbox{]}@{operator[]}!SimpleMatrix@{SimpleMatrix}} |
| 92 |
|
|
\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{]}}}} |
| 93 |
|
|
\label{classSimpleMatrix_7ee36ef98c7f896e38ec8a8a0c263c39} |
| 94 |
|
|
|
| 95 |
|
|
|
| 96 |
|
|
Standard accessor. |
| 97 |
|
|
|
| 98 |
|
|
\begin{Desc} |
| 99 |
|
|
\item[Parameters:] |
| 100 |
|
|
\begin{description} |
| 101 |
|
|
\item[{\em i}]The desired row. \end{description} |
| 102 |
|
|
\end{Desc} |
| 103 |
|
|
\begin{Desc} |
| 104 |
|
|
\item[Returns:]The i-th row (a vector). \end{Desc} |
| 105 |
|
|
|
| 106 |
|
|
|
| 107 |
|
|
Definition at line 68 of file CommonDefs.h. |
| 108 |
|
|
|
| 109 |
|
|
\subsection{Member Data Documentation} |
| 110 |
|
|
\hypertarget{classSimpleMatrix_ddb323741e9ed620a46436037c8d819a}{ |
| 111 |
|
|
\index{SimpleMatrix@{SimpleMatrix}!\_\-matrix@{\_\-matrix}} |
| 112 |
|
|
\index{\_\-matrix@{\_\-matrix}!SimpleMatrix@{SimpleMatrix}} |
| 113 |
|
|
\subsubsection[{\_\-matrix}]{\setlength{\rightskip}{0pt plus 5cm}template$<$class T$>$ std::vector$<$std::vector$<$T$>$ $>$ {\bf SimpleMatrix}$<$ T $>$::{\bf \_\-matrix}\hspace{0.3cm}{\tt \mbox{[}private\mbox{]}}}} |
| 114 |
|
|
\label{classSimpleMatrix_ddb323741e9ed620a46436037c8d819a} |
| 115 |
|
|
|
| 116 |
|
|
|
| 117 |
|
|
|
| 118 |
|
|
|
| 119 |
|
|
Definition at line 90 of file CommonDefs.h. |
| 120 |
|
|
|
| 121 |
|
|
Referenced by SimpleMatrix$<$ UInt\_\-t $>$::operator\mbox{[}$\,$\mbox{]}().\hypertarget{classSimpleMatrix_8ea505fb218d273214c2ae6ef45bbc82}{ |
| 122 |
|
|
\index{SimpleMatrix@{SimpleMatrix}!\_\-nCols@{\_\-nCols}} |
| 123 |
|
|
\index{\_\-nCols@{\_\-nCols}!SimpleMatrix@{SimpleMatrix}} |
| 124 |
|
|
\subsubsection[{\_\-nCols}]{\setlength{\rightskip}{0pt plus 5cm}template$<$class T$>$ unsigned int {\bf SimpleMatrix}$<$ T $>$::{\bf \_\-nCols}\hspace{0.3cm}{\tt \mbox{[}private\mbox{]}}}} |
| 125 |
|
|
\label{classSimpleMatrix_8ea505fb218d273214c2ae6ef45bbc82} |
| 126 |
|
|
|
| 127 |
|
|
|
| 128 |
|
|
|
| 129 |
|
|
|
| 130 |
|
|
Definition at line 91 of file CommonDefs.h. |
| 131 |
|
|
|
| 132 |
|
|
Referenced by SimpleMatrix$<$ UInt\_\-t $>$::GetNCols().\hypertarget{classSimpleMatrix_984429d26745802dcb3e001ff75246bc}{ |
| 133 |
|
|
\index{SimpleMatrix@{SimpleMatrix}!\_\-nRows@{\_\-nRows}} |
| 134 |
|
|
\index{\_\-nRows@{\_\-nRows}!SimpleMatrix@{SimpleMatrix}} |
| 135 |
|
|
\subsubsection[{\_\-nRows}]{\setlength{\rightskip}{0pt plus 5cm}template$<$class T$>$ unsigned int {\bf SimpleMatrix}$<$ T $>$::{\bf \_\-nRows}\hspace{0.3cm}{\tt \mbox{[}private\mbox{]}}}} |
| 136 |
|
|
\label{classSimpleMatrix_984429d26745802dcb3e001ff75246bc} |
| 137 |
|
|
|
| 138 |
|
|
|
| 139 |
|
|
|
| 140 |
|
|
|
| 141 |
|
|
Definition at line 91 of file CommonDefs.h. |
| 142 |
|
|
|
| 143 |
|
|
Referenced by SimpleMatrix$<$ UInt\_\-t $>$::GetNRows(). |
| 144 |
|
|
|
| 145 |
|
|
The documentation for this class was generated from the following file:\begin{CompactItemize} |
| 146 |
|
|
\item |
| 147 |
|
|
\hyperlink{CommonDefs_8h}{CommonDefs.h}\end{CompactItemize} |
Parent Directory
| 
Revision Log