org.tensorics.incubate.function.InterpolatedFunction 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.incubate.function;

import com.google.common.base.Preconditions;

/**
 * A continuous function, generated from a discrete one together with an appropriate interpolation strategy.
 * 
 * @author agorzaws
 * @param  the type of the independent variable (in)
 * @param  the type of the dependent variable (out)
 */
public final class InterpolatedFunction, Y> implements ContinuousFunction {

    private final DiscreteFunction discreteFunction;
    private final InterpolationStrategy interpolationStrategy;

    private InterpolatedFunction(DiscreteFunction function, InterpolationStrategy strategy) {
        this.interpolationStrategy = strategy;
        this.discreteFunction = function;
        Preconditions
                .checkArgument(discreteFunction != null, "Argument '" + "DiscreteFunction" + "' must not be null!");
        Preconditions.checkArgument(interpolationStrategy != null, "Argument '" + "InterpolationStrategy"
                + "' must not be null!");
    }

    @Override
    public Y getY(X xValue) {
        return interpolationStrategy.interpolate(xValue, discreteFunction);
    }

    @SuppressWarnings("PMD.ShortMethodName")
    public static , Y> InterpolatedFunction of(DiscreteFunction function,
            InterpolationStrategy strategy) {
        return new InterpolatedFunction<>(function, strategy);
    }

}