Package edu.cmu.tetrad.util.dist

Class Split

java.lang.Object
edu.cmu.tetrad.util.dist.Split
All Implemented Interfaces:
Distribution, TetradSerializable, Serializable
public class Split 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.
Author:
josephramsey
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    Split(double a, double b)
    Creates a new split distribution, drawing uniformly from [-b, -a] U [a, b], where a and b are positive real numbers.

  • Method Summary

    Modifier and Type
    Method
    Description
    double
    getA()
     
    double
    getB()
     
    String
    getName()
    Returns the name of the distribution.
    int
    getNumParameters()
    Returns the number of parameters in the distribution.
    double
    getParameter(int index)
    Returns the index'th parameter.
    String
    getParameterName(int index)
    The name of the index'th parameter, for display purposes.
    double
    nextRandom()
    Returns the next random number from the distribution.
    static Split
    serializableInstance()
    Generates a simple exemplar of this class to test serialization.
    void
    setParameter(int index, double value)
    Sets the index'th parameter to the given value.
    String
    toString()
     

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • Split

      public Split(double a, double b)
      Creates a new split distribution, drawing uniformly from [-b, -a] U [a, b], where a and b are positive real numbers.
      Parameters:
      a - Ibid.
      b - Ibid.

  • Method Details

    • serializableInstance

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

    • nextRandom

      public double nextRandom()
      Description copied from interface: Distribution
      Returns the next random number from the distribution.
      Specified by:
      nextRandom in interface Distribution
      Returns:
      a random value from [-b, -a] U [a, b].

    • getA

      public double getA()

    • getB

      public double getB()

    • getName

      public String getName()
      Description copied from interface: Distribution
      Returns the name of the distribution.
      Specified by:
      getName in interface Distribution
      Returns:
      the name.

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • setParameter

      public void setParameter(int index, double value)
      Description copied from interface: Distribution
      Sets the index'th parameter to the given value.
      Specified by:
      setParameter in interface Distribution
      Parameters:
      index - Ibid. Must be >= 0 and < # parameters.
      value - Ibid.

    • getParameter

      public double getParameter(int index)
      Description copied from interface: Distribution
      Returns the index'th parameter.
      Specified by:
      getParameter in interface Distribution
      Parameters:
      index - Ibid. Muist be <= 0 and < # parameters.
      Returns:
      The Ibid.

    • getParameterName

      public String getParameterName(int index)
      Description copied from interface: Distribution
      The name of the index'th parameter, for display purposes.
      Specified by:
      getParameterName in interface Distribution
      Parameters:
      index - Ibid. Must be >= 0 and < # parameters.
      Returns:
      Ibid.

    • getNumParameters

      public int getNumParameters()
      Description copied from interface: Distribution
      Returns the number of parameters in the distribution.
      Specified by:
      getNumParameters in interface Distribution
      Returns:
      the number of parameters.