org.tensorics.core.tensor.Tensor Maven / Gradle / Ivy

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

Tensorics is a java framework which uses a tensor as a central object. A tensor represents a set of values placed in an N-dimensional space. Wherever you are tempted to use maps of maps, a tensor might be a good choice ;-) Tensorics provides methods to create, transform and performing calculations with those tensors.

There is a newer version: 0.0.81

Show newest version

// @formatter:off
 /*******************************************************************************
 *
 * This file is part of tensorics.
 * 
 * Copyright (c) 2008-2011, CERN. All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * 
 ******************************************************************************/
// @formatter:on

package org.tensorics.core.tensor;

import java.util.Map;

/**
 * The top interface for {@link Tensor} like objects.
 * 
 * @author agorzaws, kfuchsbe
 * @param  type of the values hold in the tensor.
 */
public interface Tensor {

    /**
     * @param position the position in the N-dimensional space where to find the value.
     * @return the value at the given position
     * @throws IllegalArgumentException when number of coordinates is not sufficient
     * @throws java.util.NoSuchElementException if the tensor contains no element for the given position
     */
    E get(Position position);

    /**
     * @param coordinates form N-dimensional space where to find the value.
     * @return a value at the given coordinates.
     * @throws IllegalArgumentException if the number of coordinates in incorrect
     * @throws java.util.NoSuchElementException if the tensor contains no element for the given position
     */
    E get(Object... coordinates);

    /**
     * @return entry set of the tensor.
     */
    @Deprecated
    Iterable> entrySet();

    /**
     * @return all the entries as a map of Position to value.
     */
    Map asMap();
    
    /**
     * @return the shape of the tensor. The RAW coordinates structure, no tensor values are returend here.
     */
    Shape shape();

    /**
     * @return a Context of the tensor.
     */
    Context context();

    /**
     * An interface for tensor entries.
     * 
     * @author agorzaws
     * @param  type of the values in the tensor.
     */
    @Deprecated
    interface Entry {

        /**
         * @return a value of the entry, type 
         */
        E getValue();

        /**
         * @return position of the entry.
         */
        Position getPosition();

    }

}