squiggle/packages/website/docs/Api/DistSampleSet.md
2022-07-22 11:50:56 -07:00

1.4 KiB

sidebar_position title
5 Sample Set Distribution

Sample set distributions are one of the three distribution formats. Internally, they are stored as a list of numbers. It's useful to distinguish point set distributions from arbitrary lists of numbers to make it clear which functions are applicable.

Monte Carlo calculations typically result in sample set distributions.

All regular distribution function work on sample set distributions. In addition, there are several functions that only work on sample set distributions.

fromDist

SampleSet.fromDist: (list<number>) => sampleSet

fromList

SampleSet.fromList: (list<number>) => sampleSet

fromFn

SampleSet.fromFn: ((float) => number) => sampleSet

toList

SampleSet.toList: (sampleSet) => list<number>

Gets the internal samples of a sampleSet distribution. This is separate from the sampleN() function, which would shuffle the samples. toList() maintains order and length.

Examples

toList(SampleSet.fromDist(normal(5,2)))

map

SampleSet.map: (sampleSet, (number => number)) => sampleSet

map2

SampleSet.map2: (sampleSet, sampleSet, ((number, number) => number)) => sampleSet

map3

SampleSet.map3: (sampleSet, sampleSet, sampleSet, ((number, number, number) => number)) => sampleSet

mapN

SampleSet.mapN: (list<sampleSet>, (list<sampleSet> => number)) => sampleSet