Package org.hipparchus.analysis.function
Class Sigmoid
java.lang.Object
org.hipparchus.analysis.function.Sigmoid
- All Implemented Interfaces:
UnivariateDifferentiableFunction
,UnivariateFunction
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
Parametric function where the input array contains the parameters of thesigmoid function
, ordered as follows: Lower asymptote Higher asymptote -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptiondouble
value
(double x) Compute the value of the function.<T extends Derivative<T>>
Tvalue
(T t) Compute the value for the function.
-
Constructor Details
-
Sigmoid
public Sigmoid()Usual sigmoid function, where the lower asymptote is 0 and the higher asymptote is 1. -
Sigmoid
public Sigmoid(double lo, double hi) Sigmoid function.- Parameters:
lo
- Lower asymptote.hi
- Higher asymptote.
-
-
Method Details
-
value
public double value(double x) Compute the value of the function.- Specified by:
value
in interfaceUnivariateFunction
- Parameters:
x
- Point at which the function value should be computed.- Returns:
- the value of the function.
-
value
Compute the value for the function.- Specified by:
value
in interfaceUnivariateDifferentiableFunction
- Type Parameters:
T
- the type of the field elements- Parameters:
t
- the point for which the function value should be computed- Returns:
- the value
- Throws:
MathIllegalArgumentException
- ifx
does not satisfy the function's constraints (argument out of bound, or unsupported derivative order for example)
-