Nektar::ConstMatrix< DataType > Class Template Reference

#include <MatrixBase.hpp>

Inheritance diagram for Nektar::ConstMatrix< DataType >:

Public Member Functions
virtual	~ConstMatrix ()=default
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
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 53 of file MatrixBase.hpp.

Constructor & Destructor Documentation

~ConstMatrix()

template<typename DataType >

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

virtualdefault

ConstMatrix() [1/2]

template<typename DataType >

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

protected

Definition at line 221 of file MatrixBase.cpp.

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

References Nektar::ConstMatrix< DataType >::m_size.

ConstMatrix() [2/2]

template<typename DataType >

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

protected

Definition at line 230 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];
}

References Nektar::ConstMatrix< DataType >::m_size.

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 110 of file MatrixBase.cpp.

{
    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();
}

Referenced by Nektar::NekMatrix< DataType, StandardMatrixTag >::CalculateIndex().

GetColumns()

template<typename DataType >

unsigned int Nektar::ConstMatrix< DataType >::GetColumns

Definition at line 73 of file MatrixBase.cpp.

{
    return GetTransposedColumns(GetTransposeFlag());
}

Referenced by Nektar::AddEqualNegatedLhs(), Nektar::MultiplyEqual(), Nektar::NegateInPlace(), Nektar::NekMultiplyLowerTriangularMatrix(), Nektar::NekMultiplyUpperTriangularMatrix(), Nektar::NekMatrix< DataType, StandardMatrixTag >::operator==(), Nektar::SubtractEqualNegatedLhs(), and Nektar::Transpose().

GetRawTransposeFlag()

template<typename DataType >

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

inlineprotected

Definition at line 116 of file MatrixBase.hpp.

    {
        return m_transpose;
    }

References Nektar::ConstMatrix< DataType >::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 168 of file MatrixBase.cpp.

{
    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;
}

References ASSERTL1, Nektar::eBANDED, Nektar::eDIAGONAL, Nektar::ErrorUtil::efatal, Nektar::eFULL, Nektar::eLOWER_TRIANGULAR, Nektar::eLOWER_TRIANGULAR_BANDED, Nektar::ePOSITIVE_DEFINITE_SYMMETRIC, Nektar::ePOSITIVE_DEFINITE_SYMMETRIC_BANDED, Nektar::eSYMMETRIC, Nektar::eSYMMETRIC_BANDED, Nektar::eUPPER_TRIANGULAR, Nektar::eUPPER_TRIANGULAR_BANDED, Nektar::FullMatrixFuncs::GetRequiredStorageSize(), Nektar::TriangularMatrixFuncs::GetRequiredStorageSize(), Nektar::SymmetricMatrixFuncs::GetRequiredStorageSize(), Nektar::DiagonalMatrixFuncs::GetRequiredStorageSize(), Nektar::SymmetricBandedMatrixFuncs::GetRequiredStorageSize(), Nektar::BandedMatrixFuncs::GetRequiredStorageSize(), and NEKERROR.

Referenced by Nektar::NekMatrix< DataType, StandardMatrixTag >::GetRequiredStorageSize().

GetRows()

template<typename DataType >

unsigned int Nektar::ConstMatrix< DataType >::GetRows

Definition at line 61 of file MatrixBase.cpp.

{
    return GetTransposedRows(GetTransposeFlag());
}

Referenced by Nektar::AddEqualNegatedLhs(), Nektar::MultiplyEqual(), Nektar::NegateInPlace(), Nektar::NekMultiplyLowerTriangularMatrix(), Nektar::NekMultiplyUpperTriangularMatrix(), Nektar::NekMatrix< DataType, StandardMatrixTag >::operator==(), Nektar::SubtractEqualNegatedLhs(), and Nektar::Transpose().

GetSize()

template<typename DataType >

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

Definition at line 85 of file MatrixBase.cpp.

{
    return m_size;
}

GetStorageSize()

template<typename DataType >

unsigned int Nektar::ConstMatrix< DataType >::GetStorageSize

Definition at line 56 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;
    }

References Nektar::ConstMatrix< DataType >::m_storageType.

GetTransposedColumns()

template<typename DataType >

unsigned int Nektar::ConstMatrix< DataType >::GetTransposedColumns

(

char

transpose

)

const

Definition at line 79 of file MatrixBase.cpp.

{
    return (transpose == 'N') ? m_size[1] : m_size[0];
}

GetTransposedRows()

template<typename DataType >

unsigned int Nektar::ConstMatrix< DataType >::GetTransposedRows

(

char

transpose

)

const

Definition at line 67 of file MatrixBase.cpp.

{
    return (transpose == 'N') ? m_size[0] : m_size[1];
}

GetTransposeFlag()

template<typename DataType >

char Nektar::ConstMatrix< DataType >::GetTransposeFlag

Definition at line 104 of file MatrixBase.cpp.

{
    return v_GetTransposeFlag();
}

Referenced by Nektar::NekMultiplyLowerTriangularMatrix(), Nektar::NekMultiplyUpperTriangularMatrix(), and Nektar::NekMatrix< DataType, StandardMatrixTag >::operator==().

GetType()

template<typename DataType >

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

inline

Definition at line 64 of file MatrixBase.hpp.

    {
        return m_storageType;
    }

References Nektar::ConstMatrix< DataType >::m_storageType.

Referenced by Nektar::Transpose().

operator()()

template<typename DataType >

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

Definition at line 42 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);
}

References ASSERTL2.

operator=()

template<typename DataType >

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

protected

Definition at line 238 of file MatrixBase.cpp.

{
    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;
}

References Nektar::ConstMatrix< DataType >::m_size, Nektar::ConstMatrix< DataType >::m_storageType, and Nektar::ConstMatrix< DataType >::m_transpose.

Referenced by Nektar::Matrix< DataType >::operator=().

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 249 of file MatrixBase.cpp.

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

SetTransposeFlag()

template<typename DataType >

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

protected

Definition at line 256 of file MatrixBase.cpp.

{
    m_transpose = newValue;
}

Transpose()

template<typename DataType >

void Nektar::ConstMatrix< DataType >::Transpose

Definition at line 90 of file MatrixBase.cpp.

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

Referenced by Nektar::Transpose().

v_GetStorageSize()

template<typename DataType >

virtual unsigned int Nektar::ConstMatrix< DataType >::v_GetStorageSize ( ) const

protectedpure virtual

Implemented in Nektar::NekMatrix< NekMatrix< DataType, InnerMatrixType >, BlockMatrixTag >, Nektar::NekMatrix< NekMatrix< DataType, InnerMatrixType >, ScaledMatrixTag >, and Nektar::NekMatrix< DataType, StandardMatrixTag >.

v_GetTransposeFlag()

template<typename DataType >

char Nektar::ConstMatrix< DataType >::v_GetTransposeFlag

protectedvirtual

Reimplemented in Nektar::NekMatrix< NekMatrix< DataType, InnerMatrixType >, ScaledMatrixTag >.

Definition at line 266 of file MatrixBase.cpp.

{
    return m_transpose;
}

v_GetValue()

template<typename DataType >

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

protectedpure virtual

Implemented in Nektar::NekMatrix< NekMatrix< DataType, InnerMatrixType >, BlockMatrixTag >, Nektar::NekMatrix< NekMatrix< DataType, InnerMatrixType >, ScaledMatrixTag >, and Nektar::NekMatrix< DataType, StandardMatrixTag >.

v_Transpose()

template<typename DataType >

void Nektar::ConstMatrix< DataType >::v_Transpose

protectedvirtual

Reimplemented in Nektar::NekMatrix< NekMatrix< DataType, InnerMatrixType >, BlockMatrixTag >.

Definition at line 261 of file MatrixBase.cpp.

{
}

Member Data Documentation

m_size

template<typename DataType >

unsigned int Nektar::ConstMatrix< DataType >::m_size[2]

private

Definition at line 128 of file MatrixBase.hpp.

Referenced by Nektar::ConstMatrix< DataType >::ConstMatrix(), and Nektar::ConstMatrix< DataType >::operator=().

m_storageType

template<typename DataType >

MatrixStorage Nektar::ConstMatrix< DataType >::m_storageType

private

Definition at line 130 of file MatrixBase.hpp.

Referenced by Nektar::ConstMatrix< DataType >::GetStorageType(), Nektar::ConstMatrix< DataType >::GetType(), and Nektar::ConstMatrix< DataType >::operator=().

m_transpose

template<typename DataType >

char Nektar::ConstMatrix< DataType >::m_transpose

private

Definition at line 129 of file MatrixBase.hpp.

Referenced by Nektar::ConstMatrix< DataType >::GetRawTransposeFlag(), and Nektar::ConstMatrix< DataType >::operator=().