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.
Version:
$Id: $Id
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()
    Getter for the field a.
    double
    getB()
    Getter for the field b.
    String
    getName()
    getName.
    int
    getNumParameters()
    getNumParameters.
    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()
    nextRandom.
    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()
    toString.

    Methods inherited from class java.lang.Object

    equals, 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()

      nextRandom.

      Specified by:
      nextRandom in interface Distribution
      Returns:
      a random value from [-b, -a] U [a, b].

    • getA

      public double getA()

      Getter for the field a.

      Returns:
      a double

    • getB

      public double getB()

      Getter for the field b.

      Returns:
      a double

    • getName

      public String getName()

      getName.

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

    • toString

      public String toString()

      toString.

      Overrides:
      toString in class Object
      Returns:
      a String object

    • 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 - Ibid. Must be >= 0 and < # parameters.
      value - Ibid.

    • getParameter

      public double getParameter(int index)
      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)
      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()

      getNumParameters.

      Specified by:
      getNumParameters in interface Distribution
      Returns:
      a int