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

import org.tensorics.core.commons.options.ManipulationOption;
import org.tensorics.core.commons.options.OptionRegistry;
import org.tensorics.core.math.ExtendedField;
import org.tensorics.core.quantity.options.ConfidenceLevel;
import org.tensorics.core.quantity.options.ErrorPropagationStrategy;
import org.tensorics.core.quantity.options.QuantificationStrategy;
import org.tensorics.core.quantity.options.QuantityEnvironment;

/**
 * Encapsulates all relevant information which is required for calculations of scalars, tensors and iterables. These
 * include the field (which defines the basic operations on scalars) and the the options which define tensors and
 * iterables are manipulated exactly.
 * 
 * @author kfuchsbe
 * @param  the type of the values (field elements)
 */
public final class EnvironmentImpl implements QuantityEnvironment {

    private final ExtendedField extendedField;
    private final OptionRegistry optionRegistry;

    private EnvironmentImpl(ExtendedField field, OptionRegistry strategyRegistry) {
        this.extendedField = field;
        this.optionRegistry = strategyRegistry;
    }

    @SuppressWarnings("PMD.ShortMethodName")
    public static  EnvironmentImpl of(ExtendedField field, OptionRegistry optionRegistry) {
        return new EnvironmentImpl<>(field, optionRegistry);
    }

    @Override
    public ExtendedField field() {
        return extendedField;
    }

    @Override
    @SuppressWarnings("unchecked")
    public ErrorPropagationStrategy errorPropagation() {
        return options().get(ErrorPropagationStrategy.class);
    }

    @Override
    @SuppressWarnings("unchecked")
    public QuantificationStrategy quantification() {
        return this.options().get(QuantificationStrategy.class);
    }

    @Override
    @SuppressWarnings("unchecked")
    public V confidenceLevel() {
        return (V) this.options().get(ConfidenceLevel.class).confidenceLevel();
    }

    @Override
    public OptionRegistry options() {
        return optionRegistry;
    }

    public  EnvironmentImpl with(T newOption) {
        return new EnvironmentImpl<>(extendedField, optionRegistry.with(newOption));
    }


}