cc.redberry.core.indices

Class IndicesFactory

java.lang.Object

cc.redberry.core.indices.IndicesFactory

public class IndicesFactory
extends java.lang.Object

Factory methods for indices creation.

Since:

1.0

Field Summary

Fields

Modifier and Type	Field and Description
static Indices	EMPTY_INDICES Singleton object for empty indices.
static SimpleIndices	EMPTY_SIMPLE_INDICES Singleton object for empty simple indices.

Constructor Summary

Constructors

Constructor and Description
IndicesFactory()

Method Summary

Modifier and Type	Method and Description
static Indices	create(Indices indices) Creates unordered indices from specified Indices object.
static Indices	create(int... data) Creates unordered indices from specified integer array of indices.
static SimpleIndices	createSimple(IndicesSymmetries symmetries, Indices indices) Creates simple indices from specified Indices object and with specified symmetries.
static SimpleIndices	createSimple(IndicesSymmetries symmetries, int... data) Creates simple indices from specified integer array and with specified symmetries.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

EMPTY_INDICES

public static final Indices EMPTY_INDICES

Singleton object for empty indices.

EMPTY_SIMPLE_INDICES

public static final SimpleIndices EMPTY_SIMPLE_INDICES

Singleton object for empty simple indices.

Constructor Detail

IndicesFactory

public IndicesFactory()

Method Detail

createSimple

public static SimpleIndices createSimple(IndicesSymmetries symmetries,
                                         int... data)

Creates simple indices from specified integer array and with specified symmetries.

Parameters:

symmetries - symmetries of indices

data - integer array of indices

Returns:

simple indices

Throws:

InconsistentIndicesException - if array contains more then one same integer

createSimple

public static SimpleIndices createSimple(IndicesSymmetries symmetries,
                                         Indices indices)

Creates simple indices from specified Indices object and with specified symmetries.

Parameters:

symmetries - symmetries of indices

indices - Indices object

Returns:

simple indices

create

public static Indices create(Indices indices)

Creates unordered indices from specified Indices object. The resulting indices will contain exactly the same indices as specified Indices object, by may have different terms of ordering, in case when the specified indices are SimpleIndices.

Parameters:

indices - Indices object

Returns:

unordered indices created from specified Indices object

create

public static Indices create(int... data)

Creates unordered indices from specified integer array of indices.

Returns:

unordered indices from specified integer array of indices

Throws:

InconsistentIndicesException - if array contains more then one same integer