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

Generic matrix reference with read-only access. More...

#include <lin/references/matrix_stream_reference.hpp>

Inheritance diagram for lin::internal::MatrixStreamReference< E, R, C, MR, MC >:
lin::internal::TensorStreamReference< MatrixStreamReference< E, R, C, MR, MC >, E > lin::internal::Stream< MatrixStreamReference< E, R, C, MR, MC > > lin::internal::Dimensions< MatrixStreamReference< E, R, C, MR, MC > >

Public Types

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

Public Member Functions

constexpr MatrixStreamReference (MatrixStreamReference< E, R, C, MR, MC > const &)=default
 
constexpr MatrixStreamReference (MatrixStreamReference< E, R, C, MR, MC > &&)=default
 
constexpr MatrixStreamReference< E, R, C, MR, MC > & operator= (MatrixStreamReference< E, R, C, MR, MC > const &)=default
 
constexpr MatrixStreamReference< E, R, C, MR, MC > & operator= (MatrixStreamReference< E, R, C, MR, MC > &&)=default
 
- Public Member Functions inherited from lin::internal::TensorStreamReference< MatrixStreamReference< E, R, C, MR, MC >, E >
constexpr TensorStreamReference (TensorStreamReference< MatrixStreamReference< E, R, C, MR, MC >, E > const &)=default
 
constexpr TensorStreamReference (TensorStreamReference< MatrixStreamReference< E, R, C, MR, MC >, E > &&)=default
 
constexpr TensorStreamReference (Stream< E > const &stream, size_t i, size_t j)
 Constructs a new reference with the provided stream and anchor point. More...
 
constexpr TensorStreamReference (Stream< E > const &stream, 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 TensorStreamReference< MatrixStreamReference< E, R, C, MR, MC >, E > & operator= (TensorStreamReference< MatrixStreamReference< E, R, C, MR, MC >, E > const &)=default
 
constexpr TensorStreamReference< MatrixStreamReference< E, R, C, MR, MC >, E > & operator= (TensorStreamReference< MatrixStreamReference< E, R, C, MR, MC >, E > &&)=default
 
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...
 
- Public Member Functions inherited from lin::internal::Stream< MatrixStreamReference< E, R, C, MR, MC > >
constexpr Stream (Stream< MatrixStreamReference< E, R, C, MR, MC > > const &)=default
 
constexpr Stream (Stream< MatrixStreamReference< E, R, C, MR, MC > > &&)=default
 
constexpr Stream< MatrixStreamReference< E, R, C, MR, MC > > & operator= (Stream< MatrixStreamReference< E, R, C, MR, MC > > const &)=default
 
constexpr Stream< MatrixStreamReference< E, R, C, MR, MC > > & operator= (Stream< MatrixStreamReference< 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< MatrixStreamReference< E, R, C, MR, MC > >
constexpr Dimensions (Dimensions< MatrixStreamReference< E, R, C, MR, MC > > const &)=default
 
constexpr Dimensions (Dimensions< MatrixStreamReference< E, R, C, MR, MC > > &&)=default
 
constexpr Dimensions< MatrixStreamReference< E, R, C, MR, MC > > & operator= (Dimensions< MatrixStreamReference< E, R, C, MR, MC > > const &)=default
 
constexpr Dimensions< MatrixStreamReference< E, R, C, MR, MC > > & operator= (Dimensions< MatrixStreamReference< 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< MatrixStreamReference< E, R, C, MR, MC > >
constexpr MatrixStreamReference< E, R, C, MR, MC > & derived ()
 
constexpr MatrixStreamReference< 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::MatrixStreamReference< E, R, C, MR, MC >

Generic matrix reference with read-only 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::TensorStreamReference
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<MatrixStreamReference<E, R, C, MR, MC> > lin::internal::MatrixStreamReference< 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: