CubbyFlow::MatrixDiagonal< T, E > Class Template Reference

Diagonal matrix expression. More...

#include <Core/Matrix/MatrixExpression.h>

Inheritance diagram for CubbyFlow::MatrixDiagonal< T, E >:
CubbyFlow::MatrixExpression< T, MatrixDiagonal< T, E > >

Public Member Functions

 MatrixDiagonal (const E &u, bool isDiag)
 
Size2 size () const
 Size of the matrix. More...
 
size_t Rows () const
 Number of rows. More...
 
size_t Cols () const
 Number of columns. More...
 
operator() (size_t i, size_t j) const
 Returns matrix element at (i, j). More...
 
- Public Member Functions inherited from CubbyFlow::MatrixExpression< T, MatrixDiagonal< T, E > >
Size2 size () const
 Size of the matrix. More...
 
size_t Rows () const
 Number of rows. More...
 
size_t Cols () const
 Number of columns. More...
 
const MatrixDiagonal< T, E > & operator() () const
 Returns actual implementation (the subclass). More...
 

Detailed Description

template<typename T, typename E>
class CubbyFlow::MatrixDiagonal< T, E >

Diagonal matrix expression.

This matrix expression represents a diagonal matrix for given input matrix expression.

Template Parameters
TReal number type.
EInput expression type.

Constructor & Destructor Documentation

◆ MatrixDiagonal()

template<typename T , typename E >
CubbyFlow::MatrixDiagonal< T, E >::MatrixDiagonal ( const E &  u,
bool  isDiag 
)

Constructs diagonal matrix expression for given input expression.

Parameters
isDiag- True for diagonal matrix, false for off-diagonal.

Member Function Documentation

◆ Cols()

template<typename T , typename E >
size_t CubbyFlow::MatrixDiagonal< T, E >::Cols ( ) const

Number of columns.

◆ operator()()

template<typename T , typename E >
T CubbyFlow::MatrixDiagonal< T, E >::operator() ( size_t  i,
size_t  j 
) const

Returns matrix element at (i, j).

◆ Rows()

template<typename T , typename E >
size_t CubbyFlow::MatrixDiagonal< T, E >::Rows ( ) const

Number of rows.

◆ size()

template<typename T , typename E >
Size2 CubbyFlow::MatrixDiagonal< T, E >::size ( ) const

Size of the matrix.


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