org.tensorics.core.quantity.operations.QuantitySumOrDifferenceOperation 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.quantity.operations;

import org.tensorics.core.lang.Tensorics;
import org.tensorics.core.math.operations.BinaryOperation;
import org.tensorics.core.quantity.QuantifiedValue;
import org.tensorics.core.quantity.options.OperandPair;
import org.tensorics.core.quantity.options.QuantityEnvironment;
import org.tensorics.core.units.Unit;

import com.google.common.base.Optional;


/**
 * Base class for operations on physical quantities, that can perform sum or difference, depending on the scalar
 * operation that is passed into the constructor. The left and right operand will be converted to the same unit (if they
 * are not provided like this). The errors and validity flags will be propagated according to corresponding strategies
 * given in the environment.
 * 
 * @author kfuchsbe
 * @param  the type of the scalars (field elements) on which all the operations are based on
 */
public class QuantitySumOrDifferenceOperation extends QuantityBinaryOperation {

    public QuantitySumOrDifferenceOperation(QuantityEnvironment environment, BinaryOperation operation) {
        super(environment, operation);
    }

    @Override
    public QuantifiedValue perform(QuantifiedValue left, QuantifiedValue right) {
        OperandPair pair = environment().quantification().asSameUnit(left, right);
        Optional error = environment().errorPropagation().errorForSumAndDifference(pair.left(), pair.right());
        S value = operation().perform(pair.left().value(), pair.right().value());
        boolean validity = validityFor(left, right);
        Unit unit = pair.unit();
        return Tensorics.quantityOf(value, unit).withError(error).withValidity(validity);
    }

}