com.numericalmethod.suanshu.analysis.function.rn2r1

Class BivariateRealFunction

java.lang.Object

com.numericalmethod.suanshu.analysis.function.rn2r1.BivariateRealFunction

All Implemented Interfaces:

Function<Vector,java.lang.Double>, RealScalarFunction, java.io.Serializable

Direct Known Subclasses:

AutoCorrelationFunction, AutoCovarianceFunction, Beta, DBeta, GammaLowerIncomplete, GammaRegularizedP, GammaRegularizedPInverse, GammaRegularizedQ, GammaUpperIncomplete, LogBeta

public abstract class BivariateRealFunction
extends java.lang.Object
implements RealScalarFunction

A bivariate real function takes two real arguments and outputs one real value. That is, y = f(x₁,x₂).

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.numericalmethod.suanshu.analysis.function.Function

Function.EvaluationException

Constructor Summary

Constructors

Constructor and Description
BivariateRealFunction()

Method Summary

Modifier and Type	Method and Description
int	dimensionOfDomain() Get the number of variables the function has.
int	dimensionOfRange() Get the dimension of the range space of the function.
abstract double	evaluate(double x1, double x2) Evaluate y = f(x1,x2).
java.lang.Double	evaluate(Vector x) Evaluate the function f at x, where x is from the domain.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BivariateRealFunction

public BivariateRealFunction()

Method Detail

dimensionOfDomain

public int dimensionOfDomain()

Description copied from interface: Function

Get the number of variables the function has. For example, for a univariate function, the domain dimension is 1; for a bivariate function, the domain dimension is 2.

Specified by:

dimensionOfDomain in interface Function<Vector,java.lang.Double>

Returns:

the number of variables

dimensionOfRange

public int dimensionOfRange()

Description copied from interface: Function

Get the dimension of the range space of the function. For example, for a Rⁿ->R^m function, the dimension of the range is m.

Specified by:

dimensionOfRange in interface Function<Vector,java.lang.Double>

Returns:

the dimension of the range

evaluate

public java.lang.Double evaluate(Vector x)

Description copied from interface: Function

Evaluate the function f at x, where x is from the domain.

Specified by:

evaluate in interface Function<Vector,java.lang.Double>

Parameters:

x - x

Returns:

f(x)

evaluate

public abstract double evaluate(double x1,
                                double x2)

Evaluate y = f(x₁,x₂).

Parameters:

x1 - x₁

x2 - x₂

Returns:

f(x₁, x₂)