Nektar::UpperTriangularMatrixFuncs Struct Reference

#include <MatrixFuncs.h>

Inheritance diagram for Nektar::UpperTriangularMatrixFuncs:

Static Public Member Functions
static unsigned int	CalculateIndex (unsigned int curRow, unsigned int curColumn)
static std::tuple< unsigned int, unsigned int >	Advance (const unsigned int totalRows, const unsigned int totalColumns, const unsigned int curRow, const unsigned int curColumn)
Static Public Member Functions inherited from Nektar::TriangularMatrixFuncs
static unsigned int	GetRequiredStorageSize (unsigned int rows, unsigned int columns)

Detailed Description

Definition at line 196 of file MatrixFuncs.h.

Member Function Documentation

Advance()

std::tuple< unsigned int, unsigned int > Nektar::UpperTriangularMatrixFuncs::Advance ( const unsigned int  totalRows, const unsigned int  totalColumns, const unsigned int  curRow, const unsigned int  curColumn  )

static

Definition at line 168 of file MatrixFuncs.cpp.

{
    ASSERTL1(totalRows == totalColumns, "Triangular matrices must be square.");
    ASSERTL1(curRow < totalRows,
             "Attemping to iterate through an element on row " +
                 std::to_string(curRow) + " of a (" +
                 std::to_string(totalRows) + ", " +
                 std::to_string(totalColumns) + " upper triangular matrix.");
    ASSERTL1(curColumn < totalColumns,
             "Attemping to iterate through an element on row " +
                 std::to_string(curColumn) + " of a (" +
                 std::to_string(totalRows) + ", " +
                 std::to_string(totalColumns) + " upper triangular matrix.");
    ASSERTL1(curRow <= curColumn,
             "Attemping to iterate through element (" + std::to_string(curRow) +
                 ", " + std::to_string(curColumn) + ") of a (" +
                 std::to_string(totalRows) + ", " +
                 std::to_string(totalColumns) + " upper triangular matrix.");
 
    unsigned int nextRow    = curRow;
    unsigned int nextColumn = curColumn;
 
    if (nextRow <= nextColumn)
    {
        ++nextRow;
    }
 
    if (nextRow > nextColumn)
    {
        ++nextColumn;
        nextRow = 0;
    }
 
    if (nextColumn >= totalColumns)
    {
        nextRow    = std::numeric_limits<unsigned int>::max();
        nextColumn = std::numeric_limits<unsigned int>::max();
    }
 
    return std::tuple<unsigned int, unsigned int>(nextRow, nextColumn);
}

References ASSERTL1.

Referenced by Nektar::LowerTriangularMatrixFuncs::Advance(), Nektar::NekMatrix< DataType, StandardMatrixTag >::Advance(), and Nektar::UpperTriangularUnitTests::BOOST_AUTO_TEST_CASE().

CalculateIndex()

unsigned int Nektar::UpperTriangularMatrixFuncs::CalculateIndex ( unsigned int  curRow, unsigned int  curColumn  )

static

Definition at line 155 of file MatrixFuncs.cpp.

{
    if (curRow <= curColumn)
    {
        return curRow + curColumn * (curColumn + 1) / 2;
    }
    else
    {
        return std::numeric_limits<unsigned int>::max();
    }
}