Module org.bzdev.math

Package org.bzdev.math

Interface RealValuedFunctTwoOps

All Superinterfaces:

DoubleBinaryOperator, RealValuedFunctVAOps

All Known Subinterfaces:

NamedFunctionTwoOps

All Known Implementing Classes:

BicubicInterpolator, BicubicTriangleInterp, RealValuedFunctionTwo, SimFunctionTwo

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface RealValuedFunctTwoOps
extends DoubleBinaryOperator, RealValuedFunctVAOps

Interface representing a real-valued function of two arguments. This interface provides a single method associated with a real-valued function: methods that compute a function's domain and its derivatives are missing.

This class was created before the Java interface DoubleBinaryOperator was defined and consequently this class was modified to extend DoubleBinaryOperator. Any implementation that overrides applyAsDouble(double,double) must ensure that applyAsDouble(double,double) and valueAt(double,double) return the same value.

Method Summary

Modifier and Type	Method	Description
default double	applyAsDouble(double arg1, double arg2)
default int	maxArgLength()	Get the maximum number of arguments allowed in calls to RealValuedFunctVAOps.valueAt(double...).
default int	minArgLength()	Get the minimum number of arguments allowed in calls to RealValuedFunctVAOps.valueAt(double...).
default double	valueAt(double... args)	Compute the value of a function f for the given arguments.
double	valueAt(double arg1, double arg2)	Compute the value of a function f for the given arguments.

Method Details

valueAt

double valueAt(double arg1,
 double arg2)
        throws IllegalArgumentException,
UnsupportedOperationException,
IllegalStateException

Compute the value of a function f for the given arguments.

Parameters:

arg1 - the first argument

arg2 - the second argument

Returns:

the value of the function for the specified arguments

Throws:

IllegalArgumentException - the function's argument was out of range

UnsupportedOperationException - the operation is not supported.

IllegalStateException - the function was not fully initialized.

valueAt

default double valueAt(double... args)
                throws IllegalArgumentException,
UnsupportedOperationException,
IllegalStateException

Description copied from interface: RealValuedFunctVAOps

Compute the value of a function f for the given arguments.

Specified by:

valueAt in interface RealValuedFunctVAOps

Parameters:

args - the arguments

Returns:

the value of the function for the specified argument

Throws:

IllegalArgumentException - the function's argument was out of range

UnsupportedOperationException - the operation is not supported.

IllegalStateException - the function was not fully initialized.

minArgLength

default int minArgLength()

Description copied from interface: RealValuedFunctVAOps

Get the minimum number of arguments allowed in calls to RealValuedFunctVAOps.valueAt(double...).

Specified by:

minArgLength in interface RealValuedFunctVAOps

Returns:

the minimum number of arguments.

maxArgLength

default int maxArgLength()

Description copied from interface: RealValuedFunctVAOps

Get the maximum number of arguments allowed in calls to RealValuedFunctVAOps.valueAt(double...).

Specified by:

maxArgLength in interface RealValuedFunctVAOps

Returns:

the maximum number of arguments.

applyAsDouble

default double applyAsDouble(double arg1,
 double arg2)

Specified by:

applyAsDouble in interface DoubleBinaryOperator