fr.cnes.sirius.patrius.math.analysis.function

Class Logistic

java.lang.Object

fr.cnes.sirius.patrius.math.analysis.function.Logistic

All Implemented Interfaces:

UnivariateDifferentiableFunction, UnivariateFunction, Serializable

public class Logistic
extends Object
implements UnivariateDifferentiableFunction

Generalised logistic function.

Since:

3.0

Version:

$Id: Logistic.java 18108 2017-10-04 06:45:27Z bignon $

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Logistic.Parametric Parametric function where the input array contains the parameters of the logit function, ordered as follows: Lower asymptote Higher asymptote

Constructor Summary

Constructors

Constructor and Description
Logistic(double kIn, double mIn, double bIn, double qIn, double aIn, double n)

Method Summary

Modifier and Type	Method and Description
DerivativeStructure	value(DerivativeStructure t) Simple mathematical function.
double	value(double x) Compute the value of the function.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Logistic

public Logistic(double kIn,
                double mIn,
                double bIn,
                double qIn,
                double aIn,
                double n)

Parameters:

kIn - If b > 0, value of the function for x going towards +∞. If b < 0, value of the function for x going towards -∞.

mIn - Abscissa of maximum growth.

bIn - Growth rate.

qIn - Parameter that affects the position of the curve along the ordinate axis.

aIn - If b > 0, value of the function for x going towards -∞. If b < 0, value of the function for x going towards +∞.

n - Parameter that affects near which asymptote the maximum growth occurs.

Throws:

NotStrictlyPositiveException - if n <= 0.

Method Detail

value

public double value(double x)

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.

value

public DerivativeStructure value(DerivativeStructure t)

Simple mathematical function.

UnivariateDifferentiableFunction classes compute both the value and the first derivative of the function.

Specified by:

value in interface UnivariateDifferentiableFunction

Parameters:

t - function input value

Returns:

function result

Since:

3.1