alias

README

This package implements the alias method of random number generation for an arbitrary discrete distribution.

You can install it with:

go get github.com/encryptio/alias

Documentation

Overview

The alias package picks items from a discrete distribution efficiently using the alias method.

Index

• type Alias
  • func New(prob []float64) (*Alias, error)
  • func (al *Alias) Gen(rng *rand.Rand) uint32
  • func (al *Alias) MarshalBinary() ([]byte, error)
  • func (al *Alias) UnmarshalBinary(p []byte) error

Types

type Alias

type Alias struct {
	// contains filtered or unexported fields
}

func New

func New(prob []float64) (*Alias, error)

Create a new alias object. For example,

var v = alias.New([]float64{8,10,2})

creates an alias that returns 0 40% of the time, 1 50% of the time, and 2 10% of the time.

func (*Alias) Gen

func (al *Alias) Gen(rng *rand.Rand) uint32

Generates a random number according to the distribution using the rng passed.

func (*Alias) MarshalBinary

func (al *Alias) MarshalBinary() ([]byte, error)

MarshalBinary implements encoding.BinaryMarshaller.

func (*Alias) UnmarshalBinary

func (al *Alias) UnmarshalBinary(p []byte) error

UnmarshalBinary implements encoding.BinaryUnmarshaller.