org.tensorics.core.quantity.lang.QuantitySupport 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.conditions.QuantityPedicateRepository;
import org.tensorics.core.quantity.operations.QuantityOperationRepository;
import org.tensorics.core.quantity.options.QuantityEnvironment;
import org.tensorics.core.units.JScienceUnit;
import org.tensorics.core.units.Unit;

/**
 * Provides starting methods for tensoric language expressions that operate on quantities.
 * 
 * @author kfuchsbe
 * @param  the type of the scalar values (elements of the field which is used for the operations)
 */
public class QuantitySupport {

    private final QuantityOperationRepository operationRepository;
    private final QuantityPedicateRepository predicateRepository;

    protected QuantitySupport(QuantityEnvironment environment) {
        this.operationRepository = new QuantityOperationRepository<>(environment);
        this.predicateRepository = new QuantityPedicateRepository<>(environment);
    }

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

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

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

    public OngoingQuantifiedScalarOperation calculate(QuantifiedValue scalar) {
        return new OngoingQuantifiedScalarOperation<>(scalar, operationRepository);
    }

    public QuantifiedValue negativeOf(QuantifiedValue element) {
        return operationRepository.additiveInversion().perform(element);
    }

    public QuantifiedValue inverseOf(QuantifiedValue element) {
        return operationRepository.multiplicativeInversion().perform(element);
    }

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

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

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

    public OngoingQuantifiedScalarConversion convert(QuantifiedValue value) {
        return new OngoingQuantifiedScalarConversion<>(value, operationRepository.environment().quantification());
    }

    public OngoingQuantityValueExtraction valueOf(QuantifiedValue quantity) {
        return new OngoingQuantityValueExtraction<>(quantity, operationRepository);
    }

    protected QuantityOperationRepository operationRepository() {
        return operationRepository;
    }

    protected QuantityPedicateRepository predicateRepository() {
        return predicateRepository;
    }

    public OngoingQuantifiedScalarBinaryPredicate testIf(QuantifiedValue left) {
        return new OngoingQuantifiedScalarBinaryPredicate<>(predicateRepository, left);
    }
}