Bernoulli

Provides an implementation of the Bernoulli distribution with success probability (p) P(X=1) = p P(X=0) = 1-p

Parameters

successProb

the probability of success, must be between (0,1)

name

an optional name

Constructors

Link copied to clipboard
constructor(params: DoubleArray, name: String?)
constructor(successProb: Double = 0.5, name: String? = null)

Properties

Link copied to clipboard

Functions

Link copied to clipboard
open override fun cdf(x: Double): Double

Returns the F(x) = Pr{X <= x} where F represents the cumulative distribution function

Link copied to clipboard
open override fun instance(): Bernoulli
Link copied to clipboard
open override fun invCDF(p: Double): Double

Provides the inverse cumulative distribution function for the distribution

Link copied to clipboard
open override fun mean(): Double

Returns the mean or expected value of a distribution

Link copied to clipboard
open override fun parameters(): DoubleArray

Gets the parameters

open override fun parameters(params: DoubleArray)

Sets the parameters

Link copied to clipboard
open override fun pmf(x: Double): Double

If x is not an integer value, then the probability must be zero otherwise pmf(int x) is used to determine the probability

open override fun pmf(i: Int): Double

Returns the f(i) where f represents the probability mass function for the distribution.

Link copied to clipboard
open override fun randomVariable(streamNumber: Int, streamProvider: RNStreamProviderIfc): BernoulliRV

Promises to return a random variable that uses the supplied stream number using the supplied stream provider

Link copied to clipboard
open override fun toString(): String
Link copied to clipboard
open override fun variance(): Double

Returns the variance of the distribution if defined