org.tensorics.core.quantity.lang.OngoingQuantifiedScalarOperation 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.lang;

import org.tensorics.core.lang.Tensorics;
import org.tensorics.core.quantity.QuantifiedValue;
import org.tensorics.core.quantity.operations.QuantityOperationRepository;
import org.tensorics.core.units.JScienceUnit;
import org.tensorics.core.units.Unit;

/**
 * Part of the tensoric fluent API that provides methods to describe the right hand part of binary operations on
 * quantified scalars.
 * 
 * @author kfuchsbe
 * @param  the type of the scalar values (elements of the field on which all the operations are based on)
 */
public class OngoingQuantifiedScalarOperation {

    private final QuantifiedValue left;
    private final QuantityOperationRepository pseudoField;

    public OngoingQuantifiedScalarOperation(QuantifiedValue left, QuantityOperationRepository pseudoField) {
        super();
        this.left = left;
        this.pseudoField = pseudoField;
    }

    public QuantifiedValue plus(S rightValue, Unit rightUnit) {
        return plus(Tensorics.quantityOf(rightValue, rightUnit));
    }

    public QuantifiedValue minus(S rightValue, Unit rightUnit) {
        return minus(Tensorics.quantityOf(rightValue, rightUnit));
    }

    public QuantifiedValue plus(S rightValue, javax.measure.unit.Unit rightUnit) {
        return plus(Tensorics.quantityOf(rightValue, JScienceUnit.of(rightUnit)));
    }

    public QuantifiedValue minus(S rightValue, javax.measure.unit.Unit rightUnit) {
        return minus(Tensorics.quantityOf(rightValue, JScienceUnit.of(rightUnit)));
    }

    /*
     * methods using our scalars
     */

    public QuantifiedValue plus(QuantifiedValue right) {
        return pseudoField.addition().perform(left, right);
    }

    public QuantifiedValue minus(QuantifiedValue right) {
        return pseudoField.subtraction().perform(left, right);
    }

    public QuantifiedValue times(S rightValue, javax.measure.unit.Unit unit) {
        return times(Tensorics.quantityOf(rightValue, JScienceUnit.of(unit)));
    }

    public QuantifiedValue dividedBy(S rightValue, javax.measure.unit.Unit unit) {
        return dividedBy(Tensorics.quantityOf(rightValue, JScienceUnit.of(unit)));
    }

    public QuantifiedValue times(QuantifiedValue right) {
        return pseudoField.multiplication().perform(left, right);
    }

    public QuantifiedValue dividedBy(QuantifiedValue right) {
        return pseudoField.division().perform(left, right);
    }

    public QuantifiedValue toThePowerOf(QuantifiedValue rightValue) {
        return pseudoField.power().perform(left, rightValue);
    }

    public QuantifiedValue root(QuantifiedValue rightValue) {
        return pseudoField.root().perform(left, rightValue);
    }

}