#include <MatrixBase.hpp>

Inheritance diagram for Nektar::ConstMatrix< DataType >:

Public Member Functions
virtual	~ConstMatrix ()

boost::call_traits< DataType >::value_type	operator() (unsigned int row, unsigned int column) const

unsigned int	GetStorageSize () const

MatrixStorage	GetType () const

MatrixStorage	GetStorageType () const

unsigned int	GetRows () const

unsigned int	GetTransposedRows (char transpose) const

unsigned int	GetColumns () const

unsigned int	GetTransposedColumns (char transpose) const

const unsigned int *	GetSize () const

void	Transpose ()

char	GetTransposeFlag () const

Static Public Member Functions
static unsigned int	CalculateIndex (MatrixStorage type, unsigned int row, unsigned int col, unsigned int numRows, unsigned int numColumns, const char transpose='N', unsigned int numSubDiags=0, unsigned int numSuperDiags=0)

static unsigned int	GetRequiredStorageSize (MatrixStorage type, unsigned int rows, unsigned int columns, unsigned int subDiags=0, unsigned int superDiags=0)

Protected Member Functions
	ConstMatrix (unsigned int rows, unsigned int columns, MatrixStorage policy=eFULL)

	ConstMatrix (const ConstMatrix< DataType > &rhs)

ConstMatrix< DataType > &	operator= (const ConstMatrix< DataType > &rhs)

void	Resize (unsigned int rows, unsigned int columns)
	Resets the rows and columns in the array. This method does not update the data storage to match the new row and column counts. More...

void	SetTransposeFlag (char newValue)

char	GetRawTransposeFlag () const

Private Member Functions
virtual boost::call_traits< DataType >::value_type	v_GetValue (unsigned int row, unsigned int column) const =0

virtual unsigned int	v_GetStorageSize () const =0

virtual void	v_Transpose ()

virtual char	v_GetTransposeFlag () const

Private Attributes
unsigned int	m_size [2]

char	m_transpose

MatrixStorage	m_storageType

Detailed Description

template<typename DataType>
class Nektar::ConstMatrix< DataType >

Definition at line 54 of file MatrixBase.hpp.

Constructor & Destructor Documentation

◆ ~ConstMatrix()

template<typename DataType >

Nektar::ConstMatrix< DataType >::~ConstMatrix ( )

virtual

Definition at line 37 of file MatrixBase.cpp.

37 {}

◆ ConstMatrix() [1/2]

template<typename DataType >

Nektar::ConstMatrix< DataType >::ConstMatrix	(	unsigned int	rows,
		unsigned int	columns,
		MatrixStorage	policy = `eFULL`
	)

protected

Definition at line 225 of file MatrixBase.cpp.

Referenced by Nektar::ConstMatrix< NekMatrix< DataType, InnerMatrixType >::NumberType >::GetStorageType().

                                                              :
         m_size(),
         m_transpose('N'),
         m_storageType(policy)
     {
         m_size[0] = rows;
         m_size[1] = columns;
     }

◆ ConstMatrix() [2/2]

template<typename DataType>

Nektar::ConstMatrix< DataType >::ConstMatrix ( const ConstMatrix< DataType > & rhs )

protected

Definition at line 236 of file MatrixBase.cpp.

                                                                        :
         m_size(),
         m_transpose(rhs.m_transpose),
         m_storageType(rhs.m_storageType)
     {
         m_size[0] = rhs.m_size[0];
         m_size[1] = rhs.m_size[1];
     }

Member Function Documentation

◆ CalculateIndex()

template<typename DataType >

unsigned int Nektar::ConstMatrix< DataType >::CalculateIndex	(	MatrixStorage	type,
		unsigned int	row,
		unsigned int	col,
		unsigned int	numRows,
		unsigned int	numColumns,
		const char	transpose = `'N'`,
		unsigned int	numSubDiags = `0`,
		unsigned int	numSuperDiags = `0`
	)

static

Definition at line 119 of file MatrixBase.cpp.

Referenced by Nektar::NekMatrix< DataType, StandardMatrixTag >::CalculateIndex(), and Nektar::ConstMatrix< NekMatrix< DataType, InnerMatrixType >::NumberType >::GetStorageType().

     {
         if(transpose == 'T' )
         {
             std::swap(row, col);
         }
         switch(type)
         {
             case eFULL:
                 return FullMatrixFuncs::CalculateIndex(numRows, numColumns, row, col);
                 break;
             case eDIAGONAL:
                 return DiagonalMatrixFuncs::CalculateIndex(row, col);
                 break;
             case eUPPER_TRIANGULAR:
                 return UpperTriangularMatrixFuncs::CalculateIndex(row, col);
                 break;
             case eLOWER_TRIANGULAR:
                 return LowerTriangularMatrixFuncs::CalculateIndex(numColumns, row, col);
                 break;
             case eSYMMETRIC:
             case ePOSITIVE_DEFINITE_SYMMETRIC:
                 return SymmetricMatrixFuncs::CalculateIndex(row, col);
                 break;
             case eBANDED:
                 return BandedMatrixFuncs::CalculateIndex(numRows, numColumns,
                     row, col, numSubDiags, numSuperDiags);
                 break;
             case eSYMMETRIC_BANDED:
             case ePOSITIVE_DEFINITE_SYMMETRIC_BANDED:
                 {
                     ASSERTL1(numSubDiags==numSuperDiags,
                              std::string("Number of sub- and superdiagonals should ") +
                              std::string("be equal for a symmetric banded matrix"));
                     return SymmetricBandedMatrixFuncs::CalculateIndex(row, col,
                         numSuperDiags);
                 }
                 break;
             case eUPPER_TRIANGULAR_BANDED:
                 NEKERROR(ErrorUtil::efatal, "Not yet implemented.");
                 break;
             case eLOWER_TRIANGULAR_BANDED:
                 NEKERROR(ErrorUtil::efatal, "Not yet implemented.");
                 break;
 
             default:
                 NEKERROR(ErrorUtil::efatal, "Unhandled matrix type");
         }
 
         return std::numeric_limits<unsigned int>::max();
     }

◆ GetColumns()

template<typename DataType >

unsigned int Nektar::ConstMatrix< DataType >::GetColumns ( ) const

Definition at line 77 of file MatrixBase.cpp.

Referenced by Nektar::AddEqual(), Nektar::AddEqualNegatedLhs(), Nektar::ConstMatrix< NekMatrix< DataType, InnerMatrixType >::NumberType >::GetStorageType(), Nektar::MultiplyEqual(), Nektar::NegateInPlace(), Nektar::NekMatrix< DataType, StandardMatrixTag >::operator==(), Nektar::SubtractEqual(), Nektar::SubtractEqualNegatedLhs(), and Nektar::Transpose().

     {
         return GetTransposedColumns(GetTransposeFlag());
     }

◆ GetRawTransposeFlag()

template<typename DataType>

char Nektar::ConstMatrix< DataType >::GetRawTransposeFlag ( ) const

inlineprotected

Definition at line 112 of file MatrixBase.hpp.

             {
                 return m_transpose;
             }

◆ GetRequiredStorageSize()

template<typename DataType >

unsigned int Nektar::ConstMatrix< DataType >::GetRequiredStorageSize	(	MatrixStorage	type,
		unsigned int	rows,
		unsigned int	columns,
		unsigned int	subDiags = `0`,
		unsigned int	superDiags = `0`
	)

static

Definition at line 175 of file MatrixBase.cpp.

Referenced by Nektar::NekMatrix< DataType, StandardMatrixTag >::GetRequiredStorageSize(), and Nektar::ConstMatrix< NekMatrix< DataType, InnerMatrixType >::NumberType >::GetStorageType().

     {
         switch(type)
         {
             case eFULL:
                 return FullMatrixFuncs::GetRequiredStorageSize(rows, columns);
                 break;
             case eDIAGONAL:
                 return DiagonalMatrixFuncs::GetRequiredStorageSize(rows, columns);
                 break;
             case eUPPER_TRIANGULAR:
                 return UpperTriangularMatrixFuncs::GetRequiredStorageSize(rows, columns);
                 break;
             case eLOWER_TRIANGULAR:
                 return LowerTriangularMatrixFuncs::GetRequiredStorageSize(rows, columns);
                 break;
             case eSYMMETRIC:
             case ePOSITIVE_DEFINITE_SYMMETRIC:
                 return SymmetricMatrixFuncs::GetRequiredStorageSize(rows, columns);
                 break;
             case eBANDED:
                 return BandedMatrixFuncs::GetRequiredStorageSize(rows, columns,
                     subDiags, superDiags);
                 break;
             case eSYMMETRIC_BANDED:
             case ePOSITIVE_DEFINITE_SYMMETRIC_BANDED:
                 {
                     ASSERTL1(subDiags==superDiags,
                              std::string("Number of sub- and superdiagonals should ") +
                              std::string("be equal for a symmetric banded matrix"));
                     return SymmetricBandedMatrixFuncs::GetRequiredStorageSize(rows, columns,
                         superDiags);
                 }
                 break;
             case eUPPER_TRIANGULAR_BANDED:
                 NEKERROR(ErrorUtil::efatal, "Unhandled matrix type");
                 break;
             case eLOWER_TRIANGULAR_BANDED:
                 NEKERROR(ErrorUtil::efatal, "Unhandled matrix type");
                 break;
 
             default:
                 NEKERROR(ErrorUtil::efatal, "Unhandled matrix type");
         }
 
         return 0;
     }

◆ GetRows()

template<typename DataType >

unsigned int Nektar::ConstMatrix< DataType >::GetRows ( ) const

Definition at line 58 of file MatrixBase.cpp.

Referenced by Nektar::AddEqual(), Nektar::AddEqualNegatedLhs(), Nektar::ConstMatrix< NekMatrix< DataType, InnerMatrixType >::NumberType >::GetStorageType(), Nektar::MultiplyEqual(), Nektar::NegateInPlace(), Nektar::NekMatrix< DataType, StandardMatrixTag >::operator==(), Nektar::SubtractEqual(), Nektar::SubtractEqualNegatedLhs(), and Nektar::Transpose().

     {
         return GetTransposedRows(GetTransposeFlag());
     }

◆ GetSize()

template<typename DataType >

const unsigned int * Nektar::ConstMatrix< DataType >::GetSize ( ) const

Definition at line 96 of file MatrixBase.cpp.

Referenced by Nektar::ConstMatrix< NekMatrix< DataType, InnerMatrixType >::NumberType >::GetStorageType().

96 { return m_size; }

Nektar::ConstMatrix::m_size

unsigned int m_size[2]

Definition: MatrixBase.hpp:123

◆ GetStorageSize()

template<typename DataType >

unsigned int Nektar::ConstMatrix< DataType >::GetStorageSize ( ) const

Definition at line 52 of file MatrixBase.cpp.

     {
         return v_GetStorageSize();
     }

◆ GetStorageType()

template<typename DataType>

MatrixStorage Nektar::ConstMatrix< DataType >::GetStorageType ( ) const

inline

Definition at line 69 of file MatrixBase.hpp.

             {
                 return m_storageType;
             }

◆ GetTransposedColumns()

template<typename DataType >

unsigned int Nektar::ConstMatrix< DataType >::GetTransposedColumns ( char transpose ) const

Definition at line 83 of file MatrixBase.cpp.

Referenced by Nektar::ConstMatrix< NekMatrix< DataType, InnerMatrixType >::NumberType >::GetStorageType().

     {
         if( transpose == 'N' )
         {
             return m_size[1];
         }
         else
         {
             return m_size[0];
         }
     }

◆ GetTransposedRows()

template<typename DataType >

unsigned int Nektar::ConstMatrix< DataType >::GetTransposedRows ( char transpose ) const

Definition at line 64 of file MatrixBase.cpp.

Referenced by Nektar::ConstMatrix< NekMatrix< DataType, InnerMatrixType >::NumberType >::GetStorageType().

     {
         if( transpose == 'N' )
         {
             return m_size[0];
         }
         else
         {
             return m_size[1];
         }
     }

◆ GetTransposeFlag()

template<typename DataType >

char Nektar::ConstMatrix< DataType >::GetTransposeFlag ( ) const

Definition at line 113 of file MatrixBase.cpp.

Referenced by Nektar::ConstMatrix< NekMatrix< DataType, InnerMatrixType >::NumberType >::GetStorageType(), and Nektar::NekMatrix< DataType, StandardMatrixTag >::operator==().

     {
         return v_GetTransposeFlag();
     }

◆ GetType()

template<typename DataType>

MatrixStorage Nektar::ConstMatrix< DataType >::GetType ( ) const

inline

Definition at line 64 of file MatrixBase.hpp.

Referenced by Nektar::Transpose().

             {
                 return m_storageType;
             }

◆ operator()()

template<typename DataType >

boost::call_traits< DataType >::value_type Nektar::ConstMatrix< DataType >::operator()	(	unsigned int	row,
		unsigned int	column
	)		const

Definition at line 40 of file MatrixBase.cpp.

     {
         ASSERTL2(row < GetRows(), std::string("Row ") + std::to_string(row) +
             std::string(" requested in a matrix with a maximum of ") + std::to_string(GetRows()) +
             std::string(" rows"));
         ASSERTL2(column < GetColumns(), std::string("Column ") + std::to_string(column) +
             std::string(" requested in a matrix with a maximum of ") + std::to_string(GetColumns()) +
             std::string(" columns"));
         return v_GetValue(row, column);
     }

◆ operator=()

template<typename DataType>

ConstMatrix< DataType > & Nektar::ConstMatrix< DataType >::operator= ( const ConstMatrix< DataType > & rhs )

protected

Definition at line 246 of file MatrixBase.cpp.

Referenced by Nektar::ConstMatrix< NekMatrix< DataType, InnerMatrixType >::NumberType >::GetStorageType(), and Nektar::Matrix< DataType >::operator=().

     {
         m_size[0] = rhs.m_size[0];
         m_size[1] = rhs.m_size[1];
         m_transpose = rhs.m_transpose;
         m_storageType = rhs.m_storageType;
         return *this;
     }

◆ Resize()

template<typename DataType >

void Nektar::ConstMatrix< DataType >::Resize	(	unsigned int	rows,
		unsigned int	columns
	)

protected

Resets the rows and columns in the array. This method does not update the data storage to match the new row and column counts.

Definition at line 257 of file MatrixBase.cpp.

Referenced by Nektar::ConstMatrix< NekMatrix< DataType, InnerMatrixType >::NumberType >::GetStorageType().

     {
         m_size[0] = rows;
         m_size[1] = columns;
     }

◆ SetTransposeFlag()

template<typename DataType >

void Nektar::ConstMatrix< DataType >::SetTransposeFlag ( char newValue )

protected

Definition at line 264 of file MatrixBase.cpp.

Referenced by Nektar::ConstMatrix< NekMatrix< DataType, InnerMatrixType >::NumberType >::GetStorageType().

     {
         m_transpose = newValue;
     }

◆ Transpose()

template<typename DataType >

void Nektar::ConstMatrix< DataType >::Transpose ( )

Definition at line 99 of file MatrixBase.cpp.

Referenced by Nektar::ConstMatrix< NekMatrix< DataType, InnerMatrixType >::NumberType >::GetStorageType(), and Nektar::Transpose().

     {
         if( m_transpose == 'N' )
         {
             m_transpose = 'T';
         }
         else
         {
             m_transpose = 'N';
         }
         v_Transpose();
     }