A class that represents the type of a general math tensor. More...

#include <omTensorType.h>

Public Member Functions
	TensorType ()
	Create an undefined tensor type with 0 rows and columns. More...

	TensorType (const ScalarType &newScalarType)
	Create a scalar tensor type for the specified scalar type. More...

	TensorType (ScalarType::Enum newScalarType)
	Create a scalar tensor type for the specified scalar type. More...

	TensorType (ScalarType::Enum newScalarType, Size newSize0)
	Create a vector tensor type for the specified scalar type and number of components (rows). More...

	TensorType (ScalarType::Enum newScalarType, Size newSize0, Size newSize1)
	Create a matrix tensor type for the specified scalar type and number of rows/columns. More...

	TensorType (ScalarType::Enum newScalarType, Size newSize0, Size newSize1, Size newSize2)
	Create a 3D matrix tensor type for the specified scalar type and dimensions. More...

Bool	operator== (const TensorType &other) const
	Return whether or not this tensor type is equal to another. More...

Bool	operator!= (const TensorType &other) const
	Return whether or not this tensor type is not equal to another. More...

Bool	isFloatingPoint () const
	Return whether or not this tensor's scalar type is a floating-point format (32 or 64-bit). More...

const ScalarType &	getScalarType () const
	Return the scalar type of this tensor type. More...

void	setScalarType (ScalarType newScalarType)
	Set the scalar type of this tensor type. More...

Size	getSize (Index dimension) const
	Return the size of this tensor type along the specified dimension index. More...

void	setSize (Index dimension, Size newSize)
	Set the size of this tensor type along the specified dimension index. More...

Size	getScalarCount () const
	Return the total number of components that are part of this tensor type. More...

Size	getDimensionCount () const
	Return the number of dimensions in this tensor. More...

Bool	isIndex () const
	Return whether or not this tensor type represents a scalar index type, e.g. unsigned integers. More...

Bool	isScalar () const
	Return whether or not this tensor type represents a scalar type. More...

Bool	isVector () const
	Return whether or not this tensor type represents a vector type. More...

Bool	isMatrix () const
	Return whether or not this tensor type represents a matrix type. More...

Size	getSizeInBytes () const
	Return the size of an tensor with this type in bytes. More...

data::String	toString () const
	Return a string representation of the tensor type. More...

	operator data::String () const
	Convert this tensor type into a string representation. More...

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

template<>
void	check ()

template<>
TensorType	of ()

Static Public Member Functions
template<typename T >
static TensorType	of ()
	Return an TensorType object for the specified templated type. More...

template<typename T >
static void	check ()
	Check to see if the templated type is a supported tensor type. More...

static Size	getMaxDimensionCount ()
	Return the maximum number of dimensions that a tensor can have, 3. More...

Static Public Attributes
static const Size	MAX_DIMENSION_COUNT = 3
	The maximum number of dimensions that a tensor can have, 3. More...

Detailed Description

A class that represents the type of a general math tensor.

A TensorType can represent tensors up to 3 dimensions. It is specified by a ScalarType enumeration indicating the type of the elements of the tensor, plus the size along each of 3 dimensions.

Constructor & Destructor Documentation

om::math::TensorType::TensorType ( )

inline

Create an undefined tensor type with 0 rows and columns.

om::math::TensorType::TensorType ( const ScalarType & newScalarType )

inline

Create a scalar tensor type for the specified scalar type.

om::math::TensorType::TensorType ( ScalarType::Enum newScalarType )

inline

Create a scalar tensor type for the specified scalar type.

om::math::TensorType::TensorType	(	ScalarType::Enum	newScalarType,
		Size	newSize0
	)

inline

Create a vector tensor type for the specified scalar type and number of components (rows).

om::math::TensorType::TensorType	(	ScalarType::Enum	newScalarType,
		Size	newSize0,
		Size	newSize1
	)

inline

Create a matrix tensor type for the specified scalar type and number of rows/columns.

om::math::TensorType::TensorType	(	ScalarType::Enum	newScalarType,
		Size	newSize0,
		Size	newSize1,
		Size	newSize2
	)

inline

Create a 3D matrix tensor type for the specified scalar type and dimensions.

Member Function Documentation

template<typename T >

static TensorType om::math::TensorType::of ( )

inlinestatic

Return an TensorType object for the specified templated type.

This method returns a valid tensor type for all standard scalar/vector/matrix/color types. Calling this empty method will produce a compiler error if the templated type is not a supported tensor type.

template<typename T >

static void om::math::TensorType::check ( )

inlinestatic

Check to see if the templated type is a supported tensor type.

Calling this empty method will produce a compiler error if the templated type is not a supported tensor type.

Bool om::math::TensorType::operator== ( const TensorType & other ) const

inline

Return whether or not this tensor type is equal to another.

Bool om::math::TensorType::operator!= ( const TensorType & other ) const

inline

Return whether or not this tensor type is not equal to another.

Bool om::math::TensorType::isFloatingPoint ( ) const

inline

Return whether or not this tensor's scalar type is a floating-point format (32 or 64-bit).

const ScalarType& om::math::TensorType::getScalarType ( ) const

inline

Return the scalar type of this tensor type.

void om::math::TensorType::setScalarType ( ScalarType newScalarType )

inline

Set the scalar type of this tensor type.

Size om::math::TensorType::getSize ( Index dimension ) const

inline

Return the size of this tensor type along the specified dimension index.

void om::math::TensorType::setSize	(	Index	dimension,
		Size	newSize
	)

inline

Set the size of this tensor type along the specified dimension index.

Size om::math::TensorType::getScalarCount ( ) const

inline

Return the total number of components that are part of this tensor type.

Size om::math::TensorType::getDimensionCount ( ) const

inline

Return the number of dimensions in this tensor.

A scalar has dimension 0, a vector has dimension 1, a matrix has dimension 2, and a 3D matrix has dimension 3.

static Size om::math::TensorType::getMaxDimensionCount ( )

inlinestatic

Return the maximum number of dimensions that a tensor can have, 3.

Bool om::math::TensorType::isIndex ( ) const

inline

Return whether or not this tensor type represents a scalar index type, e.g. unsigned integers.

Bool om::math::TensorType::isScalar ( ) const

inline

Return whether or not this tensor type represents a scalar type.

Bool om::math::TensorType::isVector ( ) const

inline

Return whether or not this tensor type represents a vector type.

Bool om::math::TensorType::isMatrix ( ) const

inline

Return whether or not this tensor type represents a matrix type.

Size om::math::TensorType::getSizeInBytes ( ) const

inline

Return the size of an tensor with this type in bytes.

data::String om::math::TensorType::toString ( ) const

Return a string representation of the tensor type.

om::math::TensorType::operator data::String ( ) const

inline

Convert this tensor type into a string representation.

template<>

void om::math::TensorType::check ( )

inline

template<>