maspack.function

Class ConstantFunction3x1

java.lang.Object

maspack.function.ConstantFunction3x1

All Implemented Interfaces:

Diff1Function3x1, Diff2Function3x1, Function3x1, FunctionNx1

public class ConstantFunction3x1
extends java.lang.Object
implements Diff2Function3x1

Constructor Summary

Constructors

Constructor and Description
ConstantFunction3x1(double c)

Method Summary

Modifier and Type	Method and Description
double	eval(double in)
double	eval(double x, double y, double z)
double	eval(Vector3d in) Evaluates this function for the specified inputs.
double	eval(Vector3d deriv, Vector3d in) Evaluates this function for the specified inputs.
double	eval(VectorNd in) Evaluates this function for the specified inputs.
double	evalDerivative(double x, double y, double z, int dx, int dy, int dz) Evaluates 1st and 2nd order derivatives, one at a time.
double	evalDerivative(Point3d in, int[] derivatives) Evaluates 1st and 2nd order derivatives, one at a time.
double	getVal()
int	inputSize() Queries the number of inputs expected by this function.
void	setVal(double val)

Methods inherited from class java.lang.Object

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

Methods inherited from interface maspack.function.Diff1Function3x1

eval

Constructor Detail

ConstantFunction3x1

public ConstantFunction3x1(double c)

Method Detail

getVal

public double getVal()

setVal

public void setVal(double val)

eval

public double eval(double in)

eval

public double eval(VectorNd in)

Description copied from interface: Diff1Function3x1

Evaluates this function for the specified inputs. The input vector size must the value returned by FunctionNx1.inputSize().

Specified by:

eval in interface Diff1Function3x1

Specified by:

eval in interface Function3x1

Specified by:

eval in interface FunctionNx1

Returns:

function output value

eval

public double eval(Vector3d in)

Description copied from interface: Function3x1

Evaluates this function for the specified inputs.

Specified by:

eval in interface Function3x1

Returns:

function output value

eval

public double eval(Vector3d deriv,
                   Vector3d in)

Description copied from interface: Diff1Function3x1

Evaluates this function for the specified inputs. If deriv is not null, the derivative is also computed and returned in this argument.

Specified by:

eval in interface Diff1Function3x1

Parameters:

deriv - if not null, returns the derivative values

in - function input values

Returns:

function output value

inputSize

public int inputSize()

Description copied from interface: Function3x1

Queries the number of inputs expected by this function.

Specified by:

inputSize in interface Function3x1

Specified by:

inputSize in interface FunctionNx1

Returns:

number of expected inputs

eval

public double eval(double x,
                   double y,
                   double z)

Specified by:

eval in interface Function3x1

evalDerivative

public double evalDerivative(Point3d in,
                             int[] derivatives)

Description copied from interface: Diff2Function3x1

Evaluates 1st and 2nd order derivatives, one at a time.

Specified by:

evalDerivative in interface Diff2Function3x1

evalDerivative

public double evalDerivative(double x,
                             double y,
                             double z,
                             int dx,
                             int dy,
                             int dz)

Description copied from interface: Diff2Function3x1

Evaluates 1st and 2nd order derivatives, one at a time.

Specified by:

evalDerivative in interface Diff2Function3x1