ewalena::TensorTools::VoightMap Class Reference

#include <include/ewalena/base/tensor_tools.h>

Collaboration diagram for ewalena::TensorTools::VoightMap:

List of all members.

Public Types
typedef std::map< std::pair < const unsigned int, const unsigned int >, const unsigned int >	IndexSetMap
typedef IndexSetMap::iterator	VoightMapIterator
Public Member Functions
VoightMapIterator	begin () const
VoightMapIterator	end () const
unsigned int	operator() (const unsigned int i, const unsigned int j) const
VoightMap	operator* () const
Static Public Attributes
static IndexSetMap	voight_map

---

Detailed Description

Voigt notation or Voigt form in multilinear algebra is a way to represent a symmetric tensor by reducing its order. Voight indices describe the mapping between a symmetric tensor and and it's matrix form.

Author:

Toby D. Young 2012.

---

Member Typedef Documentation

typedef std::map<std::pair<const unsigned int, const unsigned int>, const unsigned int> ewalena::TensorTools::VoightMap::IndexSetMap

Type definition of an index set map.

typedef IndexSetMap::iterator ewalena::TensorTools::VoightMap::VoightMapIterator

Forward-backward iterator.

---

Member Function Documentation

VoightMapIterator ewalena::TensorTools::VoightMap::begin

(

)

const [inline]

Read only access to the beginning of this voight map.

VoightMapIterator ewalena::TensorTools::VoightMap::end

(

)

const [inline]

Read only access to the end of this voight map.

unsigned int ewalena::TensorTools::VoightMap::operator()	(	const unsigned int	i,
		const unsigned int	j
	)		const [inline]

Read only operator that returns the Voight index of these two tensor indices .

VoightMap ewalena::TensorTools::VoightMap::operator*

(

)

const [inline]

Access operator to the underlying std::map.

---

Member Data Documentation

IndexSetMap ewalena::TensorTools::VoightMap::voight_map [static]

Static object that defines the mapping of Voight between a tensor and a matrix.

---

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

• include/ewalena/base/tensor_tools.h