maspack.function

Interface Diff1Function1x1

All Superinterfaces:

Diff1FunctionNx1, Function1x1, FunctionNx1

All Known Implementing Classes:

ConstantFunction1x1, CubicFunction1x1, CubicHermiteSpline1d, Diff1Function1x1Base, LinearFunction1x1, LinearSpline1d, PolyFunction1x1Base, QuadraticFunction1x1, ScaledDiff1Function1x1

public interface Diff1Function1x1
extends Function1x1, Diff1FunctionNx1

Once-differentiable single-input, single output function

Method Summary

Modifier and Type	Method and Description
double	eval(DoubleHolder dval, double x) Evaluates both the value and first derivative of this function at a specified input value.
default double	eval(VectorNd deriv, VectorNd in) Evaluates this function for the specified inputs.
default double	evalDeriv(double x) Evaluates first derivative of this function at a specified input value.
default void	evalDeriv(VectorNd deriv, VectorNd in) Evaluates the derivative of this function for the specified inputs.

Methods inherited from interface maspack.function.Function1x1

eval, eval, inputSize

Method Detail

eval

double eval(DoubleHolder dval,
            double x)

Evaluates both the value and first derivative of this function at a specified input value.

Parameters:

dval - if non-null, returns the derivative value

x - input value

Returns:

function value

evalDeriv

default double evalDeriv(double x)

Evaluates first derivative of this function at a specified input value.

Parameters:

x - input value

Returns:

derivative value

eval

default double eval(VectorNd deriv,
                    VectorNd in)

Description copied from interface: Diff1FunctionNx1

Evaluates this function for the specified inputs. If deriv is not null, the derivative is also computed and returned in this argument. The input vector size should equal the value returned by FunctionNx1.inputSize(). If present, deriv will be resized, if necessary, to FunctionNx1.inputSize().

Specified by:

eval in interface Diff1FunctionNx1

Parameters:

deriv - if not null, returns the derivative values

in - function input values

Returns:

function output value

evalDeriv

default void evalDeriv(VectorNd deriv,
                       VectorNd in)

Description copied from interface: Diff1FunctionNx1

Evaluates the derivative of this function for the specified inputs. The input vector size should equal the value returned by FunctionNx1.inputSize(). The derivative vector will be resized, if necessary, to FunctionNx1.inputSize().

Specified by:

evalDeriv in interface Diff1FunctionNx1

Parameters:

deriv - returns the derivative values

in - function input values