com.numericalmethod.suanshu.analysis.function.rn2r1

Class RealScalarSubFunction

java.lang.Object

com.numericalmethod.suanshu.analysis.function.SubFunction<java.lang.Double>

com.numericalmethod.suanshu.analysis.function.rn2r1.RealScalarSubFunction

All Implemented Interfaces:

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

public class RealScalarSubFunction
extends SubFunction<java.lang.Double>
implements RealScalarFunction

This constructs a RealScalarFunction from another RealScalarFunction by restricting/fixing the values of a subset of variables.

See Also:

Serialized Form

Nested Class Summary

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

Function.EvaluationException

Field Summary

Fields inherited from class com.numericalmethod.suanshu.analysis.function.SubFunction

f, fixing

Constructor Summary

Constructors

Constructor and Description
RealScalarSubFunction(RealScalarFunction f, java.util.Map<java.lang.Integer,java.lang.Double> fixing) Construct a scalar sub-function.

Method Summary

Modifier and Type	Method and Description
double	evaluate(double x) Evaluate the function f at x.
java.lang.Double	evaluate(Vector x) Evaluate the function f at x, where x is from the domain.

Methods inherited from class com.numericalmethod.suanshu.analysis.function.SubFunction

dimensionOfDomain, dimensionOfRange, getAllParts, getVariablePart, isFixedIndex

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.numericalmethod.suanshu.analysis.function.Function

dimensionOfDomain, dimensionOfRange

Constructor Detail

RealScalarSubFunction

public RealScalarSubFunction(RealScalarFunction f,
                             java.util.Map<java.lang.Integer,java.lang.Double> fixing)

Construct a scalar sub-function.

Parameters:

f - the unrestricted/original function

fixing - the values held fixed for a subset of variables

Method Detail

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 double evaluate(double x)

Evaluate the function f at x.

Parameters:

x - x

Returns:

f(x)