maspack.function

Class ScaledDiff1Function1x1

java.lang.Object

maspack.function.Diff1Function1x1Base

maspack.function.ScaledDiff1Function1x1

All Implemented Interfaces:

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

public class ScaledDiff1Function1x1
extends Diff1Function1x1Base

Constructor Summary

Constructors

Constructor and Description
ScaledDiff1Function1x1()
ScaledDiff1Function1x1(double s, Diff1Function1x1 fxn)

Method Summary

Modifier and Type	Method and Description
ScaledDiff1Function1x1	clone()
double	eval(double x) Evaluates the function at a prescribed input value.
double	eval(DoubleHolder dval, double x) 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 with a zero-sized vector in and the underlying function is constant.
double	eval(VectorNd deriv, VectorNd in) Override this here in case function is called with zero-sized vectors in and/or deriv and the underlying function is constant.
void	evalDeriv(VectorNd deriv, VectorNd in) Override this here in case function is called with zero-sized vectors in and/or deriv and the underlying function is constant.
Diff1Function1x1	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(Diff1Function1x1 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.Diff1Function1x1

evalDeriv

Constructor Detail

ScaledDiff1Function1x1

public ScaledDiff1Function1x1()

ScaledDiff1Function1x1

public ScaledDiff1Function1x1(double s,
                              Diff1Function1x1 fxn)

Method Detail

getScale

public double getScale()

setScale

public void setScale(double s)

getFunction

public Diff1Function1x1 getFunction()

setFunction

public void setFunction(Diff1Function1x1 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(double x)

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:

x - input value

Returns:

function output value

eval

public double eval(VectorNd in)

Override this here in case function is called with a zero-sized vector in and the underlying function is constant.

Returns:

function output value

eval

public double eval(DoubleHolder dval,
                   double x)

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:

dval - if non-null, returns the derivative value

x - input value

Returns:

function value

eval

public double eval(VectorNd deriv,
                   VectorNd in)

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

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 zero-sized vectors in and/or deriv and the underlying function is constant.

Parameters:

deriv - returns the derivative values

in - function input values

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 Diff1Function1x1Base

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

Throws:

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

clone

public ScaledDiff1Function1x1 clone()

Specified by:

clone in interface Clonable

Overrides:

clone in class Diff1Function1x1Base