math

Documentation

Index

• func BigFloatToBigInt(bf *big.Float) (*big.Int, error)
• func FromOrdinal(s string) (int, error)
• func Ordinal[T constraints.Integer](n T) string
• func Roundup(f float64) float64

Functions

func BigFloatToBigInt

func BigFloatToBigInt(bf *big.Float) (*big.Int, error)

BigFloatToBigInt converts big.Float values to big.Int values. This function is required because big.NewInt() simply casts to uint64, and is thus bounded by that type's maximum size, i.e. math.MaxUint64 or 18446744073709551615. To get around this, we use the Int() method on big.Float to directly store large values into a big.Int.

func FromOrdinal

func FromOrdinal(s string) (int, error)

FromOrdinal will return the integral form of the caller- supplied ordinal string, e.g., FromOrdinal("11th") will return 11, with err set in case a parse error occurs.

func Ordinal

func Ordinal[T constraints.Integer](n T) string

Ordinal converts the generic integer type to a string ordinal, e.g., Ordinal(3) returns "3rd". Although any integeral type is accepted, internally it is treated as an int because the mod operator cannot be used with generically constrained types. Thus, whatever is passed in is converted to an int. Moreover, the absolute valus is taken, so Ordinal(-1) will return "1st".

func Roundup

func Roundup(f float64) float64

Roundup returns the smallest number, specified to 1 decimal place, that is equal to or higher than its input. Roundup(4.02) returns 4.1, while Roundup(4.00) returns 4.0.