org.tensorics.core.tensorbacked.TensorbackedBuilder 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.tensorbacked;

import static org.tensorics.core.tensorbacked.TensorbackedInternals.createBackedByTensor;
import static org.tensorics.core.tensorbacked.TensorbackedInternals.dimensionsOf;

import java.util.Map;
import java.util.Set;

import org.tensorics.core.tensor.Context;
import org.tensorics.core.tensor.ImmutableTensor;
import org.tensorics.core.tensor.OngoingPut;
import org.tensorics.core.tensor.Position;
import org.tensorics.core.tensor.Tensor;
import org.tensorics.core.tensor.Tensor.Entry;

/**
 * A builder for tensor backed objects, which takes care that only positions which are compatible with the dimensions of
 * the foreseen underlaying tensor are put into it. Internally, it uses a builder for a tensor, to which most of the
 * methods are delegated. At build time, the tensor is encapsulated in the according tensor backed class.
 * 
 * This class is not thread safe.
 * 
 * @author kfuchsbe
 * @param  the type of the values of the tensor (and thus also the tensor backed object)
 * @param  the type of the tensor backed object
 */
@SuppressWarnings("PMD.TooManyMethods")
public class TensorbackedBuilder> {

    private final Class tensorbackedClass;
    private final ImmutableTensor.Builder tensorBuilder;

    /**
     * Constructor for the builder, which takes the target class of the tensorbacked as an argument. Will only be
     * instantiated by the neighbouring utility class. Therefore it is package private.
     */
    TensorbackedBuilder(Class tensorbackedClass) {
        this.tensorbackedClass = tensorbackedClass;
        this.tensorBuilder = ImmutableTensor.builder(dimensionsOf(tensorbackedClass));
    }

    @SuppressWarnings("PMD.ShortMethodName")
    public final OngoingPut at(Position entryPosition) {
        return tensorBuilder.at(entryPosition);
    }

    @SuppressWarnings("PMD.ShortMethodName")
    public final OngoingPut at(Set coordinates) {
        return tensorBuilder.at(coordinates);
    }

    @SuppressWarnings("PMD.ShortMethodName")
    public final OngoingPut at(Object... coordinates) {
        return tensorBuilder.at(coordinates);
    }

    @Deprecated
    public final void put(Entry entry) {
        tensorBuilder.put(entry);
    }

    public final TensorbackedBuilder put(java.util.Map.Entry entry) {
        tensorBuilder.put(entry);
        return this;
    }

    public final TensorbackedBuilder putAt(V value, Position position) {
        tensorBuilder.putAt(value, position);
        return this;
    }

    public final TensorbackedBuilder putAt(V value, Object... coordinates) {
        tensorBuilder.putAt(value, coordinates);
        return this;
    }

    @Deprecated
    public final void putAll(Iterable> entries) {
        tensorBuilder.putAll(entries);
    }

    public final TensorbackedBuilder putAll(Set> entries) {
        for (java.util.Map.Entry entry : entries) {
            tensorBuilder.put(entry);
        }
        return this;
    }

    public final TensorbackedBuilder putAllAt(Tensor tensor, Position position) {
        tensorBuilder.putAllAt(tensor, position);
        return this;
    }

    public final TensorbackedBuilder putAllAt(Tensorbacked tensorbacked, Position position) {
        tensorBuilder.putAllAt(tensorbacked.tensor(), position);
        return this;
    }

    public final TensorbackedBuilder putAllAt(Tensor tensor, Object... coordinates) {
        tensorBuilder.putAllAt(tensor, coordinates);
        return this;
    }

    public final TensorbackedBuilder putAllAt(Tensorbacked tensorbacked, Object... coordinates) {
        tensorBuilder.putAllAt(tensorbacked.tensor(), coordinates);
        return this;
    }

    public final TensorbackedBuilder putAll(TB tensorBacked) {
        tensorBuilder.putAll(tensorBacked.tensor());
        return this;
    }

    public final TensorbackedBuilder putAll(Tensor tensor) {
        tensorBuilder.putAll(tensor);
        return this;
    }

    public final TensorbackedBuilder putAllMap(Map newEntries) {
        tensorBuilder.putAllMap(newEntries);
        return this;
    }

    public final TensorbackedBuilder removeAt(Position position) {
        tensorBuilder.removeAt(position);
        return this;
    }

    public final TensorbackedBuilder withContext(Context context) {
        tensorBuilder.setTensorContext(context);
        return this;
    }

    public final TensorbackedBuilder withContext(Position context) {
        tensorBuilder.setTensorContext(Context.of(context));
        return this;
    }

    public final TensorbackedBuilder withContext(Object... coordinates) {
        tensorBuilder.setTensorContext(Context.of(coordinates));
        return this;
    }

    /**
     * Builds the tensor backed object, after all the content is set.
     * 
     * @return a new instance of the tensor backed object, containing all the data as described after instantiating the
     *         builder.
     */
    public TB build() {
        return createBackedByTensor(tensorbackedClass, tensorBuilder.build());
    }

}