org.tensorics.core.function.lang.FunctionExpressionSupportWithConversionAndComparator 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.options.Environment;
import org.tensorics.core.function.DiscreteFunction;
import org.tensorics.core.function.expressions.DiscreteFunctionToIterableExpression;
import org.tensorics.core.function.operations.CodomainExtraction;
import org.tensorics.core.iterable.lang.ScalarIterableExpressionSupport;
import org.tensorics.core.tree.domain.Expression;

/**
 * Provides utility methods for acting on expressions of {@link DiscreteFunction}s from X to Y.
 * 
 * The type of the values of the discrete function codomain is also the type of the values of the field.
 * 
 * @author caguiler
 * @param  the type of the independent variable (input) of the discrete function
 * @param  the type of the dependent variable (output) of the discrete function and the type of the scalar values
 *            (elements of the field) on which to operate
 */
public class FunctionExpressionSupportWithConversionAndComparator extends ScalarIterableExpressionSupport {

    private final Environment environment;
    private final CodomainExtraction codomainExtraction;
    private final Conversion conversion;
    private final Comparator comparator;

    FunctionExpressionSupportWithConversionAndComparator(Environment environment, Conversion conversion,
            Comparator comparator) {
        super(environment.field());
        this.environment = environment;
        this.conversion = conversion;
        this.comparator = comparator;
        codomainExtraction = new CodomainExtraction<>();
    }

    public final OngoingDeferredDiscreteFunctionBinaryOperation calculateF(
            Expression> expression) {
        return new OngoingDeferredDiscreteFunctionBinaryOperation<>(environment, expression, conversion, comparator);
    }

    public final  Expression averageOfF(Expression> function) {
        return averageOf(yValuesAsIterableExpression(function));
    }

    public final  Expression rmsOfF(Expression> function) {
        return rmsOf(yValuesAsIterableExpression(function));
    }

    public final  Expression stdOfF(Expression> function) {
        return stdOf(yValuesAsIterableExpression(function));
    }

    @SuppressWarnings("unchecked")
    private  Expression> yValuesAsIterableExpression(
            Expression> function) {
        return new DiscreteFunctionToIterableExpression<>(codomainExtraction,
                (Expression>) function);
    }

    /**
     * Only used by subclasses
     * 
     * @return the {@link Environment} of this {@link FunctionSupportWithConversionAndComparator}
     */
    protected Environment environment() {
        return environment;
    }
}