Class NormalDistributionFunction2D

  • All Implemented Interfaces:
    java.io.Serializable, Function2D

    public class NormalDistributionFunction2D
    extends java.lang.Object
    implements Function2D, java.io.Serializable
    A normal distribution function. See http://en.wikipedia.org/wiki/Normal_distribution.
    See Also:
    Serialized Form
    • Field Summary

      Fields 
      Modifier and Type Field Description
      private double denominator
      Precomputed denominator for the function value.
      private double factor
      Precomputed factor for the function value.
      private double mean
      The mean.
      private double std
      The standard deviation.
    • Constructor Summary

      Constructors 
      Constructor Description
      NormalDistributionFunction2D​(double mean, double std)
      Constructs a new normal distribution function.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)
      Tests this function for equality with an arbitrary object.
      double getMean()
      Returns the mean for the function.
      double getStandardDeviation()
      Returns the standard deviation for the function.
      double getValue​(double x)
      Returns the function value.
      int hashCode()
      Returns a hash code for this instance.
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • mean

        private double mean
        The mean.
      • std

        private double std
        The standard deviation.
      • factor

        private double factor
        Precomputed factor for the function value.
      • denominator

        private double denominator
        Precomputed denominator for the function value.
    • Constructor Detail

      • NormalDistributionFunction2D

        public NormalDistributionFunction2D​(double mean,
                                            double std)
        Constructs a new normal distribution function.
        Parameters:
        mean - the mean.
        std - the standard deviation (> 0).
    • Method Detail

      • getMean

        public double getMean()
        Returns the mean for the function.
        Returns:
        The mean.
      • getStandardDeviation

        public double getStandardDeviation()
        Returns the standard deviation for the function.
        Returns:
        The standard deviation.
      • getValue

        public double getValue​(double x)
        Returns the function value.
        Specified by:
        getValue in interface Function2D
        Parameters:
        x - the x-value.
        Returns:
        The value.
      • equals

        public boolean equals​(java.lang.Object obj)
        Tests this function for equality with an arbitrary object.
        Overrides:
        equals in class java.lang.Object
        Parameters:
        obj - the object (null permitted).
        Returns:
        A boolean.
      • hashCode

        public int hashCode()
        Returns a hash code for this instance.
        Overrides:
        hashCode in class java.lang.Object
        Returns:
        A hash code.