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

/**
 * A builder for discrete functions. It provides methods to put new values and to decide on the interpolation strategies
 * to use.
 * 
 * @author kfuchsbe
 * @param  the type of the values along the X-axis
 * @param  the type of the values along the Y-axis
 */
public interface DiscreteFunctionBuilder, Y> {

    DiscreteFunctionBuilder put(X key, Y value);

    DiscreteFunctionBuilder put(X key, Y value, Y error);

    DiscreteFunctionBuilder withInterpolationStrategy(InterpolationStrategy interpolationStrategy);

    DiscreteFunctionBuilder withName(String name);

    DiscreteFunction build();

}