Package org.hipparchus.analysis.function

Class Logistic

java.lang.Object
org.hipparchus.analysis.function.Logistic
All Implemented Interfaces:
UnivariateDifferentiableFunction, UnivariateFunction
public class Logistic extends Object implements UnivariateDifferentiableFunction
Generalised logistic function.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    Logistic.Parametric
    Parametric function where the input array contains the parameters of the logistic function, ordered as follows: k m b q a n

  • Constructor Summary

    Constructors
    Constructor
    Description
    Logistic(double k, double m, double b, double q, double a, double n)
    Simple constructor.

  • Method Summary

    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 Details

    • Logistic

      public Logistic(double k, double m, double b, double q, double a, double n) throws MathIllegalArgumentException
      Simple constructor.
      Parameters:
      k - If b > 0, value of the function for x going towards +∞. If b < 0, value of the function for x going towards -∞.
      m - Abscissa of maximum growth.
      b - Growth rate.
      q - Parameter that affects the position of the curve along the ordinate axis.
      a - 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:
      MathIllegalArgumentException - if n <= 0.

  • Method Details

    • 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 <T extends Derivative<T>> T value(T t)
      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