Class BootStrapStatistics

java.lang.Object
ffx.numerics.math.BootStrapStatistics

public class BootStrapStatistics extends Object
The BootStrapStatistics class uses bootstrapping to estimate statistics from a given population.
Since:
1.0
Author:
Michael J. Schnieders, Rose Gogal
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    final long
     
    final long
     
    final double
     
    final double
     
    final double
     
    final double
     
    final double
     
    final double
     
    final double
     
    final double
     
    final double
     
  • Constructor Summary

    Constructors
    Constructor
    Description
    BootStrapStatistics(double[] values)
    Constructs a static summary of a statistic from provided values.
    BootStrapStatistics(double[] values, double[] weights, int first, int last, int stride)
    Constructs a static summary of a statistic from provided values.
    BootStrapStatistics(double[] values, int first)
    Constructs a static summary of a statistic from provided values.
    BootStrapStatistics(double[] values, int first, int last)
    Constructs a static summary of a statistic from provided values.
    BootStrapStatistics(double[] values, int first, int last, int stride)
    Constructs a static summary of a statistic from provided values.
  • Method Summary

    Modifier and Type
    Method
    Description
    double
    Computes a 95% confidence interval based on a Student's T-distribution.
    double
    confidenceInterval(double alpha)
    Computes a confidence interval based on a Student's T-distribution.
    Describe the Summary Statistics.
    double
    The mean.
    double
    The standard deviation.
    double
    The variance.
    $

    Methods inherited from class java.lang.Object

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

    • mean

      public final double mean
    • var

      public final double var
    • varPopulation

      public final double varPopulation
    • sd

      public final double sd
    • sdPopulation

      public final double sdPopulation
    • sumWeights

      public final double sumWeights
    • min

      public final double min
    • max

      public final double max
    • count

      public final long count
    • sum

      public final double sum
    • dof

      public final long dof
  • Constructor Details

    • BootStrapStatistics

      public BootStrapStatistics(double[] values)
      Constructs a static summary of a statistic from provided values. Assumes weights are all constant (1.0). Assumes all values will be used.
      Parameters:
      values - Values to summarize.
    • BootStrapStatistics

      public BootStrapStatistics(double[] values, int first)
      Constructs a static summary of a statistic from provided values. Assumes weights are all constant (1.0). Assumes all values from first to end will be used.
      Parameters:
      values - Values to summarize.
      first - First value to use.
    • BootStrapStatistics

      public BootStrapStatistics(double[] values, int first, int last)
      Constructs a static summary of a statistic from provided values. Assumes weights are all constant (1.0). Assumes a stride of 1.
      Parameters:
      values - Values to summarize.
      first - First value to use.
      last - Last value to use.
    • BootStrapStatistics

      public BootStrapStatistics(double[] values, int first, int last, int stride)
      Constructs a static summary of a statistic from provided values. Assumes weights are all constant (1.0).
      Parameters:
      values - Values to summarize.
      first - First value to use.
      last - Last value to use.
      stride - Stride between values used.
    • BootStrapStatistics

      public BootStrapStatistics(double[] values, @Nullable double[] weights, int first, int last, int stride)
      Constructs a static summary of a statistic from provided values.
      Parameters:
      values - Values to summarize.
      weights - Weights for each value.
      first - First value to use.
      last - Last value to use.
      stride - Stride between values used.
  • Method Details

    • confidenceInterval

      public double confidenceInterval()
      Computes a 95% confidence interval based on a Student's T-distribution.
      Returns:
      95% confidence interval.
    • confidenceInterval

      public double confidenceInterval(double alpha)
      Computes a confidence interval based on a Student's T-distribution.
      Parameters:
      alpha - Alpha (e.g. 0.05 for a 95% CI).
      Returns:
      Confidence interval.
    • getMean

      public double getMean()
      The mean.
      Returns:
      Return the mean.
    • getSd

      public double getSd()
      The standard deviation.
      Returns:
      Return the standard deviation.
    • getVar

      public double getVar()
      The variance.
      Returns:
      Return the variance.
    • toString

      public String toString()
      $
      Overrides:
      toString in class Object
    • describe

      public String describe()
      Describe the Summary Statistics.
      Returns:
      Return the description.