@CodeReview(reviewer="Kevin R. Dixon",date="2009-07-06",changesNeeded=false,comments={"Made clone() call super.clone().","Minor clean up of javadoc.","Otherwise, class looks fine."}) @CodeReview(reviewer="Justin Basilico",date="2006-10-05",changesNeeded=false,comments="Class looks fine.") public class AtanFunction extends AbstractDifferentiableUnivariateScalarFunction implements Vectorizable
| Modifier and Type | Field and Description |
|---|---|
protected static double |
DEFAULT_MAX_MAGNITUDE
The default max magnitude, which is PI / 2.
|
| Constructor and Description |
|---|
AtanFunction()
Creates a new instance of AtanFunction with the standard
unit magnitude of -PI / 2 to PI / 2.
|
AtanFunction(double maxMagnitude)
Creates a new instance of AtanFunction.
|
| Modifier and Type | Method and Description |
|---|---|
AtanFunction |
clone()
This makes public the clone method on the
Object class and
removes the exception that it throws. |
void |
convertFromVector(Vector parameters)
Converts the object from a Vector of parameters.
|
Vector |
convertToVector()
Converts the object to a vector.
|
double |
differentiate(double input)
Differentiates the output of the function about the given input
|
double |
evaluate(double input)
Produces a double output for the given double input
|
double |
getMaxMagnitude()
Getter for maxMagnitude.
|
void |
setMaxMagnitude(double maxMagnitude)
Setter for maxMagnitude.
|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitdifferentiateevaluate, evaluateAsDoubleprotected static final double DEFAULT_MAX_MAGNITUDE
public AtanFunction()
public AtanFunction(double maxMagnitude)
maxMagnitude - maximum magnitude value of the function at
infinity and -infinitypublic double evaluate(double input)
UnivariateScalarFunctionevaluate in interface UnivariateScalarFunctioninput - Input to the Evaluatorpublic double getMaxMagnitude()
public void setMaxMagnitude(double maxMagnitude)
maxMagnitude - maximum magnitude value of the function at
infinity and -infinitypublic double differentiate(double input)
DifferentiableUnivariateScalarFunctiondifferentiate in interface DifferentiableUnivariateScalarFunctioninput - Input about which to compute the derivative of the function outputpublic AtanFunction clone()
AbstractCloneableSerializableObject class and
removes the exception that it throws. Its default behavior is to
automatically create a clone of the exact type of object that the
clone is called on and to copy all primitives but to keep all references,
which means it is a shallow copy.
Extensions of this class may want to override this method (but call
super.clone() to implement a "smart copy". That is, to target
the most common use case for creating a copy of the object. Because of
the default behavior being a shallow copy, extending classes only need
to handle fields that need to have a deeper copy (or those that need to
be reset). Some of the methods in ObjectUtil may be helpful in
implementing a custom clone method.
Note: The contract of this method is that you must use
super.clone() as the basis for your implementation.clone in interface Vectorizableclone in interface CloneableSerializableclone in class AbstractCloneableSerializablepublic Vector convertToVector()
VectorizableconvertToVector in interface Vectorizablepublic void convertFromVector(Vector parameters)
VectorizableconvertFromVector in interface Vectorizableparameters - The parameters to incorporate.