maspack.function

Class Diff1Function1x1Base

java.lang.Object

maspack.function.Diff1Function1x1Base

All Implemented Interfaces:

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

Direct Known Subclasses:

ConstantFunction1x1, CubicHermiteSpline1d, LinearSpline1d, PolyFunction1x1Base, ScaledDiff1Function1x1

public abstract class Diff1Function1x1Base
extends java.lang.Object
implements Diff1Function1x1, Scannable, Clonable

Base class for Diff1Function1x1 that implements Scannable

Constructor Summary

Constructors

Constructor and Description
Diff1Function1x1Base()

Method Summary

Modifier and Type	Method and Description
Diff1Function1x1Base	clone()
abstract double	eval(double in) Evaluates the function at a prescribed input value.
abstract double	eval(DoubleHolder deriv, double in) Evaluates both the value and first derivative of this function at a specified input value.
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	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

eval, evalDeriv, evalDeriv

Methods inherited from interface maspack.function.Function1x1

eval, inputSize

Constructor Detail

Diff1Function1x1Base

public Diff1Function1x1Base()

Method Detail

eval

public abstract double eval(double in)

Evaluates the function at a prescribed input value.

Specified by:

eval in interface Function1x1

Parameters:

in - input value

Returns:

function output value

eval

public abstract double eval(DoubleHolder deriv,
                            double in)

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

Specified by:

eval in interface Diff1Function1x1

Parameters:

deriv - if non-null, returns the derivative value

in - input value

Returns:

function 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

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

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

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 Diff1Function1x1Base clone()

Specified by:

clone in interface Clonable

Overrides:

clone in class java.lang.Object