com.meliorbis.numerics.function.primitives.DoubleFunction Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of Numerics Show documentation

A library for working with large multi-dimensional arrays and the functions they represent

There is a newer version: 1.2

package com.meliorbis.numerics.function.primitives;

import org.apache.commons.lang.ArrayUtils;

import com.meliorbis.numerics.function.Function;

/**
 * Specialisation of IGridFunction for primitive doubles
 * 
 * @author Tobias Grasl
 */
public interface DoubleFunction extends Function
{
	/**
     * Provide default to delegate to primitive method
     */
    default O call(Double... inputs_)
    {
    	return callWithDouble(ArrayUtils.toPrimitive(inputs_));
    };
    
	/**
     * Calls the function for the provided inputs and returns the output
     *
     * @param inputs_ The function inputs
     *
     * @return The function output for the inputs provided
     */
    O callWithDouble(double... inputs_);

    /**
     * Provide default to delegate to primitive method
     */
    default DoubleFunction restrict(Double... partialInputs_)
    {
    	return restrict(ArrayUtils.toPrimitive(partialInputs_));
    };
    
    /**
     * Restricts the function to have the values specified in partialInputs in those dimensions
     * where partialInputs provides a valid value. The invalid value is Double.NaN.
     * If partialInputs is shorter than the number of dimensions of the function, then the remaining
     * dimensions are assumed to be specified as invalid.
     *
     * The returned function will have as many dimensions as invalid values were specified for.
     *
     * For for, in a 3-dimensional function, if a valid value V were passed for dimension 1 and not 0 and 2,
     * then the returned function would be two dimensional and for values (V1, V2) passed would return
     * the same as this function does for (V1, V, V2).
     *
     * @param partialInputs_ The array of values to which to restrict the function in each dimension, some
     *                       of which may be invalid
     *
     * @return The restricted function
     */
    DoubleFunction restrict(double... partialInputs_);
}