@CodeReview(reviewer="Kevin R. Dixon",date="2009-07-06",changesNeeded=false,comments={"Made clone() call super.clone().","Otherwise, class looks fine."}) @CodeReview(reviewer="Justin Basilico",date="2006-10-05",changesNeeded=false,comments="Class looks fine.") @PublicationReference(author="Wikipedia", title="Sigmoid function", type=WebPage, year=2008, url="http://en.wikipedia.org/wiki/Sigmoid_function") public class SigmoidFunction extends AbstractDifferentiableUnivariateScalarFunction
| Constructor and Description |
|---|
SigmoidFunction()
Creates a new instance of SigmoidFunction
|
| Modifier and Type | Method and Description |
|---|---|
SigmoidFunction |
clone()
This makes public the clone method on the
Object class and
removes the exception that it throws. |
double |
differentiate(double input)
Differentiates the output of the function about the given input
|
double |
evaluate(double input)
Evaluates the squashing function on the given input value.
|
static double |
logistic(double input)
Utility method to evaluate a logistic sigmoid.
|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitdifferentiateevaluate, evaluateAsDoublepublic SigmoidFunction()
public SigmoidFunction 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 CloneableSerializableclone in class AbstractCloneableSerializablepublic double evaluate(double input)
input - The input value to squash.public double differentiate(double input)
DifferentiableUnivariateScalarFunctioninput - Input about which to compute the derivative of the function outputpublic static double logistic(double input)
input - The input value.