BivariateLogNormalRV

class BivariateLogNormalRV @JvmOverloads constructor(val m1: Double = 1.0, val v1: Double = 1.0, val m2: Double = 1.0, val v2: Double = 1.0, val corr: Double = 0.0, streamNum: Int = 0, streamProvider: RNStreamProviderIfc = KSLRandom.DefaultRNStreamProvider, name: String? = null) : MVRVariable(source)

Allows for the generation of bi-variate lognormal random variables. These parameters are all for the lognormal distribution

Parameters

m1

mean of first coordinate

v1

variance of first coordinate

m2

mean of 2nd coordinate

v2

variance of 2nd coordinate

corr

correlation between X1 and X2

streamNum

the random number stream number, defaults to 0, which means the next stream

streamProvider

the provider of random number streams, defaults to KSLRandom.DefaultRNStreamProvider

name

an optional name

Constructors

Link copied to clipboard
constructor(m1: Double = 1.0, v1: Double = 1.0, m2: Double = 1.0, v2: Double = 1.0, corr: Double = 0.0, streamNum: Int = 0, streamProvider: RNStreamProviderIfc = KSLRandom.DefaultRNStreamProvider, name: String? = null)

Properties

Link copied to clipboard
val corr: Double = 0.0
Link copied to clipboard
open override val dimension: Int

the expected size of the array from sample()

Link copied to clipboard
val m1: Double = 1.0
Link copied to clipboard
val m2: Double = 1.0
Link copied to clipboard
val v1: Double = 1.0
Link copied to clipboard
val v2: Double = 1.0

Functions

Link copied to clipboard
open override fun instance(streamNumber: Int, rnStreamProvider: RNStreamProviderIfc): MVRVariableIfc
Link copied to clipboard
open override fun toString(): String