NiHu  2.0
NiHu::mex::index_proxy< Parent > Class Template Reference

index proxy class of a complex matrix More...

#include <mex_matrix_separate.hpp>

Public Types

typedef Parent::scalar_t scalar_t
 the scalar type of the parent class
 

Public Member Functions

 index_proxy (Parent &matrix, size_t row, size_t col)
 constructor More...
 
 operator std::complex< scalar_t > () const
 conversion of element to complex number More...
 
scalar_treal (void) const
 return reference to the real part More...
 
scalar_timag (void) const
 return reference to the imaginary part More...
 
template<class complex_rhs_t >
void operator= (complex_rhs_t const &data) const
 assignment operator More...
 
template<class complex_rhs_t >
void operator+= (complex_rhs_t const &data) const
 increment operator More...
 
void operator= (scalar_t const &data)
 assignment operator More...
 
void operator+= (scalar_t const &data)
 increment operator More...
 

Detailed Description

template<class Parent>
class NiHu::mex::index_proxy< Parent >

index proxy class of a complex matrix

Definition at line 167 of file mex_matrix_separate.hpp.

Constructor & Destructor Documentation

◆ index_proxy()

template<class Parent >
NiHu::mex::index_proxy< Parent >::index_proxy ( Parent &  matrix,
size_t  row,
size_t  col 
)
inline

constructor

Parameters
matrixthe parent container class
rowthe row index
colthe column index

Definition at line 178 of file mex_matrix_separate.hpp.

Member Function Documentation

◆ imag()

template<class Parent >
scalar_t& NiHu::mex::index_proxy< Parent >::imag ( void  ) const
inline

return reference to the imaginary part

Returns
reference to the imaginary part of the complex element

Definition at line 202 of file mex_matrix_separate.hpp.

◆ operator std::complex< scalar_t >()

template<class Parent >
NiHu::mex::index_proxy< Parent >::operator std::complex< scalar_t > ( ) const
inline

conversion of element to complex number

Returns
the complex number

Definition at line 186 of file mex_matrix_separate.hpp.

◆ operator+=() [1/2]

template<class Parent >
template<class complex_rhs_t >
void NiHu::mex::index_proxy< Parent >::operator+= ( complex_rhs_t const &  data) const
inline

increment operator

Parameters
datathe data to add to the container

Definition at line 221 of file mex_matrix_separate.hpp.

◆ operator+=() [2/2]

template<class Parent >
void NiHu::mex::index_proxy< Parent >::operator+= ( scalar_t const &  data)
inline

increment operator

Parameters
datathe data to add to the container

Definition at line 239 of file mex_matrix_separate.hpp.

◆ operator=() [1/2]

template<class Parent >
template<class complex_rhs_t >
void NiHu::mex::index_proxy< Parent >::operator= ( complex_rhs_t const &  data) const
inline

assignment operator

Parameters
datathe data to assign to the container

Definition at line 211 of file mex_matrix_separate.hpp.

◆ operator=() [2/2]

template<class Parent >
void NiHu::mex::index_proxy< Parent >::operator= ( scalar_t const &  data)
inline

assignment operator

Parameters
datathe data to assign to the container

Definition at line 230 of file mex_matrix_separate.hpp.

◆ real()

template<class Parent >
scalar_t& NiHu::mex::index_proxy< Parent >::real ( void  ) const
inline

return reference to the real part

Returns
reference to the real part of the complex element

Definition at line 194 of file mex_matrix_separate.hpp.


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