cc.redberry.core.indices.SimpleIndices Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of core Show documentation

Redberry is an open source computer algebra system designed for tensor manipulation. It implements basic computer algebra system routines as well as complex tools for real computations in physics. This is Redberry core, which contains the implementation of the basic computer algebra routines and general-purpose transformations.

There is a newer version: 1.1.10

Show newest version

/*
 * Redberry: symbolic tensor computations.
 *
 * Copyright (c) 2010-2012:
 *   Stanislav Poslavsky   
 *   Bolotin Dmitriy       
 *
 * This file is part of Redberry.
 *
 * Redberry is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Redberry is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Redberry. If not, see .
 */
package cc.redberry.core.indices;

import cc.redberry.core.indexmapping.IndexMapping;
import cc.redberry.core.tensor.SimpleTensor;

/**
 * This interface states additional functionality of the indices of the
 * {@link SimpleTensor}. Indices of this type stores not only set of indices
 * but also their order and symmetries.
 * To create objects of this type use
 * {@link IndicesFactory#createSimple(IndicesSymmetries, int...)}.
 *
 * @author Dmitry Bolotin
 * @author Stanislav Poslavsky
 * @see Indices
 * @see IndicesFactory
 */
public interface SimpleIndices extends Indices {

    /**
     * This method returns {@link IndicesSymmetries} of this {@code Indices}.
     *
     * @return {@code SymmetriesImpl} of this {@code Indices}
     */
    IndicesSymmetries getSymmetries();

    /**
     * This method allows to set {@code SymmetriesImpl} of this {@code Indices}.
     *
     * @param symmetries {@link IndicesSymmetries} to be set as symmetries of
     *                   this indices
     */
    void setSymmetries(IndicesSymmetries symmetries);

    @Override
    SimpleIndices getInverse();

    @Override
    SimpleIndices getFree();

    @Override
    SimpleIndices applyIndexMapping(IndexMapping im);

    /**
     * Returns result of indices comparing, using their symmetries lists.
     *
     * @param indices indices to compare with this
     * @return true if indices are equals and
     *         false if not.
     */
    boolean equalsWithSymmetries(SimpleIndices indices);

    IndicesTypeStructure getIndicesTypeStructure();
}