maspack.function

Interface Diff1FunctionNx1

All Superinterfaces:

FunctionNx1

All Known Subinterfaces:

Diff1Function1x1

All Known Implementing Classes:

ConstantFunction1x1, CubicFunction1x1, CubicHermiteSpline1d, Diff1Function1x1Base, Diff1FunctionNx1Base, LinearFunction1x1, LinearFunctionNx1, LinearSpline1d, PolyFunction1x1Base, QuadraticFunction1x1, ScaledDiff1Function1x1, ScaledDiff1FunctionNx1

public interface Diff1FunctionNx1
extends FunctionNx1

Once-differentiable muliple-input, single output function

Method Summary

Modifier and Type	Method and Description
double	eval(VectorNd deriv, VectorNd in) Evaluates this function for the specified inputs.
default void	evalDeriv(VectorNd deriv, VectorNd in) Evaluates the derivative of this function for the specified inputs.

Methods inherited from interface maspack.function.FunctionNx1

eval, inputSize

Method Detail

eval

double eval(VectorNd deriv,
            VectorNd in)

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().

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)

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().

Parameters:

deriv - returns the derivative values

in - function input values