lin
Public Types | Public Member Functions | List of all members
lin::internal::MatrixMappingReference< E, R, C, MR, MC > Class Template Reference

Generic matrix reference with read and write access. More...

#include <lin/references/matrix_mapping_reference.hpp>

Inheritance diagram for lin::internal::MatrixMappingReference< E, R, C, MR, MC >:
lin::internal::TensorMappingReference< MatrixMappingReference< E, R, C, MR, MC >, E > lin::internal::Mapping< MatrixMappingReference< E, R, C, MR, MC > > lin::internal::Dimensions< MatrixMappingReference< E, R, C, MR, MC > > lin::internal::Stream< MatrixMappingReference< E, R, C, MR, MC > >

Public Types

typedef traits< MatrixMappingReference< E, R, C, MR, MC > > Traits
 Traits information for this type. More...
 
- Public Types inherited from lin::internal::TensorMappingReference< MatrixMappingReference< E, R, C, MR, MC >, E >
typedef traits< MatrixMappingReference< E, R, C, MR, MC > > Traits
 Traits information for this type. More...
 
- Public Types inherited from lin::internal::Mapping< MatrixMappingReference< E, R, C, MR, MC > >
typedef traits< MatrixMappingReference< E, R, C, MR, MC > > Traits
 Traits information for this type. More...
 
- Public Types inherited from lin::internal::Stream< MatrixMappingReference< E, R, C, MR, MC > >
typedef traits< MatrixMappingReference< E, R, C, MR, MC > > Traits
 Traits information for this type. More...
 

Public Member Functions

constexpr MatrixMappingReference (MatrixMappingReference< E, R, C, MR, MC > const &)=default
 
constexpr MatrixMappingReference (MatrixMappingReference< E, R, C, MR, MC > &&)=default
 
constexpr MatrixMappingReference< E, R, C, MR, MC > & operator= (MatrixMappingReference< E, R, C, MR, MC > const &)=default
 
constexpr MatrixMappingReference< E, R, C, MR, MC > & operator= (MatrixMappingReference< E, R, C, MR, MC > &&)=default
 
- Public Member Functions inherited from lin::internal::TensorMappingReference< MatrixMappingReference< E, R, C, MR, MC >, E >
constexpr TensorMappingReference (TensorMappingReference< MatrixMappingReference< E, R, C, MR, MC >, E > const &)=default
 
constexpr TensorMappingReference (TensorMappingReference< MatrixMappingReference< E, R, C, MR, MC >, E > &&)=default
 
constexpr TensorMappingReference (Mapping< E > &mapping, size_t i, size_t j)
 Constructs a new reference with the provided mapping and anchor point. More...
 
constexpr TensorMappingReference (Mapping< E > &mapping, size_t i, size_t j, size_t r, size_t c)
 Constructs a new reference with the provided mapping, anchor point, and dimensions. More...
 
constexpr TensorMappingReference< MatrixMappingReference< E, R, C, MR, MC >, E > & operator= (TensorMappingReference< MatrixMappingReference< E, R, C, MR, MC >, E > const &)=default
 
constexpr TensorMappingReference< MatrixMappingReference< E, R, C, MR, MC >, E > & operator= (TensorMappingReference< MatrixMappingReference< E, R, C, MR, MC >, E > &&)=default
 
constexpr Traits::elem_toperator() (size_t i, size_t j)
 Provides read and write access to tensor elements. More...
 
constexpr Traits::elem_toperator() (size_t i)
 Provides read and write access to tensor elements. More...
 
- Public Member Functions inherited from lin::internal::Mapping< MatrixMappingReference< E, R, C, MR, MC > >
constexpr Mapping (Mapping< MatrixMappingReference< E, R, C, MR, MC > > const &)=default
 
constexpr Mapping (Mapping< MatrixMappingReference< E, R, C, MR, MC > > &&)=default
 
constexpr Mapping< MatrixMappingReference< E, R, C, MR, MC > > & operator= (Mapping< MatrixMappingReference< E, R, C, MR, MC > > const &)=default
 
constexpr Mapping< MatrixMappingReference< E, R, C, MR, MC > > & operator= (Mapping< MatrixMappingReference< E, R, C, MR, MC > > &&)=default
 
constexpr MatrixMappingReference< E, R, C, MR, MC > & operator= (std::initializer_list< T > const &list)
 Copy an initializer list's elements into the tensor's elements. More...
 
constexpr MatrixMappingReference< E, R, C, MR, MC > & operator= (Stream< C > const &s)
 Copy another tensor's elements into this tenosr's elements. More...
 
constexpr Traits::elem_toperator() (size_t i, size_t j)
 Provides read and write access to tensor elements. More...
 
constexpr Traits::elem_t operator() (size_t i, size_t j) const
 Provides read only access to tensor elements. More...
 
constexpr Traits::elem_toperator() (size_t i)
 Provides read and write access to tensor elements. More...
 
constexpr Traits::elem_t operator() (size_t i) const
 Provides read only access to tensor elements. More...
 
constexpr Traits::elem_toperator[] (size_t i)
 Provides read and write access to tensor elements. More...
 
constexpr Traits::elem_t operator[] (size_t i) const
 Provides read only access to tensor elements. More...
 
- Public Member Functions inherited from lin::internal::Stream< MatrixMappingReference< E, R, C, MR, MC > >
constexpr Stream (Stream< MatrixMappingReference< E, R, C, MR, MC > > const &)=default
 
constexpr Stream (Stream< MatrixMappingReference< E, R, C, MR, MC > > &&)=default
 
constexpr Stream< MatrixMappingReference< E, R, C, MR, MC > > & operator= (Stream< MatrixMappingReference< E, R, C, MR, MC > > const &)=default
 
constexpr Stream< MatrixMappingReference< E, R, C, MR, MC > > & operator= (Stream< MatrixMappingReference< E, R, C, MR, MC > > &&)=default
 
constexpr size_t rows () const
 
constexpr size_t cols () const
 
constexpr size_t size () const
 
constexpr Traits::elem_t operator() (size_t i, size_t j) const
 Provides read only access to tensor elements. More...
 
constexpr Traits::elem_t operator() (size_t i) const
 Provides read only access to tensor elements. More...
 
constexpr Traits::elem_t operator[] (size_t i) const
 Provides read only access to tensor elements. More...
 
constexpr Traits::eval_t eval () const
 Forces evaluation of this stream to a value backed type. More...
 
- Public Member Functions inherited from lin::internal::Dimensions< MatrixMappingReference< E, R, C, MR, MC > >
constexpr Dimensions (Dimensions< MatrixMappingReference< E, R, C, MR, MC > > const &)=default
 
constexpr Dimensions (Dimensions< MatrixMappingReference< E, R, C, MR, MC > > &&)=default
 
constexpr Dimensions< MatrixMappingReference< E, R, C, MR, MC > > & operator= (Dimensions< MatrixMappingReference< E, R, C, MR, MC > > const &)=default
 
constexpr Dimensions< MatrixMappingReference< E, R, C, MR, MC > > & operator= (Dimensions< MatrixMappingReference< E, R, C, MR, MC > > &&)=default
 
constexpr size_t rows () const
 
constexpr size_t cols () const
 
constexpr void resize (size_t r, size_t c)
 Resizes a tensor's dimensions. More...
 

Additional Inherited Members

- Protected Member Functions inherited from lin::internal::Stream< MatrixMappingReference< E, R, C, MR, MC > >
constexpr MatrixMappingReference< E, R, C, MR, MC > & derived ()
 
constexpr MatrixMappingReference< E, R, C, MR, MC >const & derived () const
 

Detailed Description

template<class E, size_t R, size_t C, size_t MR, size_t MC>
class lin::internal::MatrixMappingReference< E, R, C, MR, MC >

Generic matrix reference with read and write access.

Template Parameters
EUnderlying referenced type.
RRows at compile time.
CColumns at compile time.
MRMaximum rows at compile time.
MCMaximum columns at compile time.

The template parameters specify the reference's traits. The traits must qualify the type as a matrix.

It's important to note, if the underlying type goes out of scope the reference is invalidated.

See also
internal::TensorMappingReference
internal::traits
internal::is_matrix

Member Typedef Documentation

template<class E , size_t R, size_t C, size_t MR, size_t MC>
typedef traits<MatrixMappingReference<E, R, C, MR, MC> > lin::internal::MatrixMappingReference< E, R, C, MR, MC >::Traits

Traits information for this type.

See also
internal::traits

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