Package edu.cmu.tetrad.util.dist

Class ChiSquare

java.lang.Object
edu.cmu.tetrad.util.dist.ChiSquare
All Implemented Interfaces:
Distribution, TetradSerializable, Serializable
public class ChiSquare extends Object implements Distribution
Wraps a chi square distribution for purposes of drawing random samples. Methods are provided to allow parameters to be manipulated in an interface. See Wikipedia.
Version:
$Id: $Id
Author:
josephramsey
See Also:

  • Method Details

    • serializableInstance

      public static ChiSquare serializableInstance()
      Generates a simple exemplar of this class to test serialization.
      Returns:
      the exemplar.

    • setParameter

      public void setParameter(int index, double value)
      Sets the index'th parameter to the given value.
      Specified by:
      setParameter in interface Distribution
      Parameters:
      index - The index of the parameter to be set. Must be >= 0 and < # parameters.
      value - The value to set the parameter to.
      Throws:
      IllegalArgumentException - If the index is invalid or the value is illegal.

    • getParameter

      public double getParameter(int index)
      Returns the index'th parameter of the distribution.
      Specified by:
      getParameter in interface Distribution
      Parameters:
      index - The index of the parameter to retrieve. Must be >= 0 and < number of parameters.
      Returns:
      The value of the parameter.
      Throws:
      IllegalArgumentException - If the index is invalid.

    • getParameterName

      public String getParameterName(int index)
      Gets the name of the index'th parameter of the distribution.
      Specified by:
      getParameterName in interface Distribution
      Parameters:
      index - The index of the parameter to retrieve. Must be >= 0 and < number of parameters.
      Returns:
      The name of the parameter.
      Throws:
      IllegalArgumentException - If the index is invalid.

    • getNumParameters

      public int getNumParameters()

      getNumParameters.

      Specified by:
      getNumParameters in interface Distribution
      Returns:
      a int

    • getName

      public String getName()

      getName.

      Specified by:
      getName in interface Distribution
      Returns:
      a String object

    • nextRandom

      public double nextRandom()

      nextRandom.

      Specified by:
      nextRandom in interface Distribution
      Returns:
      a double

    • toString

      public String toString()

      toString.

      Overrides:
      toString in class Object
      Returns:
      a String object