yat  0.21pre
Public Types | Public Member Functions | Protected Attributes | List of all members
theplu::yat::utility::MatrixExpression< Derived > Class Template Reference

An expression that can be converted to a Matrix. More...

#include <yat/utility/MatrixExpression.h>

Inheritance diagram for theplu::yat::utility::MatrixExpression< Derived >:
theplu::yat::utility::BasicMatrix< MatrixExpression< Derived > >

Public Types

typedef Derived derived_type
 

Public Member Functions

 MatrixExpression (void)
 Defaulf constructor.
 
 ~MatrixExpression (void)
 Destructor.
 
 MatrixExpression (const MatrixExpression &other)
 Cop constructor.
 
 MatrixExpression (MatrixExpression &&other)
 Move constructor.
 
size_t rows (void) const
 
size_t columns (void) const
 
double operator() (size_t row, size_t column) const
 
void get (gsl_matrix *&m) const
 
void move (gsl_matrix *&m)
 
const gsl_matrix * gsl_matrix_p (void) const
 
gsl_matrix * gsl_matrix_p (void)
 

Protected Attributes

gsl_matrix * m_
 

Detailed Description

template<class Derived>
class theplu::yat::utility::MatrixExpression< Derived >

An expression that can be converted to a Matrix.

Class is only used as temporary when as part of Matrix calculations.

Since
new in yat 0.15

Member Typedef Documentation

◆ derived_type

template<class Derived>
typedef Derived theplu::yat::utility::MatrixExpression< Derived >::derived_type

Derived class

Member Function Documentation

◆ columns()

template<class Derived>
size_t theplu::yat::utility::MatrixExpression< Derived >::columns ( void  ) const
inline
Returns
number of columns

◆ get()

template<class Derived>
void theplu::yat::utility::MatrixExpression< Derived >::get ( gsl_matrix *&  m) const
inline

Assign data in *this into passed m

If m has correct dimensions, data is assigned into m; otherwise m is reallocated before assigning data.

◆ gsl_matrix_p() [1/2]

template<class Derived>
const gsl_matrix* theplu::yat::utility::MatrixExpression< Derived >::gsl_matrix_p ( void  ) const
inline
Returns
underlying data structure

◆ gsl_matrix_p() [2/2]

template<class Derived>
gsl_matrix* theplu::yat::utility::MatrixExpression< Derived >::gsl_matrix_p ( void  )
inline
Returns
underlying data structure

◆ move()

template<class Derived>
void theplu::yat::utility::MatrixExpression< Derived >::move ( gsl_matrix *&  m)
inline

Move data in *this into passed m

Note
Calling this function invalidates data in this.

◆ operator()()

template<class Derived>
double theplu::yat::utility::MatrixExpression< Derived >::operator() ( size_t  row,
size_t  column 
) const
inline
Returns
element in row row and column column

◆ rows()

template<class Derived>
size_t theplu::yat::utility::MatrixExpression< Derived >::rows ( void  ) const
inline
Returns
number of rows

Member Data Documentation

◆ m_

template<class Derived>
gsl_matrix* theplu::yat::utility::MatrixExpression< Derived >::m_
mutableprotected

underlying data


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

Generated on Wed Jan 25 2023 03:34:29 for yat by  doxygen 1.8.14