cc.redberry.core.indices

Interface SimpleIndices

All Superinterfaces:

Indices

public interface SimpleIndices
extends Indices

Additional specification for indices of simple tensors (see SimpleTensor). SimpleIndices preserves the relative ordering of indices with the same type.

Since:

1.0

See Also:

Indices, IndicesFactory, SimpleIndicesBuilder

Method Summary

Modifier and Type	Method and Description
SimpleIndices	applyIndexMapping(IndexMapping im) This method applies specified IndexMapping to this Indices object and returns the resulting Indices object.
boolean	equalsWithSymmetries(SimpleIndices indices) Compares simple indices taking into account possible permutations according to the symmetries.
SimpleIndices	getFree() Returns new instance of Indices, which contains only free (non contracted) indices from this Indices instance.
SimpleIndices	getInverted() Returns new instance of Indices, which contains inverted indices, i.e.
SimpleIndices	getLower() Returns lower (covariant) indices.
SimpleIndices	getOfType(IndexType type) Returns indices of the specified type, which are contained in this Indices object.
StructureOfIndices	getStructureOfIndices() Returns the structure of this indices.
IndicesSymmetries	getSymmetries() Returns IndicesSymmetries of this Indices.
SimpleIndices	getUpper() Returns upper (contravariant) indices.
void	setSymmetries(IndicesSymmetries symmetries) Sets indices symmetries to the specified

Methods inherited from interface cc.redberry.core.indices.Indices

equals, equalsRegardlessOrder, get, get, getAllIndices, getNamesOfDummies, getPositionsInOrbits, size, size, testConsistentWithException, toArray, toString

Method Detail

getSymmetries

IndicesSymmetries getSymmetries()

Returns IndicesSymmetries of this Indices.

Returns:

symmetries of this indices

setSymmetries

void setSymmetries(IndicesSymmetries symmetries)

Sets indices symmetries to the specified

Parameters:

symmetries - IndicesSymmetries

getUpper

SimpleIndices getUpper()

Description copied from interface: Indices

Returns upper (contravariant) indices.

Specified by:

getUpper in interface Indices

Returns:

upper indices

getLower

SimpleIndices getLower()

Description copied from interface: Indices

Returns lower (covariant) indices.

Specified by:

getLower in interface Indices

Returns:

lower indices

getInverted

SimpleIndices getInverted()

Description copied from interface: Indices

Returns new instance of Indices, which contains inverted indices, i.e. all upper indices becomes lower, and all lower become upper. The terms of ordering in the result are same as in the initial Indices object.

Specified by:

getInverted in interface Indices

Returns:

indices with inverted states

getFree

SimpleIndices getFree()

Description copied from interface: Indices

Returns new instance of Indices, which contains only free (non contracted) indices from this Indices instance. The returned Indices object keeps the relative order of indices same as in the this Indices.

Specified by:

getFree in interface Indices

Returns:

only free indices

getOfType

SimpleIndices getOfType(IndexType type)

Description copied from interface: Indices

Returns indices of the specified type, which are contained in this Indices object.

Specified by:

getOfType in interface Indices

Parameters:

type - the type of indices

Returns:

indices of the specified type, which are contained in this indices object.

applyIndexMapping

SimpleIndices applyIndexMapping(IndexMapping im)

Description copied from interface: Indices

This method applies specified IndexMapping to this Indices object and returns the resulting Indices object.

Specified by:

applyIndexMapping in interface Indices

Parameters:

im - specified IndexMapping

Returns:

resulting Indices object

See Also:

IndexMapping

equalsWithSymmetries

boolean equalsWithSymmetries(SimpleIndices indices)

Compares simple indices taking into account possible permutations according to the symmetries.

Parameters:

indices - indices to compare with this

Returns:

true if specified indices can be obtained via permutations (specified by symmetries) of this indices.

getStructureOfIndices

StructureOfIndices getStructureOfIndices()

Returns the structure of this indices.

Returns:

structure of this indices