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

Generic matrix. More...

#include <lin/core/types/matrix.hpp>

Inheritance diagram for lin::Matrix< T, R, C, MR, MC >:
lin::internal::Tensor< Matrix< T, R, C, MR, MC > > lin::internal::Base< Matrix< T, R, C, MR, MC > > lin::internal::Mapping< Matrix< T, R, C, MR, MC > > lin::internal::Dimensions< Matrix< T, R, C, MR, MC > > lin::internal::Stream< Matrix< T, R, C, MR, MC > >

Public Types

typedef internal::traits< Matrix< T, R, C, MR, MC > > Traits
 Traits information for this type. More...
 
- Public Types inherited from lin::internal::Tensor< Matrix< T, R, C, MR, MC > >
typedef traits< Matrix< T, R, C, MR, MC > > Traits
 Traits information for this type. More...
 
- Public Types inherited from lin::internal::Base< Matrix< T, R, C, MR, MC > >
typedef traits< Matrix< T, R, C, MR, MC > > Traits
 Traits information for this type. More...
 
- Public Types inherited from lin::internal::Mapping< Matrix< T, R, C, MR, MC > >
typedef traits< Matrix< T, R, C, MR, MC > > Traits
 Traits information for this type. More...
 
- Public Types inherited from lin::internal::Stream< Matrix< T, R, C, MR, MC > >
typedef traits< Matrix< T, R, C, MR, MC > > Traits
 Traits information for this type. More...
 

Public Member Functions

constexpr Matrix (Matrix< T, R, C, MR, MC > const &)=default
 
constexpr Matrix (Matrix< T, R, C, MR, MC > &&)=default
 
constexpr Matrix< T, R, C, MR, MC > & operator= (Matrix< T, R, C, MR, MC > const &)=default
 
constexpr Matrix< T, R, C, MR, MC > & operator= (Matrix< T, R, C, MR, MC > &&)=default
 
- Public Member Functions inherited from lin::internal::Tensor< Matrix< T, R, C, MR, MC > >
constexpr Tensor (Tensor< Matrix< T, R, C, MR, MC > > const &)=default
 
constexpr Tensor (Tensor< Matrix< T, R, C, MR, MC > > &&)=default
 
constexpr Tensor ()
 Constructs a new tensor with zeros initialized elements and the largest allowable dimensions. More...
 
constexpr Tensor (size_t r, size_t c)
 Constructs a tensor with zeros initialized elements and the requested dimensions. More...
 
constexpr Tensor (std::initializer_list< T > const &list)
 Constructs a tensor with elements initialized from an initializer list. More...
 
constexpr Tensor (size_t r, size_t c, std::initializer_list< T > const &list)
 Constructs a tensor with elements initialized from an initializer list and the requested dimensions. More...
 
constexpr Tensor (Stream< C > const &s)
 Constructs a tensor by copying in dimensions and elements from another tensor stream. More...
 
constexpr Tensor< Matrix< T, R, C, MR, MC > > & operator= (Tensor< Matrix< T, R, C, MR, MC > > const &)=default
 
constexpr Tensor< Matrix< T, R, C, MR, MC > > & operator= (Tensor< Matrix< T, R, C, MR, MC > > &&)=default
 
constexpr Traits::elem_tdata ()
 Retrives a pointer to the element backing array. More...
 
- Public Member Functions inherited from lin::internal::Base< Matrix< T, R, C, MR, MC > >
constexpr Base (Base< Matrix< T, R, C, MR, MC > > const &)=default
 
constexpr Base (Base< Matrix< T, R, C, MR, MC > > &&)=default
 
constexpr Base< Matrix< T, R, C, MR, MC > > & operator= (Base< Matrix< T, R, C, MR, MC > > const &)=default
 
constexpr Base< Matrix< T, R, C, MR, MC > > & operator= (Base< Matrix< T, R, C, MR, MC > > &&)=default
 
constexpr Traits::elem_tdata ()
 Retrives a pointer to the element backing array. More...
 
constexpr Traits::elem_t const * data () const
 Retrives a constant pointer to the element backing array. More...
 
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< Matrix< T, R, C, MR, MC > >
constexpr Mapping (Mapping< Matrix< T, R, C, MR, MC > > const &)=default
 
constexpr Mapping (Mapping< Matrix< T, R, C, MR, MC > > &&)=default
 
constexpr Mapping< Matrix< T, R, C, MR, MC > > & operator= (Mapping< Matrix< T, R, C, MR, MC > > const &)=default
 
constexpr Mapping< Matrix< T, R, C, MR, MC > > & operator= (Mapping< Matrix< T, R, C, MR, MC > > &&)=default
 
constexpr Matrix< T, R, C, MR, MC > & operator= (std::initializer_list< T > const &list)
 Copy an initializer list's elements into the tensor's elements. More...
 
constexpr Matrix< T, 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< Matrix< T, R, C, MR, MC > >
constexpr Stream (Stream< Matrix< T, R, C, MR, MC > > const &)=default
 
constexpr Stream (Stream< Matrix< T, R, C, MR, MC > > &&)=default
 
constexpr Stream< Matrix< T, R, C, MR, MC > > & operator= (Stream< Matrix< T, R, C, MR, MC > > const &)=default
 
constexpr Stream< Matrix< T, R, C, MR, MC > > & operator= (Stream< Matrix< T, 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< Matrix< T, R, C, MR, MC > >
constexpr Dimensions (Dimensions< Matrix< T, R, C, MR, MC > > const &)=default
 
constexpr Dimensions (Dimensions< Matrix< T, R, C, MR, MC > > &&)=default
 
constexpr Dimensions< Matrix< T, R, C, MR, MC > > & operator= (Dimensions< Matrix< T, R, C, MR, MC > > const &)=default
 
constexpr Dimensions< Matrix< T, R, C, MR, MC > > & operator= (Dimensions< Matrix< T, 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< Matrix< T, R, C, MR, MC > >
constexpr Matrix< T, R, C, MR, MC > & derived ()
 
constexpr Matrix< T, R, C, MR, MC >const & derived () const
 

Detailed Description

template<typename T, size_t R, size_t C, size_t MR = R, size_t MC = C>
class lin::Matrix< T, R, C, MR, MC >

Generic matrix.

Template Parameters
TMatrix element type.
RRows at compile time.
CColumns at compile time.
MRMaximum rows at compile time.
MCMaximum columns at compile time.

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

See also
internal::traits
internal::is_matrix

Member Typedef Documentation

template<typename T, size_t R, size_t C, size_t MR = R, size_t MC = C>
typedef internal::traits<Matrix<T, R, C, MR, MC> > lin::Matrix< T, 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: