MIRA
Public Types | Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
Size< T, D > Class Template Reference

Size class for defining sizes with different data types. More...

#include <geometry/Size.h>

Inheritance diagram for Size< T, D >:
Inheritance graph
[legend]

Public Types

typedef Eigen::Matrix< T, D, 1 > BaseType
 
typedef Point< T, D > PointType
 
typedef class Eigen::Map< Matrix, Aligned > AlignedMapType
 
typedef class Eigen::Map< Matrix, Unaligned > UnalignedMapType
 

Public Member Functions

 Size ()
 the default constructor More...
 
template<typename MatrixDerived >
 Size (const Eigen::MatrixBase< MatrixDerived > &matrix)
 a constructor to initialize width and height with a Eigen-matrix of correct dimension More...
 
const Base & base () const
 
Base & base ()
 
const Scalar & coeff (int index) const
 
const Scalar & coeff (int row, int col) const
 
Scalar & coeffRef (int index)
 
Scalar & coeffRef (int row, int col)
 
int cols () const
 
Scalar * data ()
 
const Scalar * data () const
 
PacketScalar packet (int index) const
 
PacketScalar packet (int row, int col) const
 
void resize (int size)
 
void resize (int rows, int cols)
 
int rows () const
 
MatrixsetConstant (int rows, int cols, const Scalar &value)
 
MatrixsetConstant (int size, const Scalar &value)
 
MatrixsetIdentity (int rows, int cols)
 
MatrixsetOnes (int rows, int cols)
 
MatrixsetOnes (int size)
 
MatrixsetRandom (int rows, int cols)
 
MatrixsetRandom (int size)
 
MatrixsetZero (int rows, int cols)
 
MatrixsetZero (int size)
 
int stride (void) const
 
void swap (const MatrixBase< OtherDerived > &other)
 
void writePacket (int index, const PacketScalar &x)
 
void writePacket (int row, int col, const PacketScalar &x)
 

Static Public Member Functions

static UnalignedMapType Map (Scalar *data, int rows, int cols)
 
static const UnalignedMapType Map (const Scalar *data, int rows, int cols)
 
static UnalignedMapType Map (Scalar *data, int size)
 
static const UnalignedMapType Map (const Scalar *data, int size)
 
static UnalignedMapType Map (Scalar *data)
 
static const UnalignedMapType Map (const Scalar *data)
 
static AlignedMapType MapAligned (Scalar *data, int rows, int cols)
 
static const AlignedMapType MapAligned (const Scalar *data, int rows, int cols)
 
static AlignedMapType MapAligned (Scalar *data, int size)
 
static const AlignedMapType MapAligned (const Scalar *data, int size)
 
static AlignedMapType MapAligned (Scalar *data)
 
static const AlignedMapType MapAligned (const Scalar *data)
 

Protected Attributes

ei_matrix_storage< Scalar, MaxSizeAtCompileTime, RowsAtCompileTime, ColsAtCompileTime, Options > m_storage
 

Detailed Description

template<typename T, int D>
class mira::Size< T, D >

Size class for defining sizes with different data types.

Here the class has two template parameters. T for the data type like float or int, and the second for the number of dimensions of the size.

Member Typedef Documentation

◆ BaseType

typedef Eigen::Matrix<T,D,1> BaseType

◆ PointType

typedef Point<T,D> PointType

Constructor & Destructor Documentation

◆ Size() [1/2]

Size ( )
inline

the default constructor

◆ Size() [2/2]

Size ( const Eigen::MatrixBase< MatrixDerived > &  matrix)
inline

a constructor to initialize width and height with a Eigen-matrix of correct dimension


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