Package dev.nm.analysis.function.rn2r1

Class AbstractRealScalarFunction

java.lang.Object

dev.nm.analysis.function.rn2r1.AbstractRealScalarFunction

All Implemented Interfaces:

Function<Vector,Double>, RealScalarFunction

Direct Known Subclasses:

AbstractBivariateRealFunction, AbstractTrivariateRealFunction, AbstractUnivariateRealFunction, MultinomialBetaFunction, MultivariateFiniteDifference, QuadraticFunction, R1Projection, Rastrigin, Ridders

public abstract class AbstractRealScalarFunction
extends Object
implements RealScalarFunction

This abstract implementation implements Function.dimensionOfRange() by always returning 1, and Function.dimensionOfDomain() by returning the input argument for the dimension of domain.

Nested Class Summary

Nested classes/interfaces inherited from interface dev.nm.analysis.function.Function

Function.EvaluationException

Constructor Summary

Constructors

Constructor	Description
AbstractRealScalarFunction(int domainDimension)	Construct an instance with the dimension of the domain.

Method Summary

Modifier and Type	Method	Description
final int	dimensionOfDomain()	Get the number of variables the function has.
final int	dimensionOfRange()	Get the dimension of the range space of the function.

Methods inherited from class java.lang.Object

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

Methods inherited from interface dev.nm.analysis.function.Function

evaluate

Constructor Details

AbstractRealScalarFunction

public AbstractRealScalarFunction(int domainDimension)

Construct an instance with the dimension of the domain.

Parameters:

domainDimension - the dimension of the domain

Method Details

dimensionOfDomain

public final 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,Double>

Returns:

the number of variables

dimensionOfRange

public final 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,Double>

Returns:

the dimension of the range