Documentation
¶
Overview ¶
Package random contains various methods for creating random values.
Package random contains various methods for creating random values.
Index ¶
- func Angle() float64
- func Around(val, amt float64) float64
- func Bit() int
- func Boolean() bool
- func Byte() byte
- func Choice[T any](list ...T) T
- func Complex() complex128
- func ComplexRange(realMin, realMax, imagMin, imagMax float64) complex128
- func Element[T any](list []T) T
- func Float() float64
- func FloatArray(size int, minVal, maxVal float64) []float64
- func FloatMax(maxVal float64) float64
- func FloatRange(minVal float64, maxVal float64) float64
- func Halton(base, index int) float64
- func HaltonSequence(base, start, count int) []float64
- func Int() int
- func IntArray(size int, minVal, maxVal int) []int
- func IntMax(maxVal int) int
- func IntRange(minVal int, maxVal int) int
- func Norm(mean, std float64) float64
- func NormRange(minVal, maxVal, std float64) float64
- func Power(minVal, maxVal, power float64) float64
- func RandSeed()
- func Seed(seed uint64)
- func Sign() float64
- func String(length int) string
- func StringAlpha(length int) string
- func StringFrom(length int, chars string) string
- func StringLower(length int) string
- func StringUpper(length int) string
- func WeightedBool(weight float64) bool
- func WeightedElement[T any](list []T, weights []float64) T
- func WeightedIndex(weights []float64) int
- type Random
- func (r *Random) Angle() float64
- func (r *Random) Boolean() bool
- func (r Random) Complex() complex128
- func (r Random) ComplexRange(realMin, realMax, imagMin, imagMax float64) complex128
- func (r *Random) Float() float64
- func (r *Random) FloatArray(size int, minVal, maxVal float64) []float64
- func (r *Random) FloatMax(maxVal float64) float64
- func (r *Random) FloatRange(minVal float64, maxVal float64) float64
- func (r *Random) Int() int
- func (r *Random) IntArray(size int, minVal, maxVal int) []int
- func (r *Random) IntMax(maxVal int) int
- func (r *Random) IntRange(minVal int, maxVal int) int
- func (r *Random) Norm(mean, std float64) float64
- func (r *Random) NormRange(minVal, maxVal, std float64) float64
- func (r *Random) Power(minVal, maxVal, power float64) float64
- func (r *Random) RandSeed()
- func (r *Random) Seed(seed uint64)
- func (r *Random) Sign() float64
- func (r *Random) String(length int) string
- func (r *Random) StringAlpha(length int) string
- func (r *Random) StringFrom(length int, chars string) string
- func (r *Random) StringLower(length int) string
- func (r *Random) StringUpper(length int) string
- func (r *Random) WeightedBool(weight float64) bool
- func (r Random) WeightedIndex(weights []float64) int
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Around ¶
Around returns a random float around a given number. val is the center. amt is how much on either side the result will vary.
func Choice ¶ added in v0.9.0
func Choice[T any](list ...T) T
Choice returns a random choice from the parameters passed in.
func Complex ¶ added in v1.0.1
func Complex() complex128
Complex returns a random complex number from -1 + -1i to 1 + 1i
func ComplexRange ¶ added in v1.0.1
func ComplexRange(realMin, realMax, imagMin, imagMax float64) complex128
ComplexRange returns a random complex number in the given ranges.
func Element ¶
func Element[T any](list []T) T
Element returns a random element from the list. Can't make this an instance method because generic methods cannot contain typed params and the receiver is actually a type param.
func FloatArray ¶
FloatArray returns an array of a given size filled with random floats from minVal to maxVal.
func FloatRange ¶
FloatRange returns a random float from minVal to maxVal.
func HaltonSequence ¶ added in v0.7.2
HaltonSequence returns a slice of floats from the Halton sequence, starting at start.
func IntArray ¶
IntArray returns an array of a given size filled with random int from minVal to maxVal.
func Norm ¶
Norm returns a random number within a normal distribution with the given mean and standard deviation.
func NormRange ¶ added in v1.0.1
NormRange returns a random number within a normal distribution (mostly) within a minVal/maxVal range. std is the standard deviation. Something around 0.2 will put almost all the value within the range. Higher values will spread it out more so that a larger percentage of values will be out of the range.
func StringAlpha ¶
StringAlpha returns a random string of letters.
func StringFrom ¶ added in v1.0.1
StringFrom returns a random string of characters from the source string.
func StringLower ¶
StringLower returns a random lower case string.
func StringUpper ¶
StringUpper returns a random upper case string.
func WeightedElement ¶ added in v0.9.0
WeightedElement returns a random element from the list, weighted per the weights param.
func WeightedIndex ¶ added in v1.0.1
WeightedIndex returns a random int based on an array of weights.
Types ¶
type Random ¶
type Random struct {
// contains filtered or unexported fields
}
Random represents a single unique PRNG
func (Random) Complex ¶
func (r Random) Complex() complex128
Complex returns a random complex number from -1 + -1i to 1 + 1i
func (Random) ComplexRange ¶
func (r Random) ComplexRange(realMin, realMax, imagMin, imagMax float64) complex128
ComplexRange returns a random complex number in the given ranges.
func (*Random) FloatArray ¶
FloatArray returns an array of a given size filled with random floats from minVal to maxVal.
func (*Random) FloatRange ¶
FloatRange returns a random float from minVal to maxVal.
func (*Random) IntArray ¶
IntArray returns an array of a given size filled with random int from minVal to maxVal.
func (*Random) Norm ¶
Norm returns a random number within a normal distribution with the given mean and standard deviation.
func (*Random) NormRange ¶ added in v1.0.1
NormRange returns a random number within a normal distribution (mostly) within a minVal/maxVal range. std is the standard deviation. Something around 0.2 will put almost all the value within the range. Higher values will spread it out more so that a larger percentage of values will be out of the range.
func (*Random) Power ¶
Power returns a random number between minVal and maxVal. The higher the power, the more the result will be skewed towards minVal.
func (*Random) StringAlpha ¶
StringAlpha returns a random string of letters.
func (*Random) StringFrom ¶
StringFrom returns a random string of characters from the source string.
func (*Random) StringLower ¶
StringLower returns a random lower case string.
func (*Random) StringUpper ¶
StringUpper returns a random upper case string.
func (*Random) WeightedBool ¶
WeightedBool returns a weighted boolean.
func (Random) WeightedIndex ¶
WeightedIndex returns a random int based on an array of weights.
Source Files