org.tensorics.core.lang.ManipulationOptions 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.ImmutableOptionRegistry;
import org.tensorics.core.commons.options.ManipulationOption;
import org.tensorics.core.commons.options.OptionRegistry;
import org.tensorics.core.function.interpolation.LinearInterpolationStrategy;
import org.tensorics.core.math.ExtendedField;
import org.tensorics.core.quantity.options.ImmutableConfidenceLevel;
import org.tensorics.core.quantity.options.JScienceQuantificationStrategy;
import org.tensorics.core.quantity.options.RequireBothValidStrategy;
import org.tensorics.core.quantity.options.UncorrelatedErrorPropagationStrategy;
import org.tensorics.core.tensor.options.BroadcastMissingDimensionsStrategy;
import org.tensorics.core.tensor.options.IntersectionShapingStrategy;
import org.tensorics.core.tensor.options.LeftContextPreservedStrategy;

import com.google.common.collect.ImmutableList;

/**
 * A class that provides static methods to deal with manipulations options and creating repositories for them.
 * 
 * @author agorzaws
 */
public final class ManipulationOptions {

    private static final double DEFAULT_CONFIDENCE_LEVEL = 0.95;

    private ManipulationOptions() {
        /* Only static methods */
    }

    // tag::classdef[]
    /**
     * Creates a new instance of an Option registry, supporting the given field, which will contain the default options,
     * as there are:
     * 
     * {@link IntersectionShapingStrategy} for shaping strategy.
     * {@link BroadcastMissingDimensionsStrategy} for broadcasting strategy
     * {@link RequireBothValidStrategy}
     * {@link UncorrelatedErrorPropagationStrategy}
     * {@link JScienceQuantificationStrategy}
     * {@link LeftContextPreservedStrategy}
     * {@link LinearInterpolationStrategy}
     * 
     * 
     * @param field the for which to create the option-instances
     * @return a new (immutable) option registry, containing the default options
     */
    @SuppressWarnings("deprecation")
    public static  OptionRegistry defaultOptions(ExtendedField field) {
        return ImmutableOptionRegistry.of(ImmutableList.of(//
                new IntersectionShapingStrategy(), //
                new BroadcastMissingDimensionsStrategy(), //
                new RequireBothValidStrategy(), //
                new UncorrelatedErrorPropagationStrategy<>(field), //
                new JScienceQuantificationStrategy<>(field.cheating()), //
                new LeftContextPreservedStrategy(), 
                new ImmutableConfidenceLevel<>(field.cheating().fromDouble(DEFAULT_CONFIDENCE_LEVEL)),
                new LinearInterpolationStrategy<>(field)));
    }
    // end::classdef[]
}