PSCF v1.1
Public Member Functions | List of all members
Util::FMatrix< Data, M, N > Class Template Reference

Fixed Size Matrix. More...

#include <FMatrix.h>

Inheritance diagram for Util::FMatrix< Data, M, N >:
Util::Matrix< Data >

Public Member Functions

 FMatrix ()
 Default constructor. More...
 
 FMatrix (FMatrix< Data, M, N > const &other)
 Copy constructor. More...
 
 ~FMatrix ()
 Destructor. More...
 
FMatrix< Data, M, N > & operator= (FMatrix< Data, M, N > const &other)
 Assignment. More...
 
template<class Archive >
void serialize (Archive &ar, const unsigned int version)
 Serialize an FMatrix to/from an Archive. More...
 
- Public Member Functions inherited from Util::Matrix< Data >
virtual ~Matrix ()
 Destructor. More...
 
int capacity1 () const
 Get number of rows (range of the first array index). More...
 
int capacity2 () const
 Get number of columns (range of the second array index). More...
 
Data const & operator() (int i, int j) const
 Return element (i,j) of matrix by const reference. More...
 
Data & operator() (int i, int j)
 Return element (i,j) of matrix by reference. More...
 
Data * cArray ()
 Return pointer to underlying one-dimensional C array. More...
 
Data const * cArray () const
 Return pointer to const to underlying one-dimensional C array. More...
 

Additional Inherited Members

- Protected Member Functions inherited from Util::Matrix< Data >
 Matrix ()
 Default constructor. More...
 
- Protected Attributes inherited from Util::Matrix< Data >
Data * data_
 Pointer to 1D C array of all elements. More...
 
int capacity1_
 Number of rows (range of first index). More...
 
int capacity2_
 Number of columns (range of first index). More...
 

Detailed Description

template<typename Data, int M, int 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.

Definition at line 28 of file FMatrix.h.

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_, and Util::Matrix< Data >::data_.

◆ 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_, and Util::Matrix< Data >::data_.

◆ ~FMatrix()

template<typename Data , int M, int N>
Util::FMatrix< Data, M, N >::~FMatrix

Destructor.

Definition at line 104 of file FMatrix.h.

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)

Assignment.

Definition at line 112 of file FMatrix.h.

◆ serialize()

template<class Data , int M, int N>
template<class Archive >
void Util::FMatrix< Data, M, N >::serialize ( Archive &  ar,
const unsigned int  version 
)

Serialize an FMatrix to/from an Archive.

Parameters
ararchive
versionarchive version id

Definition at line 131 of file FMatrix.h.


The documentation for this class was generated from the following file: