QTensorIndex Class Reference

Indexes for tensors. More...

#include <qtensor/qtensorindex.h>

List of all members.

Public Member Functions

 QTensorIndex (const int dimension)
 Creates a new index name object.
 QTensorIndex (const QTensorIndex &tensorIndex)
 Copy constructor for tensor index name objects.
QTensorIndex cov () const
 Gets the covariant version of this index name.
QTensorIndex covariant () const
 Gets the covariant version of this index name.
QTensorIndexRange range (const int min, const int max) const
 Gets a value state containing a range of integer values for the index name.
const QTensorIndexRange 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. QTensorIndex class can be used to create index objects, and compose list of them to indicate the valence of a tensor, at construction.

See QTensor class for detailed usage.

See also:
QTensor

Definition at line 130 of file qtensorindex.h.


Constructor & Destructor Documentation

QTensorIndex::QTensorIndex ( const QTensorIndex tensorIndex  )  [inline]

Copy constructor for tensor index name objects.

Copies an index.

Definition at line 141 of file qtensorindex.h.


Member Function Documentation

QTensorIndex QTensorIndex::cov (  )  const [inline]

Gets the covariant version of this index name.

Returns:
a QTensorIndex object, which is the covariant version of the original one

Definition at line 145 of file qtensorindex.h.

References QTensorIndex().

QTensorIndex QTensorIndex::covariant (  )  const [inline]

Gets the covariant version of this index name.

Returns:
a QTensorIndex object, which is the covariant version of the original one

Definition at line 149 of file qtensorindex.h.

References QTensorIndex().

QTensorIndexRange QTensorIndex::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 153 of file qtensorindex.h.

References ABS.

const QTensorIndexRange QTensorIndex::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 157 of file qtensorindex.h.

References ABS.


The documentation for this class was generated from the following files:
Generated on Thu Mar 13 19:18:17 2008 for QVision by  doxygen 1.5.3