maspack.function

Class PolyFunction1x1Base

java.lang.Object

maspack.function.Diff1Function1x1Base

maspack.function.PolyFunction1x1Base

All Implemented Interfaces:

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

Direct Known Subclasses:

CubicFunction1x1, LinearFunction1x1, QuadraticFunction1x1

public abstract class PolyFunction1x1Base
extends Diff1Function1x1Base

Constructor Summary

Constructors

Constructor and Description
PolyFunction1x1Base()

Method Summary

Modifier and Type	Method and Description
PolyFunction1x1Base	clone()
boolean	equals(PolyFunction1x1Base fxn)
double	eval(double x) Evaluates the function at a prescribed input value.
double	eval(DoubleHolder deriv, double x) Evaluates both the value and first derivative of this function at a specified input value.
double	evalDeriv(double x) Evaluates first derivative of this function at a specified input value.
double	getA(int idx)
double[]	getCoefficents()
abstract int	numCoefficients()
void	scan(ReaderTokenizer rtok, java.lang.Object ref) Scans this element from a ReaderTokenizer.
void	setA(int idx, int a)
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

eval, evalDeriv

Methods inherited from interface maspack.function.Function1x1

eval, inputSize

Constructor Detail

PolyFunction1x1Base

public PolyFunction1x1Base()

Method Detail

getCoefficents

public double[] getCoefficents()

numCoefficients

public abstract int numCoefficients()

getA

public double getA(int idx)

setA

public void setA(int idx,
                 int a)

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

evalDeriv

public double evalDeriv(double x)

Description copied from interface: Diff1Function1x1

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

Parameters:

x - input value

Returns:

derivative value

eval

public double eval(DoubleHolder deriv,
                   double x)

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

x - input value

Returns:

function value

equals

public boolean equals(PolyFunction1x1Base 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 PolyFunction1x1Base clone()

Specified by:

clone in interface Clonable

Overrides:

clone in class Diff1Function1x1Base