itk::VariableSizeMatrix< T > Class Template Reference

#include <itkVariableSizeMatrix.h>

Inheritance diagram for itk::VariableSizeMatrix< T >:

Detailed Description

template<typename T>
class itk::VariableSizeMatrix< T >

A templated class holding a M x N size Matrix.

This class contains a vnl_matrix in order to make all the vnl mathematical methods available. This class is meant to be used when the matrix length cannot be determined at compile time.

Definition at line 44 of file itkVariableSizeMatrix.h.

Public Types
using	ComponentType = T
using	InternalMatrixType = vnl_matrix< T >
using	Self = VariableSizeMatrix
using	ValueType = T

Public Member Functions
unsigned int	Cols () const
void	Fill (const T &value)
vnl_matrix< T >	GetTranspose () const
InternalMatrixType &	GetVnlMatrix ()
const InternalMatrixType &	GetVnlMatrix () const
bool	operator!= (const Self &matrix) const
T &	operator() (unsigned int row, unsigned int col)
const T &	operator() (unsigned int row, unsigned int col) const
Array< T >	operator* (const Array< T > &vector) const
Self	operator* (const Self &matrix) const
vnl_matrix< T >	operator* (const vnl_matrix< T > &matrix) const
vnl_vector< T >	operator* (const vnl_vector< T > &matrix) const
Self	operator* (const T &value)
void	operator*= (const Self &matrix)
void	operator*= (const vnl_matrix< T > &matrix)
void	operator*= (const T &value)
Self	operator+ (const Self &matrix) const
const Self &	operator+= (const Self &matrix)
Self	operator- (const Self &matrix) const
Self &	operator- ()
const Self &	operator-= (const Self &matrix)
Self	operator/ (const T &value)
void	operator/= (const T &value)
const Self &	operator= (const vnl_matrix< T > &matrix)
const Self &	operator= (const Self &matrix)
T *	operator[] (unsigned int i)
const T *	operator[] (unsigned int i) const
unsigned int	Rows () const
void	SetIdentity ()
bool	SetSize (unsigned int r, unsigned int c)
	VariableSizeMatrix ()
	VariableSizeMatrix (unsigned int rows, unsigned int cols)
	VariableSizeMatrix (const Self &matrix)
bool	operator== (const Self &matrix) const
vnl_matrix< T >	GetInverse () const

Private Attributes
InternalMatrixType	m_Matrix

Member Typedef Documentation

template<typename T>

using itk::VariableSizeMatrix< T >::ComponentType = T

Definition at line 52 of file itkVariableSizeMatrix.h.

template<typename T>

using itk::VariableSizeMatrix< T >::InternalMatrixType = vnl_matrix< T >

Internal matrix type

Definition at line 55 of file itkVariableSizeMatrix.h.

template<typename T>

using itk::VariableSizeMatrix< T >::Self = VariableSizeMatrix

Standard class type aliases.

Definition at line 48 of file itkVariableSizeMatrix.h.

template<typename T>

using itk::VariableSizeMatrix< T >::ValueType = T

Component value type

Definition at line 51 of file itkVariableSizeMatrix.h.

Constructor & Destructor Documentation

template<typename T>

itk::VariableSizeMatrix< T >::VariableSizeMatrix ( )

inline

Default constructor.

Definition at line 197 of file itkVariableSizeMatrix.h.

template<typename T>

itk::VariableSizeMatrix< T >::VariableSizeMatrix	(	unsigned int	rows,
		unsigned int	cols
	)

template<typename T>

itk::VariableSizeMatrix< T >::VariableSizeMatrix ( const Self &  matrix )

inline

Copy constructor.

Definition at line 202 of file itkVariableSizeMatrix.h.

Member Function Documentation

template<typename T>

unsigned int itk::VariableSizeMatrix< T >::Cols ( ) const

inline

Return number of columns in the matrix

Definition at line 208 of file itkVariableSizeMatrix.h.

Referenced by itk::DefaultConvertPixelTraits< VariableSizeMatrix< VComponent > >::GetNthComponent(), itk::DefaultConvertPixelTraits< VariableSizeMatrix< VComponent > >::GetNumberOfComponents(), itk::VariableSizeMatrix< T >::operator==(), itk::DefaultConvertPixelTraits< VariableSizeMatrix< VComponent > >::SetNthComponent(), and itk::MeshIOBase::SetPixelType().

template<typename T>

void itk::VariableSizeMatrix< T >::Fill ( const T &  value )

inline

Fill the matrix with a value.

Definition at line 155 of file itkVariableSizeMatrix.h.

template<typename T>

vnl_matrix< T > itk::VariableSizeMatrix< T >::GetInverse ( ) const

inline

Return the inverse matrix.

Definition at line 183 of file itkVariableSizeMatrix.h.

template<typename T>

vnl_matrix< T > itk::VariableSizeMatrix< T >::GetTranspose ( ) const

inline

Return the transposed matrix.

Definition at line 191 of file itkVariableSizeMatrix.h.

template<typename T>

InternalMatrixType& itk::VariableSizeMatrix< T >::GetVnlMatrix ( )

inline

Return the matrix.

Definition at line 137 of file itkVariableSizeMatrix.h.

Referenced by itk::operator<<().

template<typename T>

const InternalMatrixType& itk::VariableSizeMatrix< T >::GetVnlMatrix ( ) const

inline

Return the matrix.

Definition at line 143 of file itkVariableSizeMatrix.h.

template<typename T>

bool itk::VariableSizeMatrix< T >::operator!= ( const Self &  matrix ) const

inline

Definition at line 170 of file itkVariableSizeMatrix.h.

template<typename T>

T& itk::VariableSizeMatrix< T >::operator() ( unsigned int  row, unsigned int  col  )

inline

Return an element of the matrix.

Definition at line 113 of file itkVariableSizeMatrix.h.

template<typename T>

const T& itk::VariableSizeMatrix< T >::operator() ( unsigned int  row, unsigned int  col  ) const

inline

Return an element of the matrix.

Definition at line 119 of file itkVariableSizeMatrix.h.

template<typename T>

Array< T > itk::VariableSizeMatrix< T >::operator*

(

const Array< T > &

vector

)

const

Matrix by Vector multiplication.

template<typename T>

Self itk::VariableSizeMatrix< T >::operator*

(

const Self &

matrix

)

const

Matrix by Matrix multiplication.

template<typename T>

vnl_matrix< T > itk::VariableSizeMatrix< T >::operator*

(

const vnl_matrix< T > &

matrix

)

const

Matrix by vnl_matrix multiplication.

template<typename T>

vnl_vector< T > itk::VariableSizeMatrix< T >::operator*

(

const vnl_vector< T > &

matrix

)

const

Matrix by vnl_vector multiplication.

template<typename T>

Self itk::VariableSizeMatrix< T >::operator* ( const T &  value )

inline

Matrix by scalar multiplication.

Definition at line 92 of file itkVariableSizeMatrix.h.

template<typename T>

void itk::VariableSizeMatrix< T >::operator*=

(

const Self &

matrix

)

Matrix by Matrix multiplication.

template<typename T>

void itk::VariableSizeMatrix< T >::operator*=

(

const vnl_matrix< T > &

matrix

)

Matrix by vnl_matrix multiplication.

template<typename T>

void itk::VariableSizeMatrix< T >::operator*= ( const T &  value )

inline

Matrix by scalar multiplication.

Definition at line 89 of file itkVariableSizeMatrix.h.

template<typename T>

Self itk::VariableSizeMatrix< T >::operator+

(

const Self &

matrix

)

const

Matrix addition.

template<typename T>

const Self& itk::VariableSizeMatrix< T >::operator+=

(

const Self &

matrix

)

template<typename T>

Self itk::VariableSizeMatrix< T >::operator-

(

const Self &

matrix

)

const

Matrix addition.

template<typename T>

Self& itk::VariableSizeMatrix< T >::operator-

(

)

negation operator

template<typename T>

const Self& itk::VariableSizeMatrix< T >::operator-=

(

const Self &

matrix

)

template<typename T>

Self itk::VariableSizeMatrix< T >::operator/ ( const T &  value )

inline

Matrix by scalar division.

Definition at line 104 of file itkVariableSizeMatrix.h.

template<typename T>

void itk::VariableSizeMatrix< T >::operator/= ( const T &  value )

inline

Matrix by scalar division.

Definition at line 101 of file itkVariableSizeMatrix.h.

template<typename T>

const Self& itk::VariableSizeMatrix< T >::operator= ( const vnl_matrix< T > &  matrix )

inline

Assignment operator.

Definition at line 161 of file itkVariableSizeMatrix.h.

template<typename T>

const Self& itk::VariableSizeMatrix< T >::operator= ( const Self &  matrix )

inline

Assignment operator.

Definition at line 176 of file itkVariableSizeMatrix.h.

template<typename T >

bool itk::VariableSizeMatrix< T >::operator== ( const Self &  matrix ) const

inline

Comparison operators.

Comparison

Definition at line 231 of file itkVariableSizeMatrix.h.

References itk::VariableSizeMatrix< T >::Cols(), itk::VariableSizeMatrix< T >::m_Matrix, itk::Math::NotExactlyEquals(), and itk::VariableSizeMatrix< T >::Rows().

template<typename T>

T* itk::VariableSizeMatrix< T >::operator[] ( unsigned int  i )

inline

Return a row of the matrix.

Definition at line 125 of file itkVariableSizeMatrix.h.

template<typename T>

const T* itk::VariableSizeMatrix< T >::operator[] ( unsigned int  i ) const

inline

Return a row of the matrix.

Definition at line 131 of file itkVariableSizeMatrix.h.

template<typename T>

unsigned int itk::VariableSizeMatrix< T >::Rows ( ) const

inline

Return number of rows in the matrix

Definition at line 205 of file itkVariableSizeMatrix.h.

Referenced by itk::DefaultConvertPixelTraits< VariableSizeMatrix< VComponent > >::GetNumberOfComponents(), itk::VariableSizeMatrix< T >::operator==(), and itk::MeshIOBase::SetPixelType().

template<typename T>

void itk::VariableSizeMatrix< T >::SetIdentity ( )

inline

Set the matrix to identity.

Definition at line 149 of file itkVariableSizeMatrix.h.

template<typename T>

bool itk::VariableSizeMatrix< T >::SetSize ( unsigned int  r, unsigned int  c  )

inline

Set the matrix size. Old data lost. Returns true if size changed.

Definition at line 211 of file itkVariableSizeMatrix.h.

Member Data Documentation

template<typename T>

InternalMatrixType itk::VariableSizeMatrix< T >::m_Matrix

private

Definition at line 214 of file itkVariableSizeMatrix.h.

Referenced by itk::VariableSizeMatrix< double >::operator=(), and itk::VariableSizeMatrix< T >::operator==().

---

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

• itkVariableSizeMatrix.h