maspack.function

Class ScaledDiff1FunctionNx1

java.lang.Object

maspack.function.Diff1FunctionNx1Base

maspack.function.ScaledDiff1FunctionNx1

All Implemented Interfaces:

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

public class ScaledDiff1FunctionNx1
extends Diff1FunctionNx1Base

Constructor Summary

Constructors

Constructor and Description
ScaledDiff1FunctionNx1()
ScaledDiff1FunctionNx1(double s, Diff1FunctionNx1 fxn)

Method Summary

Modifier and Type	Method and Description
ScaledDiff1FunctionNx1	clone()
double	eval(VectorNd in) Evaluates this function for the specified inputs.
double	eval(VectorNd deriv, VectorNd in) Evaluates this function for the specified inputs.
Diff1FunctionNx1	getFunction()
double	getScale()
int	inputSize() Queries the number of inputs expected by this function.
boolean	isWritable() Returns true if this component should in fact be written to secondary storage.
void	scan(ReaderTokenizer rtok, java.lang.Object ref) Scans this element from a ReaderTokenizer.
void	setFunction(Diff1FunctionNx1 fxn)
void	setScale(double s)
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 java.lang.Object

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

Methods inherited from interface maspack.function.Diff1FunctionNx1

evalDeriv

Constructor Detail

ScaledDiff1FunctionNx1

public ScaledDiff1FunctionNx1()

ScaledDiff1FunctionNx1

public ScaledDiff1FunctionNx1(double s,
                              Diff1FunctionNx1 fxn)

Method Detail

getScale

public double getScale()

setScale

public void setScale(double s)

getFunction

public Diff1FunctionNx1 getFunction()

setFunction

public void setFunction(Diff1FunctionNx1 fxn)

inputSize

public int inputSize()

Description copied from interface: FunctionNx1

Queries the number of inputs expected by this function.

Returns:

number of expected inputs

eval

public double eval(VectorNd in)

Description copied from class: Diff1FunctionNx1Base

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

Specified by:

eval in interface FunctionNx1

Specified by:

eval in class Diff1FunctionNx1Base

Returns:

function output value

eval

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

Specified by:

eval in interface Diff1FunctionNx1

Specified by:

eval in class Diff1FunctionNx1Base

Parameters:

deriv - if not null, returns the derivative values

in - function input values

Returns:

function output value

isWritable

public boolean isWritable()

Description copied from interface: Scannable

Returns true if this component should in fact be written to secondary storage. This gives subclasses control over whether or not they are actually written out.

Specified by:

isWritable in interface Scannable

Overrides:

isWritable in class Diff1FunctionNx1Base

Returns:

true if this component should be written to secondary storage.

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 Diff1FunctionNx1Base

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)
           throws java.io.IOException

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 Diff1FunctionNx1Base

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

Throws:

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

clone

public ScaledDiff1FunctionNx1 clone()

Specified by:

clone in interface Clonable

Overrides:

clone in class Diff1FunctionNx1Base