intrange

Documentation

Overview

Package intrange provides distributions that return ints.

Index

• type Infinite
  • func (inf Infinite) EnforceRange(i int) int
  • func (inf Infinite) Mult(i float64) Range
  • func (inf Infinite) Percentile(float64) int
  • func (inf Infinite) Poll() int
• type Range
  • func NewConstant(i int) Range
  • func NewInfinite() Range
  • func NewLinear(min, max int) Range
  • func NewSpread(base, spread int) Range

Types

type Infinite

type Infinite struct{}

Infinite is a immutable range which always polls math.MaxInt32

func (Infinite) EnforceRange

func (inf Infinite) EnforceRange(i int) int

EnforceRange for an Infinite returns Infinite

func (Infinite) Mult

func (inf Infinite) Mult(i float64) Range

Mult does nothing to Infinites.

func (Infinite) Percentile

func (inf Infinite) Percentile(float64) int

Percentile can only return math.MaxInt32

func (Infinite) Poll

func (inf Infinite) Poll() int

Poll returns math.MaxInt32 on Infinites.

type Range

type Range interface {
	Poll() int
	Mult(float64) Range
	EnforceRange(int) int
	Percentile(float64) int
}

Range represents a range of integer numbers

func NewConstant

func NewConstant(i int) Range

NewConstant returns a range which will always return the input constant

func NewInfinite

func NewInfinite() Range

NewInfinite returns a range which will always return math.MaxInt32 and is unchangeable.

func NewLinear

func NewLinear(min, max int) Range

NewLinear returns a linear range between min and max

func NewSpread

func NewSpread(base, spread int) Range

NewSpread returns a linear range from base - s to base + s