COPASI API  4.40.278
CUpperTriangularView< Matrix > Class Template Reference

#include <CMatrix.h>

Public Types

typedef Matrix::elementType elementType
 

Public Member Functions

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

Private Attributes

const Matrix & mA
 
elementType mZero
 

Friends

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

Member Typedef Documentation

◆ elementType

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

Constructor & Destructor Documentation

◆ CUpperTriangularView()

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

◆ ~CUpperTriangularView()

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

Member Function Documentation

◆ numCols()

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

The number of columns of the matrix

Returns
size_t cols

References CUpperTriangularView< Matrix >::mA.

◆ numRows()

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

The number of rows of the matrix.

Returns
size_t rows

References CUpperTriangularView< Matrix >::mA.

◆ operator()()

template<class Matrix >
elementType CUpperTriangularView< 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 CUpperTriangularView< Matrix >::mA, and CUpperTriangularView< Matrix >::mZero.

Friends And Related Function Documentation

◆ operator<<

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

Output stream operator

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

Member Data Documentation

◆ mA

◆ mZero

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

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