Util::FMatrix< Data, M, N > Class Template Reference
#include <FMatrix.h>
Inheritance diagram for Util::FMatrix< Data, M, N >:
Public Member Functions | |
| FMatrix () | |
| Default constructor. | |
| FMatrix (FMatrix< Data, M, N > const &other) | |
| Copy constructor. | |
| ~FMatrix () | |
| Destructor. | |
| FMatrix< Data, M, N > & | operator= (FMatrix< Data, M, N > const &other) |
| Assignment. | |
| template<class Archive> | |
| void | serialize (Archive &ar, const unsigned int version) |
| Serialize an FMatrix to/from an Archive. | |
| Public Member Functions inherited from Util::Matrix< Data > | |
| virtual | ~Matrix () |
| Destructor. | |
| int | capacity1 () const |
| Get number of rows (range of the first array index). | |
| int | capacity2 () const |
| Get number of columns (range of the second array index). | |
| Data const & | operator() (int i, int j) const |
| Return element (i,j) of matrix by const reference. | |
| Data & | operator() (int i, int j) |
| Return element (i,j) of matrix by reference. | |
| Data * | cArray () |
| Return pointer to underlying one-dimensional C array. | |
| Data const * | cArray () const |
| Return pointer to const to underlying one-dimensional C array. | |
Additional Inherited Members | |
| Protected Member Functions inherited from Util::Matrix< Data > | |
| Matrix () | |
| Default constructor. | |
| Protected Attributes inherited from Util::Matrix< Data > | |
| Data * | data_ |
| Pointer to 1D C array of all elements. | |
| int | capacity1_ |
| Number of rows (range of first index). | |
| int | capacity2_ |
| Number of columns (range of first index). | |
Detailed Description
template<typename Data, int M, int N>
class Util::FMatrix< Data, M, N >
class Util::FMatrix< Data, M, N >
Fixed Size Matrix.
The FMatrix class wraps a statically allocated 1D C array, but provides access to its elements via the A(i,j) Matrix syntax.
Template parameters M and N are the number of rows and columns respectively, so that capacity1 = M and capacity2 = N.
Constructor & Destructor Documentation
◆ FMatrix() [1/2]
template<typename Data, int M, int N>
| Util::FMatrix< Data, M, N >::FMatrix | ( | ) |
Default constructor.
Definition at line 77 of file FMatrix.h.
References Util::Matrix< Data >::capacity1_, Util::Matrix< Data >::capacity2_, Util::Matrix< Data >::data_, and Util::Matrix< Data >::Matrix().
Referenced by FMatrix(), and operator=().
◆ FMatrix() [2/2]
template<typename Data, int M, int N>
| Util::FMatrix< Data, M, N >::FMatrix | ( | FMatrix< Data, M, N > const & | other | ) |
Copy constructor.
Definition at line 89 of file FMatrix.h.
References Util::Matrix< Data >::capacity1_, Util::Matrix< Data >::capacity2_, Util::Matrix< Data >::data_, FMatrix(), and Util::Matrix< Data >::Matrix().
◆ ~FMatrix()
template<typename Data, int M, int N>
| Util::FMatrix< Data, M, N >::~FMatrix | ( | ) |
Member Function Documentation
◆ operator=()
template<typename Data, int M, int N>
| FMatrix< Data, M, N > & Util::FMatrix< Data, M, N >::operator= | ( | FMatrix< Data, M, N > const & | other | ) |
◆ serialize()
template<class Data, int M, int N>
template<class Archive>
| void Util::FMatrix< Data, M, N >::serialize | ( | Archive & | ar, |
| const unsigned int | version ) |
The documentation for this class was generated from the following file:
Generated on for PSCF by
1.14.0