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

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

import org.tensorics.core.commons.lang.OngoingOperation;
import org.tensorics.core.lang.Tensorics;
import org.tensorics.core.math.operations.BinaryOperation;
import org.tensorics.core.quantity.QuantifiedValue;
import org.tensorics.core.quantity.operations.QuantityOperationRepository;
import org.tensorics.core.tensor.Tensor;
import org.tensorics.core.tensor.operations.ElementBinaryOperation;
import org.tensorics.core.tensorbacked.Tensorbacked;

/**
 * Part of the tensorics fluent API that provides methods to describe the right hand part of binary operations on tensor
 * backed instances, containing quantified values.
 * 
 * @author agorzaws
 * @param  the type of the quantified tensor backed instances
 * @param  the type of the scalars (elements of the field on which all the operations are based on)
 */
public class OngoingQuantifiedTensorBackedOperation>, S> implements
        OngoingOperation> {

    private final QuantityOperationRepository pseudoField;
    private final QTB left;

    public OngoingQuantifiedTensorBackedOperation(QuantityOperationRepository pseudoField, QTB left) {
        super();
        this.pseudoField = pseudoField;
        this.left = left;
    }

    @Override
    public QTB plus(QTB right) {
        return evaluate(right.tensor(), pseudoField.addition());
    }

    @Override
    public QTB minus(QTB right) {
        return evaluate(right.tensor(), pseudoField.subtraction());
    }

    @Override
    public QTB elementTimes(QTB right) {
        return evaluate(right.tensor(), pseudoField.multiplication());
    }

    @Override
    public QTB elementTimesV(QuantifiedValue right) {
        return elementTimesQT(Tensorics.zeroDimensionalOf(right));
    }

    public QTB elementTimesQT(Tensor> right) {
        return evaluate(right, pseudoField.multiplication());
    }

    @Override
    public QTB elementDividedBy(QTB right) {
        return evaluate(right.tensor(), pseudoField.division());
    }

    public QTB elementDividedByQT(Tensor> right) {
        return evaluate(right, pseudoField.division());
    }

    @Override
    public QTB elementDividedByV(QuantifiedValue value) {
        return elementDividedByQT(Tensorics.zeroDimensionalOf(value));
    }

    private QTB evaluate(Tensor> right, BinaryOperation> operation) {
        Tensor> perform = new ElementBinaryOperation<>(operation, pseudoField.environment()
                .options()).perform(left.tensor(), right);
        return createBackedByTensor(classOf(left), perform);
    }

    @SuppressWarnings("unchecked")
    private Class classOf(QTB tensorBacked) {
        return (Class) tensorBacked.getClass();
    }

}