COPASI API  4.40.278
CUnitUpperTriangularView< Matrix > Class Template Reference

#include <CMatrix.h>

Public Types

typedef Matrix::elementType elementType
 

Public Member Functions

 CUnitUpperTriangularView (const Matrix &A, const elementType zero, const elementType unit)
 
size_t numCols () const
 
size_t numRows () const
 
elementType operator() (const size_t &row, const size_t &col) const
 
 ~CUnitUpperTriangularView ()
 

Private Attributes

const Matrix & mA
 
elementType mUnit
 
elementType mZero
 

Friends

std::ostream & operator<< (std::ostream &os, const CUnitUpperTriangularView< Matrix > &A)
 

Member Typedef Documentation

◆ elementType

template<class Matrix >
typedef Matrix::elementType CUnitUpperTriangularView< Matrix >::elementType

Constructor & Destructor Documentation

◆ CUnitUpperTriangularView()

template<class Matrix >
CUnitUpperTriangularView< Matrix >::CUnitUpperTriangularView ( const Matrix &  A,
const elementType  zero,
const elementType  unit 
)
inline

◆ ~CUnitUpperTriangularView()

template<class Matrix >
CUnitUpperTriangularView< Matrix >::~CUnitUpperTriangularView ( )
inline

Member Function Documentation

◆ numCols()

template<class Matrix >
size_t CUnitUpperTriangularView< Matrix >::numCols ( ) const
inline

The number of columns of the matrix

Returns
size_t cols

References CUnitUpperTriangularView< Matrix >::mA.

◆ numRows()

template<class Matrix >
size_t CUnitUpperTriangularView< Matrix >::numRows ( ) const
inline

The number of rows of the matrix.

Returns
size_t rows

References CUnitUpperTriangularView< Matrix >::mA.

◆ operator()()

template<class Matrix >
elementType CUnitUpperTriangularView< Matrix >::operator() ( const size_t &  row,
const size_t &  col 
) const
inline

Retrieve a matrix element using the indexing style of the matrix.

Parameters
constsize_t & row
constsize_t & col
Returns
elementType element

References CUnitUpperTriangularView< Matrix >::mA, CUnitUpperTriangularView< Matrix >::mUnit, and CUnitUpperTriangularView< Matrix >::mZero.

Friends And Related Function Documentation

◆ operator<<

template<class Matrix >
std::ostream& operator<< ( std::ostream &  os,
const CUnitUpperTriangularView< Matrix > &  A 
)
friend

Output stream operator

Parameters
ostream& os
constCUnitUpperTriangularView< Matrix > & A
Returns
ostream & os

Member Data Documentation

◆ mA

◆ mUnit

template<class Matrix >
elementType CUnitUpperTriangularView< Matrix >::mUnit
private

◆ mZero

template<class Matrix >
elementType CUnitUpperTriangularView< Matrix >::mZero
private

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