math

Documentation

Index

• func Clamp[T constraints.Ordered](v, lo, hi T) T
• func Dim[T constraints_.Number](x, y T) T
• func Max[T constraints.Ordered](s ...T) T
• func Min[T constraints.Ordered](s ...T) T
• func RingRem[T constraints.Integer](x, y T) T

Functions

func Clamp

func Clamp[T constraints.Ordered](v, lo, hi T) T

Clamp returns the value between boundary [lo,hi], as v < lo ? v : hi > v : hi : v. Reference to lo if v is less than lo, reference to hi if hi is less than v, otherwise reference to v. If v compares equivalent to either bound, returns a reference to v, not the bound.

func Dim

func Dim[T constraints_.Number](x, y T) T

Dim returns the maximum of x-y or 0.

func Max

func Max[T constraints.Ordered](s ...T) T

Max returns the largest of s.

func Min

func Min[T constraints.Ordered](s ...T) T

Min returns the smallest of s.

func RingRem

func RingRem[T constraints.Integer](x, y T) T

RingRem returns the remainder of x looped by +ny until in y > 0 ? [0, y) : (y, 0]. RingRem panics for y == 0 (division by zero). y > 0, then ∈ [0, y) y < 0, then ∈ (y, 0]