randx

README

randx

Package randx contains random-related utilities. It means to be a complement to the standard math/rand package.

Documentation

Overview

Package randx contains random-related utilities. It means to be a complement to the standard math/rand package.

Index

• func RandomIntWeight(weights ...int) int
• func RandomWeight(weights ...float64) int

Functions

func RandomIntWeight

func RandomIntWeight(weights ...int) int

RandomIntWeight chooses an index randomly using the listed non-negative relative weights.

The default Rand of math/rand package is used for random data.

Implementation guarantees to return an integer in the range of [0..len(weights)). If no weight is provided or they add up to 0, -1 is returned. Behavior for negative weights is undefined.

func RandomWeight

func RandomWeight(weights ...float64) int

RandomWeight chooses an index randomly using the listed (non-negative) probabilities as weights. Weights must add up to 1.

The default Rand of math/rand package is used for random data.

Implementation guarantees to return an integer in the range of [0..len(weights)). If weights don't add up to 1, -1 may be returned.