Skip to content

Main content

Beta-Binomial Distribution Sampler Source Code

Browse the implementation files for Beta-Binomial Distribution Sampler.
tool.ts typescript
import { parseFiniteNumber } from '../../parse/number/tool';
import { parseInteger } from '../../parse/integer/tool';
import { createSeededRandom } from '../../random/seeded-number/tool';
import { randomGamma } from '../gamma-sampler/tool';

export const sampleBetaBinomial = (
	trialsInput: unknown,
	alphaInput: unknown,
	betaInput: unknown,
	countInput: unknown,
	seedInput: unknown
): string => {
	const trials = parseInteger(trialsInput);
	const alpha = parseFiniteNumber(alphaInput);
	const beta = parseFiniteNumber(betaInput);
	const count = parseInteger(countInput);
	if (
		trials === null ||
		trials < 0 ||
		trials > 1_000_000 ||
		count === null ||
		count < 1 ||
		count > 10_000 ||
		trials * count > 10_000_000 ||
		alpha === null ||
		alpha <= 0 ||
		alpha > 1_000_000 ||
		beta === null ||
		beta <= 0 ||
		beta > 1_000_000 ||
		typeof seedInput !== 'string' ||
		!seedInput.trim()
	)
		return '';

	const random = createSeededRandom(seedInput);
	const samples: number[] = [];
	for (let index = 0; index < count; index += 1) {
		const first = randomGamma(alpha, random);
		const second = randomGamma(beta, random);
		if (first === null || second === null) return '';
		if (!(first >= 0) || !(second >= 0) || first + second === 0)
			return '';
		const probability =
			first > second
				? 1 / (1 + second / first)
				: first / second / (1 + first / second);
		if (!Number.isFinite(probability)) return '';
		let successes = 0;
		for (let trial = 0; trial < trials; trial += 1) {
			if (random() < probability) successes += 1;
		}
		samples.push(successes);
	}
	return JSON.stringify(
		{ alpha, beta, count, samples, seed: seedInput, trials },
		null,
		2
	);
};

export const Tool: TypeTool = {
	name: 'Beta-Binomial Distribution Sampler',
	slug: 'probability/beta-binomial-sampler',
	intro:
		'Generate reproducible beta-binomial samples by drawing a probability from a beta distribution for each experiment.',
	tool: sampleBetaBinomial,
	i: [
		{
			example: '10',
			label: 'Trials',
			placeholder: 'Trials per sample',
			type: 'number'
		},
		{
			example: '2',
			label: 'Alpha',
			placeholder: 'Positive beta shape α',
			type: 'number'
		},
		{
			example: '5',
			label: 'Beta',
			placeholder: 'Positive beta shape β',
			type: 'number'
		},
		{
			example: '20',
			label: 'Sample Count',
			placeholder: 'Number of samples',
			type: 'number'
		},
		{
			example: 'tool.io',
			label: 'Seed',
			placeholder: 'Reproducible seed',
			type: 'text'
		}
	],
	o: [
		{
			example: '{ "samples": [2, 4] }',
			label: 'Samples',
			placeholder: 'Samples will appear here...',
			render: 'textarea',
			type: 'text'
		}
	],
	rerunnable: true,
	cite: [
		{
			title: 'Beta-binomial distribution - Wikipedia',
			url: 'https://en.wikipedia.org/wiki/Beta-binomial_distribution'
		}
	]
};

export default Tool;

Description

Browse the implementation files for Beta-Binomial Distribution Sampler.

References

  1. Tool.io on GitHub
  2. Tool.io TypeScript tools library

Similar or alternative tools