org.tensorics.core.function.lang.FunctionSupport 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-2016, 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.function.lang;

import java.util.Comparator;

import org.tensorics.core.commons.operations.Conversion;
import org.tensorics.core.commons.operations.Conversions;
import org.tensorics.core.commons.options.Environment;
import org.tensorics.core.function.DiscreteFunction;

/**
 * Specialisation of {@link FunctionSupportWithConversionAndComparator} for {@link DiscreteFunction}s from Y to Y.
 * 
 * @author caguiler
 * @param  the type of the independent variable (input) and dependent variable (output) of the discrete function and
 *            the type of the scalar values (elements of the field) on which to operate
 */
public class FunctionSupport extends FunctionSupportWithConversionAndComparator {

    FunctionSupport(Environment environment) {
        super(environment, Conversions.identity(), environment.field().comparator());
    }

    /***
     * @param conversion defines how to transform a value of X type to Y type
     * @return a {@link FunctionSupportWithConversionAndComparator} with a given {@link Conversion} set
     */
    public final  FunctionSupportWithConversionAndComparator withConversionAndComparator(Conversion conversion,
            Comparator comparator) {
        return new FunctionSupportWithConversionAndComparator<>(environment(), conversion, comparator);
    }
}