wrand

Documentation

Index

• func ShuffleWithWeights(weights []int) ([]int, error)
• type Choice
  • func NewChoice(key any, item any, weight uint) Choice
• type Chooser
  • func NewChooser(choices ...Choice) (*Chooser, error)
  • func NewChooserWithWeights(items []int, weights []int) (*Chooser, error)
  • func (c Chooser) Pick() (key any, item interface{})

Functions

func ShuffleWithWeights

func ShuffleWithWeights(weights []int) ([]int, error)

Types

type Choice

type Choice struct {
	Key    any
	Item   any
	Weight uint
}

Choice is a generic wrapper that can be used to add weights for any item.

func NewChoice

func NewChoice(key any, item any, weight uint) Choice

NewChoice creates a new Choice with specified item and weight.

type Chooser

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

A Chooser caches many possible Choices in a structure designed to improve performance on repeated calls for weighted random selection.

func NewChooser

func NewChooser(choices ...Choice) (*Chooser, error)

NewChooser initializes a new Chooser for picking from the provided choices.

func NewChooserWithWeights

func NewChooserWithWeights(items []int, weights []int) (*Chooser, error)

func (Chooser) Pick

func (c Chooser) Pick() (key any, item interface{})

Pick returns a single weighted random Choice.Item from the Chooser.

Utilizes global rand as the source of randomness.