Logit (Hipparchus 4.0.2 API)

java.lang.Object
- org.hipparchus.analysis.function.Logit

All Implemented Interfaces:

UnivariateDifferentiableFunction, UnivariateFunction
```
public class Logit
extends Object
implements UnivariateDifferentiableFunction
```
Logit function. It is the inverse of the sigmoid function.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`Logit.Parametric`	Parametric function where the input array contains the parameters of the logit function, ordered as follows: Lower bound Higher bound

Constructor Summary

Constructors
Constructor Description

Logit()
Usual logit function, where the lower bound is 0 and the higher bound is 1.

Logit(double lo, double hi)
Logit function.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`double`	`value(double x)`	Compute the value of the function.
`<T extends Derivative<T>> T`	`value(T t)`	Compute the value for the function.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Logit
```
public Logit()
```
    Usual logit function, where the lower bound is 0 and the higher bound is 1.
  - Logit
```
public Logit(double lo,
             double hi)
```
    Logit function.
    
    Parameters:
    
    lo - Lower bound of the function domain.
    
    hi - Higher bound of the function domain.
- Method Detail
  - value
```
public double value(double x)
             throws MathIllegalArgumentException
```
    Compute the value of the function.
    
    Specified by:
    
    value in interface UnivariateFunction
    
    Parameters:
    
    x - Point at which the function value should be computed.
    
    Returns:
    
    the value of the function.
    
    Throws:
    
    MathIllegalArgumentException
  - value
```
public <T extends Derivative<T>> T value(T t)
                                  throws MathIllegalArgumentException
```
    Compute the value for the function.
    
    Specified by:
    
    value in interface UnivariateDifferentiableFunction
    
    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 - if parameter is outside of function domain