org.tensorics.core.tensor.TensorBuilder 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;
import java.util.Map.Entry;
import java.util.Set;

/**
 * The interface any builder of a tensor has to implement
 * 
 * @author kfuchsbe
 * @param  the type of the tensor values
 */
public interface TensorBuilder {

    void putAt(E value, Position position);

    void putAt(E value, Object... coordinates);

    void putAt(E value, Set coordinates);

    void removeAt(Position position);

    void setTensorContext(Context context);

    /**
     * Puts all the values of the given tensor into the new tensor, at the given position. The positions in the new
     * tensor will be the merged positions of the original coordinates in the tensor with the given target position.
     * Therefore, the given position is not allowed to have a dimensions overlap with the positions in the original
     * tensor.
     * 
     * @param tensor the tensor, whose values to add to the tensor under construction
     * @param position the position which will be merged with the tensor in the source tensor
     */
    /* Not too nice yet. Should be refactored into ongoing put */

    void putAll(Tensor tensor);

    void putAllAt(Tensor tensor, Position position);

    /**
     * Puts all the values of the given tensor into the new tensor at a position represented by the given coordinates.
     * This is a convenience method for {@link #putAllAt(Tensor, Position)}.
     * 
     * @param tensor the tensor whose values to put into the tensor unser construction
     * @param coordinates the coordinates defining the position where to put the values
     */
    void putAllAt(Tensor tensor, Object... coordinates);

    void putAllAt(Tensor tensor, Set coordinates);

    @Deprecated
    void put(Tensor.Entry entry);

    @Deprecated
    void putAll(Iterable> newEntries);

    void put(Entry entry);

    void putAllMap(Map newEntries);

    Tensor build();

}