org.tensorics.core.quantity.lang.QuantityExpressionSupport 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.expressions.UnaryOperationExpression;
import org.tensorics.core.lang.Tensorics;
import org.tensorics.core.quantity.QuantifiedValue;
import org.tensorics.core.quantity.operations.QuantityOperationRepository;
import org.tensorics.core.quantity.options.QuantityEnvironment;
import org.tensorics.core.tree.domain.Expression;
import org.tensorics.core.tree.domain.ResolvedExpression;
import org.tensorics.core.units.JScienceUnit;
import org.tensorics.core.units.Unit;

/**
 * Provide tensoric eDSL elements which serve as starting point for descriptions of expressions of quantities.
 * 
 * @author kfuchsbe
 * @param  the type of the elements of the field on which all the operations are based on.
 */
@SuppressWarnings("PMD.TooManyMethods")
public class QuantityExpressionSupport {

    private final QuantityOperationRepository pseudoField;

    protected QuantityExpressionSupport(QuantityEnvironment environment) {
        this.pseudoField = new QuantityOperationRepository<>(environment);
    }

    public Expression> valueOf(V value, Unit unit) {
        return ResolvedExpression.of((QuantifiedValue) Tensorics.quantityOf(value, unit));
    }

    public Expression> valueOf(V value, javax.measure.unit.Unit unit) {
        return valueOf(value, JScienceUnit.of(unit));
    }

    public OngoingDeferredQuantifiedScalarOperation calculate(V value, javax.measure.unit.Unit unit) {
        return calculate(valueOf(value, unit));
    }

    public OngoingDeferredQuantifiedScalarOperation calculate(Expression> scalar) {
        return new OngoingDeferredQuantifiedScalarOperation<>(scalar, pseudoField);
    }

    public Expression> negativeOf(QuantifiedValue element) {
        return negativeOf(ResolvedExpression.of(element));
    }

    public Expression> negativeOf(Expression> element) {
        return new UnaryOperationExpression<>(pseudoField.additiveInversion(), element);
    }

    public Expression> inverseOf(QuantifiedValue element) {
        return inverseOf(ResolvedExpression.of(element));
    }

    public Expression> inverseOf(Expression> element) {
        return new UnaryOperationExpression<>(pseudoField.multiplicativeInversion(), element);
    }

    public QuantifiedValue one() {
        return pseudoField.one();
    }

    public QuantifiedValue zero() {
        return pseudoField.zero();
    }

    public QuantifiedValue two() {
        return pseudoField.two();
    }

}