Class

Hierarchy

Distribution

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Distribution(__namedParameters: DistributionConstructor): Distribution

- Defined in structures/distribution.ts:94
Parameters
- __namedParameters: DistributionConstructor
Returns Distribution

Properties

Private _engine

_engine: Random

Private _normal

_normal: WeightedDistribution

Private Optional _source

_source?: WeightedDistribution

Accessors

normal

get normal(): WeightedDistribution

- Defined in structures/distribution.ts:123
Returns WeightedDistribution

seed

get seed(): number | number[]

- Defined in structures/distribution.ts:111
Returns number | number[]

source

get source(): undefined | WeightedDistribution

- Defined in structures/distribution.ts:119
Returns undefined | WeightedDistribution

uses

get uses(): number

- Defined in structures/distribution.ts:115
Returns number

Methods

add

add(key: string, value: number): Distribution

- Defined in structures/distribution.ts:164
Adds a key / value pair to a Distribution. Will add to the source distribution by default, unless the distribution only has normalized values.

Parameters
- key: string
  
  Key to be added.
- value: number
  
  Value of the key to add.
Returns Distribution

addValues

addValues(additions: WeightedDistribution): Distribution

- Defined in structures/distribution.ts:187
Adds an object of values to a Distribution. Will add to the source distribution by default, unless the distribution only has normalized values.

Parameters
- additions: WeightedDistribution
  
  An object containing additions.
Returns Distribution

clone

clone(stripSource?: boolean): Distribution

- Defined in structures/distribution.ts:217
Creates a clone of a Distribution instance.

Parameters
- stripSource: boolean = false
  
  If true this will strip out the source.
Returns Distribution

pick

pick(count?: number, mask?: string[], exclusive?: boolean): string[]

- Defined in structures/distribution.ts:144
Picks one more values from a Distribution without exclusion. If you just need to pick one value, you should use pickOne instead.

Parameters
- count: number = 1
  
  The number of picks to make (default 1).
- Optional mask: string[]
  
  A mask containing keys in the distribution that should be ignored.
- exclusive: boolean = false
  
  If true picks are considered exclusive and are removed.
Returns string[]

pickOne

pickOne(mask?: string[]): undefined | string

- Defined in structures/distribution.ts:153
Picks a single value from a Distribution. If you are picking multiple values, use pick instead.

Parameters
- Optional mask: string[]
  
  A mask containing keys in the distribution that should be ignored.
Returns undefined | string

remove

remove(keys: string | string[]): Distribution

- Defined in structures/distribution.ts:196
Removes a key or array of keys from a Distribution and renormalizes.

Parameters
- keys: string | string[]
  
  Key or Keys to be removed.
Returns Distribution

serialize

serialize(stripSource?: boolean): DistributionDTO

- Defined in structures/distribution.ts:205
Serializes a Distribution instance into a data transfer object.

Parameters
- stripSource: boolean = false
  
  If true this will strip out the source.
Returns DistributionDTO

Private update

update(model: DistributionDTO): Distribution

- Defined in structures/distribution.ts:131
Applies a DTO's data to the source and normal distributions.

Parameters
- model: DistributionDTO
  
  A Distribution data transfer object.
Returns Distribution

Static add

add(model: DistributionDTO, key: string, value: number): DistributionDTO

- Defined in structures/distribution.ts:404
Adds a key / value pair to a Distribution. Will add to the source distribution by default, unless the distribution only has normalized values.

Parameters
- model: DistributionDTO
  
  A Distribution data transfer object.
- key: string
  
  Key to be added.
- value: number
  
  Value of the key to add.
Returns DistributionDTO

Static addNormalValue

addNormalValue(model: DistributionDTO, key: string, value: number): DistributionDTO

- Defined in structures/distribution.ts:363
Adds a key / value pair to a normal distribution and renormalizes it. If a source distribution exists, it will be recalculated based off of the new normal distribution.

Parameters
- model: DistributionDTO
  
  A Distribution data transfer object.
- key: string
  
  Key to be added.
- value: number
  
  Value of the key to add.
Returns DistributionDTO

Static addNormalValues

addNormalValues(model: DistributionDTO, additions: WeightedDistribution): DistributionDTO

- Defined in structures/distribution.ts:332
Adds an object of values to a normal Distribution and renormalizes it. If a source distribution exists, it will be recalculated by scaling the new normal distribution to fit its sum.

Parameters
- model: DistributionDTO
  
  A Distribution data transfer object.
- additions: WeightedDistribution
  
  An object containing additions.
Returns DistributionDTO

Static addSourceValue

addSourceValue(model: DistributionSourceDTO, key: string, value: number): DistributionSourceDTO

- Defined in structures/distribution.ts:321
Adds a key / value pair to a distribution's source and renormalizes it. If a source distribution exists, it will be recalculated based off of the new normal distribution.

Parameters
- model: DistributionSourceDTO
  
  A Distribution data transfer object.
- key: string
  
  Key to be added.
- value: number
  
  Value of the key to add.
Returns DistributionSourceDTO

Static addSourceValues

addSourceValues(model: DistributionSourceDTO, additions: WeightedDistribution): DistributionSourceDTO

- Defined in structures/distribution.ts:306
Adds an object of values to a Distribution's source and renormalizes it.

Parameters
- model: DistributionSourceDTO
  
  A Distribution data transfer object.
- additions: WeightedDistribution
  
  An object containing additions.
Returns DistributionSourceDTO

Static addValues

addValues(model: DistributionDTO, additions: WeightedDistribution): DistributionDTO

- Defined in structures/distribution.ts:374
Adds an object of values to a Distribution. Will add to the source distribution by default, unless the distribution only has normalized values.

Parameters
- model: DistributionDTO
  
  A Distribution data transfer object.
- additions: WeightedDistribution
  
  An object containing additions.
Returns DistributionDTO

Static clone

clone(model: DistributionDTO, stripSource?: boolean): DistributionDTO

- Defined in structures/distribution.ts:464
Creates a clone of a Distribution DTO.

Parameters
- model: DistributionDTO
  
  A Distribution data transfer object.
- stripSource: boolean = false
  
  If true this will strip out the source.
Returns DistributionDTO

Static new

new(source?: WeightedDistribution): DistributionSourceDTO

- Defined in structures/distribution.ts:455
Initializes a new DistributionSourceDTO.

Parameters
- Optional source: WeightedDistribution
  
  An optional source of values to generate the distribution from.
Returns DistributionSourceDTO

Static pick

pick(model: DistributionNormalDTO, count?: number, mask?: string[], exclusive?: boolean, engine?: Random): string[]

- Defined in structures/distribution.ts:271
Picks one more values from a Distribution without exclusion. If you just need to pick one value, you should use pickOne instead.

Parameters
- model: DistributionNormalDTO
  
  A Distribution data transfer object.
- count: number = 1
  
  The number of picks to make (default 1).
- Optional mask: string[]
  
  A mask containing keys in the distribution that should be ignored.
- exclusive: boolean = false
  
  If true picks are considered exclusive and are removed.
- Optional engine: Random
  
  A Random engine. This is created if not provided.
Returns string[]

Static pickOne

pickOne(model: DistributionNormalDTO, mask?: string[], engine?: Random): undefined | string

- Defined in structures/distribution.ts:296
Picks a single value from a Distribution. If you are picking multiple values, use pick instead.

Parameters
- model: DistributionNormalDTO
  
  A Distribution data transfer object.
- Optional mask: string[]
  
  A mask containing keys in the distribution that should be ignored.
- Optional engine: Random
  
  A Random engine. This is created if not provided.
Returns undefined | string

Static remove

remove(model: DistributionDTO, keys: string | string[]): DistributionNormalDTO

- Defined in structures/distribution.ts:413
Removes a key or array of keys from a Distribution and renormalizes.

Parameters
- model: DistributionDTO
  
  A Distribution data transfer object.
- keys: string | string[]
  
  Key or Keys to be removed.
Returns DistributionNormalDTO

Class

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

__namedParameters: DistributionConstructor

Returns Distribution

Properties

Private _engine

Private _normal

Private Optional _source

Accessors

normal

Returns WeightedDistribution

seed

Returns number | number[]

source

Returns undefined | WeightedDistribution

uses

Returns number

Methods

add

Parameters

key: string

value: number

Returns Distribution

addValues

Parameters

additions: WeightedDistribution

Returns Distribution

clone

Parameters

stripSource: boolean = false

Returns Distribution

pick

Parameters

count: number = 1

Optional mask: string[]

exclusive: boolean = false

Returns string[]

pickOne

Parameters

Optional mask: string[]

Returns undefined | string

remove

Parameters

keys: string | string[]

Returns Distribution

serialize

Parameters

stripSource: boolean = false

Returns DistributionDTO

Private update

Parameters

model: DistributionDTO

Returns Distribution

Static add

Parameters

model: DistributionDTO

key: string

value: number

Returns DistributionDTO

Static addNormalValue

Parameters

model: DistributionDTO

key: string

value: number

Returns DistributionDTO

Static addNormalValues

Parameters

model: DistributionDTO

additions: WeightedDistribution

Returns DistributionDTO

Static addSourceValue

Parameters