README
¶
stdx/maths
Import path: github.com/InsideGallery/core/stdx/maths
Overview
stdx/maths provides Cantor pairing, rounding, clamping, weighted random selection, and 128-bit integer split
helpers.
Main APIs
CantorPairandCantorUnpairmap twouint64values to and from oneuint64value.RoundWithPrecision,Round,Clamp, andApproximatelyEqualprovide small float helpers.IntStringToBigInt,BigIntToHighAndLow, andHighAndLowToBigIntconvert decimal strings and high/lowuint64pairs.WeightIndexselects a key from amap[interface{}]uint64using the weights as probabilities.RandomDigitStringreturns a random string of the requested length.DefaultPrecisionis used byRoundWithPrecisionwhen the provided precision is approximately zero.
Usage
pair := maths.CantorPair(7, 11)
left, right := maths.CantorUnpair(pair)
clamped := maths.Clamp(120, 0, 100)
_ = left
_ = right
_ = clamped
Notes
WeightIndex returns nil for an empty map. Despite its name, RandomDigitString fills the string with random
byte values from math/rand, not only ASCII digits and not cryptographic randomness.
Documentation
¶
Overview ¶
Package maths provides maths and probability helpers.
Index ¶
- Constants
- func ApproximatelyEqual(a, b float64) bool
- func BigIntToHighAndLow(x *big.Int) (uint64, uint64)
- func CantorPair(k1, k2 uint64) uint64
- func CantorUnpair(pair uint64) (uint64, uint64)
- func Clamp(value, lowerLimit, upperLimit float64) float64
- func HighAndLowToBigInt(h, l uint64) *big.Int
- func IntStringToBigInt(str string) *big.Int
- func RandomDigitString(length int) (result string)
- func Round(v float64, p float64) float64
- func RoundWithPrecision(value float64, precision float64) float64
- func WeightIndex(prob map[interface{}]uint64) interface{}
Constants ¶
const (
DefaultPrecision float64 = 0.0001
)
mathematics constants
Variables ¶
This section is empty.
Functions ¶
func ApproximatelyEqual ¶
ApproximatelyEqual function to test if two real numbers are (almost) equal
func CantorPair ¶
CantorPair two uint64 numbers by cantor pairing function.
func CantorUnpair ¶
CantorUnpair one uint64 pair to two uint64 numbers by cantor pairing function.
func HighAndLowToBigInt ¶
func IntStringToBigInt ¶
func RandomDigitString ¶
RandomDigitString return random digit strings
func RoundWithPrecision ¶
RoundWithPrecision round precision
func WeightIndex ¶
func WeightIndex(prob map[interface{}]uint64) interface{}
WeightIndex get key by probability chances
Types ¶
This section is empty.
Source Files