# @apocentre/alias-sampling

> Library for sampling of random values from a discrete probability distribution, using the Walker-Vose alias method.

Latest version **0.5.3** (published 2021-02-15) · GPL license · 0 weekly downloads

## Install

```sh
npm install @apocentre/alias-sampling
pnpm add @apocentre/alias-sampling
yarn add @apocentre/alias-sampling
bun add @apocentre/alias-sampling
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.5.3 |
| Published | 2021-02-15 |
| First published | 2021-02-15 |
| Weekly downloads | 0 |
| License | GPL |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 23.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Antonis Poulakis |
| Maintainers | antwnic4, nikosfotiadis, ppoliani |
| Keywords | sampling, distribution, discrete, alias method, Vose |

## Links

- npm: https://www.npmjs.com/package/@apocentre/alias-sampling
- Repository: https://github.com/apocentre/sampling
- Homepage: https://github.com/apocentre/sampling#readme
- Issues: https://github.com/apocentre/sampling/issues
- npm.io page: https://npm.io/package/@apocentre/alias-sampling

## Recent versions

- 0.5.3 (latest) — 2021-02-15
- 0.5.2 — 2021-02-15

## README

# Alias Method for Sampling

Library for sampling of random values from a discrete probability distribution, using the Walker-Vose alias method.

## Installation

```shell script
yarn add @apocentre/aliasing
```

## Usage

```javascript
var s = sample([0.5, 0.25, 0.25], ['A', 'B', 'C']);
s.next(); // => random outcome according to specified probabilities
```

```javascript
var s = sample([0.5, 0.25, 0.25], [10, 20, 30]);
s.next(1000); // => 1000 random samples according to specified probabilities
```

```javascript
var s = sample([0.5, 0.25, 0.25]);
s.next(); // => random index according to specified probabilities
```

```javascript
var rand = Math.rand; // custom random generator function
var s = sample([0.5, 0.25, 0.25], null, rand);
s.next(); // => random index according to specified probabilities
```

* * * *

Have fun!

[![Build Status](https://travis-ci.org/mfornos/sampling.svg)](https://travis-ci.org/mfornos/sampling)

---
_Source: https://npm.io/package/@apocentre/alias-sampling · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._