Class DistributionSampler

java.lang.Object

edu.cmu.tetrad.sem.DistributionSampler

All Implemented Interfaces:

Sampler

public class DistributionSampler
extends Object
implements Sampler

The Sampler class provides functionality for sampling values from a specified probability distribution. This class wraps around an implementation of RealDistribution to enable sampling from distributions such as normal, uniform, or others supported by the provided distribution implementation. The RealDistribution instance used by this class is passed during construction and must implement the sampling behavior according to its distribution type.

Constructor Summary

Constructors

Constructor	Description
DistributionSampler(org.apache.commons.math3.distribution.RealDistribution distribution)	Constructs a Sampler instance with the specified probability distribution.

Method Summary

Modifier and Type	Method	Description
org.apache.commons.math3.distribution.RealDistribution	getDistribution()	Retrieves the probability distribution encapsulated within this instance.
double	sample()	Generates a single random sample from the probability distribution encapsulated within the Sampler instance.

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DistributionSampler

public DistributionSampler(org.apache.commons.math3.distribution.RealDistribution distribution)

Constructs a Sampler instance with the specified probability distribution.

Parameters:

distribution - A RealDistribution instance representing the probability distribution to sample from. The specified distribution provides methods for generating random values based on its inherent properties.

Method Details

getDistribution

public org.apache.commons.math3.distribution.RealDistribution getDistribution()

Retrieves the probability distribution encapsulated within this instance. This method returns the RealDistribution object that represents the probability distribution used for generating samples or performing probability-related computations. The distribution is defined during the object's construction and remains immutable throughout its lifetime.

Returns:

The RealDistribution instance representing the probability distribution.

sample

public double sample()

Generates a single random sample from the probability distribution encapsulated within the Sampler instance. This method uses the sample() method of the underlying RealDistribution to produce a random value drawn from the specified distribution. The type of distribution (e.g., normal, uniform, etc.) determines the characteristics of the sample.

Specified by:

sample in interface Sampler

Returns:

A random sample as a double value, generated according to the properties of the underlying probability distribution.