maspack.function

Class ConstantFunction1x1

java.lang.Object

maspack.function.Diff1Function1x1Base

maspack.function.ConstantFunction1x1

All Implemented Interfaces:

java.lang.Cloneable, Diff1Function1x1, Diff1FunctionNx1, Function1x1, FunctionNx1, Clonable, Scannable

public class ConstantFunction1x1
extends Diff1Function1x1Base

Constructor Summary

Constructors

Constructor and Description
ConstantFunction1x1()
ConstantFunction1x1(double c)

Method Summary

Modifier and Type	Method and Description
ConstantFunction1x1	clone()
boolean	equals(ConstantFunction1x1 fxn)
double	eval(double in) Evaluates the function at a prescribed input value.
double	eval(DoubleHolder deriv, double in) Evaluates both the value and first derivative of this function at a specified input value.
double	eval(VectorNd in) Override this here in case function is called zero-sized vector in.
double	eval(VectorNd deriv, VectorNd in) Override this here in case function is called with a zero-sized vector in.
void	evalDeriv(VectorNd deriv, VectorNd in) Override this here in case function is called with a zero-sized vectors in and/or deriv.
double	getVal()
void	scan(ReaderTokenizer rtok, java.lang.Object ref) Scans this element from a ReaderTokenizer.
void	setVal(double val)
void	write(java.io.PrintWriter pw, NumberFormat fmt, java.lang.Object ref) Writes a text description of this element to a PrintWriter.

Methods inherited from class maspack.function.Diff1Function1x1Base

isWritable

Methods inherited from class java.lang.Object

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

Methods inherited from interface maspack.function.Diff1Function1x1

evalDeriv

Methods inherited from interface maspack.function.Function1x1

inputSize

Constructor Detail

ConstantFunction1x1

public ConstantFunction1x1()

ConstantFunction1x1

public ConstantFunction1x1(double c)

Method Detail

getVal

public double getVal()

setVal

public void setVal(double val)

eval

public double eval(double in)

Description copied from class: Diff1Function1x1Base

Evaluates the function at a prescribed input value.

Specified by:

eval in interface Function1x1

Specified by:

eval in class Diff1Function1x1Base

Parameters:

in - input value

Returns:

function output value

eval

public double eval(VectorNd in)

Override this here in case function is called zero-sized vector in.

Returns:

function output value

eval

public double eval(DoubleHolder deriv,
                   double in)

Description copied from class: Diff1Function1x1Base

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

Specified by:

eval in interface Diff1Function1x1

Specified by:

eval in class Diff1Function1x1Base

Parameters:

deriv - if non-null, returns the derivative value

in - input value

Returns:

function value

eval

public double eval(VectorNd deriv,
                   VectorNd in)

Override this here in case function is called with a zero-sized vector in.

Parameters:

deriv - if not null, returns the derivative values

in - function input values

Returns:

function output value

evalDeriv

public void evalDeriv(VectorNd deriv,
                      VectorNd in)

Override this here in case function is called with a zero-sized vectors in and/or deriv.

Parameters:

deriv - returns the derivative values

in - function input values

equals

public boolean equals(ConstantFunction1x1 fxn)

scan

public void scan(ReaderTokenizer rtok,
                 java.lang.Object ref)
          throws java.io.IOException

Description copied from interface: Scannable

Scans this element from a ReaderTokenizer. The expected text format is assumed to be compatible with that produced by write.

Specified by:

scan in interface Scannable

Overrides:

scan in class Diff1Function1x1Base

Parameters:

rtok - Tokenizer from which to scan the element

ref - optional reference object which can be used for resolving references to other objects

Throws:

java.io.IOException - if an I/O or formatting error occured

write

public void write(java.io.PrintWriter pw,
                  NumberFormat fmt,
                  java.lang.Object ref)

Description copied from interface: Scannable

Writes a text description of this element to a PrintWriter. The text description should be compatable with scan and complete enough to allow full reconstruction of the element.

Specified by:

write in interface Scannable

Overrides:

write in class Diff1Function1x1Base

Parameters:

pw - stream for writing the element

fmt - numeric formating information

ref - optional reference object which can be used for producing references to other objects

clone

public ConstantFunction1x1 clone()

Specified by:

clone in interface Clonable

Overrides:

clone in class Diff1Function1x1Base