unum

package module

v1.0.1 Latest Latest Go to latest Published: May 30, 2025 License: GPL-3.0 Imports: 5 Imported by: 3

Details

This package provides number-related functions and some generic numeric types for Go.

(TOC) This package provides number-related functions and some generic numeric types.

This section is empty.

View Source

var Version string

func Clamp[N Number](minimum, value, maximum N) N

Clamp returns minimum if that's bigger than value; maximum if that's smaller than value; or value if it is in range [minimum, maximum]

func Commas[I Integer](i I) string

func IsClose(a, b float64) bool

IsClose returns true if a and b are very close to each other. Should be adequate for test comparisons. See also IsZero. tag::IsClose[]

func IsZero(x float64) bool

IsZero returns true if x is close to 0. Should be adequate for test comparisons. See also IsClose. tag::IsZero[]

func MustStrToInt(s string) int

func RoundToNearest(f float64, nearestTo int) float64

func StrToInt(s string, default_ int) int

type Comparable interface {
	~string | ~int | ~int8 | ~int16 | ~int32 | ~int64 |
		~uint | ~uint8 | ~uint16 | ~uint32 | ~uint64 | ~uintptr
}

Comparable allows only string or integer map keys or set elements.

type Integer interface {
	~int | ~int8 | ~int16 | ~int32 | ~int64 |
		~uint | ~uint8 | ~uint16 | ~uint32 | ~uint64 | ~uintptr
}

type Number interface {
	~float64 | ~float32 |
		~int | ~int8 | ~int16 | ~int32 | ~int64 |
		~uint | ~uint8 | ~uint16 | ~uint32 | ~uint64
}

type SignedNumber interface {
	~float64 | ~float32 | ~int | ~int8 | ~int16 | ~int32 | ~int64
}