random

Documentation

Index

• Variables
• func ShuffleStringList(a []string)
• func String(sz int) string
• type LockedRand
  • func NewLockedRand() *LockedRand
  • func (r *LockedRand) Int() int
  • func (r *LockedRand) Uint64() uint64
• type Probability
  • func NewProbability(outOfMillion uint64) *Probability
  • func (p *Probability) Hit() bool
  • func (p *Probability) Missed() bool
• type Source

Variables

var LockGuardedRand = NewLockedRand()

LockGuardedRand is a global lock protected random source ready to be used.

Functions

func ShuffleStringList

func ShuffleStringList(a []string)

ShuffleStringList shuffles the specified string slice.

func String

func String(sz int) string

String returns a random string with the specified sz length.

Types

type LockedRand

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

LockedRand a mutex protected random source.

func NewLockedRand

func NewLockedRand() *LockedRand

NewLockedRand returns a new LockedRand instance.

func (*LockedRand) Int

func (r *LockedRand) Int() int

Int returns a new random int value.

func (*LockedRand) Uint64

func (r *LockedRand) Uint64() uint64

Uint64 returns a new random uint64 value.

type Probability

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

Probability is used to represent a random probability.

func NewProbability

func NewProbability(outOfMillion uint64) *Probability

NewProbability returns a new Probability instance, the probability is is expressed a outOfMillion / one million, e.g. NewProbability(1) means there is 1 out of 1 million chance.

func (*Probability) Hit

func (p *Probability) Hit() bool

Hit returns a boolean value indicating whether the random event is within the specified random range.

func (*Probability) Missed

func (p *Probability) Missed() bool

Missed returns a boolean value indicating whether the random event is not within the specified random range.

type Source

type Source interface {
	Uint64() uint64
	Int() int
}

Source is the interface for returning random Uint64 and Int values.