xmath

Documentation

Overview

Package xmath contains extensions to the standard library package math.

Index

• func Abs[T ~int | ~int8 | ~int16 | ~int32 | ~int64](x T) T
• func Clamp[T cmp.Ordered](x, min, max T) T
• func Max[T cmp.Ordered](a, b T) T
• func Min[T cmp.Ordered](a, b T) T

Functions

func Abs

func Abs[T ~int | ~int8 | ~int16 | ~int32 | ~int64](x T) T

Abs returns the absolute value of x. It panics if this value is not representable, for example because -math.MinInt32 requires more than 32 bits to represent and so does not fit in an int32.

func Clamp

func Clamp[T cmp.Ordered](x, min, max T) T

Clamp clamps the value of x to within min and max.

func Max

func Max[T cmp.Ordered](a, b T) T

Max returns the maximum of a and b based on the > operator.

Deprecated: max is a builtin as of Go 1.21.

func Min

func Min[T cmp.Ordered](a, b T) T

Min returns the minimum of a and b based on the < operator.

Deprecated: min is a builtin as of Go 1.21.