QVTensorIndex Class Reference
[Math functionality]

Indexes for tensors. More...

#include <QVTensorIndex>

List of all members.

Public Member Functions
	QVTensorIndex (const int dimension)
	Creates a new index name object.
	QVTensorIndex (const QVTensorIndex &tensorIndex)
	Copy constructor for tensor index name objects.
QVTensorIndex	cov () const
	Gets the covariant version of this index name.
QVTensorIndex	covariant () const
	Gets the covariant version of this index name.
QVTensorIndexRange	range (const int min, const int max) const
	Gets a value state containing a range of integer values for the index name.
const QVTensorIndexRange	operator[] (const int value) const
	Gets a value state containing an integer, for the index name.

---

Detailed Description

Indexes for tensors.

The valence of a particular tensor is the number and type of array indices. QVTensorIndex class can be used to create index objects, and compose list of them to indicate the valence of a tensor, at construction.

See QVTensor class for detailed usage.

See also:

QVTensor

Definition at line 119 of file qvtensorindex.h.

---

Constructor & Destructor Documentation

QVTensorIndex::QVTensorIndex

(

const int

dimension

)

[inline]

Creates a new index name object.

Definition at line 124 of file qvtensorindex.h.

Referenced by cov(), and covariant().

QVTensorIndex::QVTensorIndex

(

const QVTensorIndex &

tensorIndex

)

[inline]

Copy constructor for tensor index name objects.

Copies an index.

Definition at line 129 of file qvtensorindex.h.

---

Member Function Documentation

QVTensorIndex QVTensorIndex::cov

(

)

const [inline]

Gets the covariant version of this index name.

Returns:

a QVTensorIndex object, which is the covariant version of the original one

Definition at line 133 of file qvtensorindex.h.

QVTensorIndex QVTensorIndex::covariant

(

)

const [inline]

Gets the covariant version of this index name.

Returns:

a QVTensorIndex object, which is the covariant version of the original one

Definition at line 137 of file qvtensorindex.h.

QVTensorIndexRange QVTensorIndex::range	(	const int	min,
		const int	max
	)			const [inline]

Gets a value state containing a range of integer values for the index name.

Returns:

an object containing a range of values for the index name

Definition at line 141 of file qvtensorindex.h.

const QVTensorIndexRange QVTensorIndex::operator[]

(

const int

value

)

const [inline]

Gets a value state containing an integer, for the index name.

Returns:

an object containing the value for the index name

Definition at line 145 of file qvtensorindex.h.

---

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

• src/qvmath/qvtensorindex.h
• src/qvmath/qvtensorindex.cpp