java.lang.Object
org.apache.commons.math3.analysis.function.Gaussian
All Implemented Interfaces:
DifferentiableUnivariateFunction, UnivariateDifferentiableFunction, UnivariateFunction

Gaussian function.
Since:
3.0
  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    Parametric function where the input array contains the parameters of the Gaussian, ordered as follows: Norm Mean Standard deviation
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private final double
    Inverse of twice the square of the standard deviation.
    private final double
    Inverse of the standard deviation.
    private final double
    Mean.
    private final double
    Normalization factor.
  • Constructor Summary

    Constructors
    Constructor
    Description
    Normalized gaussian with zero mean and unit standard deviation.
    Gaussian(double mean, double sigma)
    Normalized gaussian with given mean and standard deviation.
    Gaussian(double norm, double mean, double sigma)
    Gaussian with given normalization factor, mean and standard deviation.
  • Method Summary

    Modifier and Type
    Method
    Description
    Deprecated.
    as of 3.1, replaced by value(DerivativeStructure)
    double
    value(double x)
    Compute the value of the function.
    private static double
    value(double xMinusMean, double norm, double i2s2)
     
    Simple mathematical function.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Field Details

    • mean

      private final double mean
      Mean.
    • is

      private final double is
      Inverse of the standard deviation.
    • i2s2

      private final double i2s2
      Inverse of twice the square of the standard deviation.
    • norm

      private final double norm
      Normalization factor.
  • Constructor Details

    • Gaussian

      public Gaussian(double norm, double mean, double sigma) throws NotStrictlyPositiveException
      Gaussian with given normalization factor, mean and standard deviation.
      Parameters:
      norm - Normalization factor.
      mean - Mean.
      sigma - Standard deviation.
      Throws:
      NotStrictlyPositiveException - if sigma <= 0.
    • Gaussian

      public Gaussian(double mean, double sigma) throws NotStrictlyPositiveException
      Normalized gaussian with given mean and standard deviation.
      Parameters:
      mean - Mean.
      sigma - Standard deviation.
      Throws:
      NotStrictlyPositiveException - if sigma <= 0.
    • Gaussian

      public Gaussian()
      Normalized gaussian with zero mean and unit standard deviation.
  • Method Details