README
¶
cmpx
import "github.com/ccheers/xpkg/generic/cmpx"
Index
- func Clamp[T constraints.Ordered](x, lo, hi T) T
- func Compare[T comparable](a, b T, less LessFn[T]) int
- func Equals[T comparable](a, b T) bool
- func Less[T constraints.Ordered](a, b T) bool
- func Max[T constraints.Ordered](a, b T) T
- func MaxFunc[T comparable](a, b T, less LessFn[T]) T
- func Min[T constraints.Ordered](a, b T) T
- func MinFunc[T comparable](a, b T, less LessFn[T]) T
- type EqualsFn
- type HashFn
- type LessFn
func Clamp
func Clamp[T constraints.Ordered](x, lo, hi T) T
Clamp returns x constrained within [lo:hi] range. If x compares less than lo, returns lo; otherwise if hi compares less than x, returns hi; otherwise returns v.
func Compare
func Compare[T comparable](a, b T, less LessFn[T]) int
Compare uses a less function to determine the ordering of 'a' and 'b'. It returns:
* -1 if a < b
* 1 if a > b
* 0 if a == b
func Equals
func Equals[T comparable](a, b T) bool
Equals wraps the '==' operator for comparable types.
func Less
func Less[T constraints.Ordered](a, b T) bool
Less wraps the '<' operator for ordered types.
func Max
func Max[T constraints.Ordered](a, b T) T
Max returns the max of a and b.
func MaxFunc
func MaxFunc[T comparable](a, b T, less LessFn[T]) T
MaxFunc returns the max of a and b using the less func.
func Min
func Min[T constraints.Ordered](a, b T) T
Min returns the min of a and b.
func MinFunc
func MinFunc[T comparable](a, b T, less LessFn[T]) T
MinFunc returns the min of a and b using the less func.
type EqualsFn
EqualsFn is a function that returns whether 'a' and 'b' are equal.
type EqualsFn[T comparable] func(a, b T) bool
type HashFn
HashFn is a function that returns the hash of 't'.
type HashFn[T comparable] func(t T) uint64
type LessFn
LessFn is a function that returns whether 'a' is less than 'b'.
type LessFn[T comparable] func(a, b T) bool
Generated by gomarkdoc
Documentation
¶
Index ¶
- func Clamp[T constraints.Ordered](x, lo, hi T) T
- func Compare[T comparable](a, b T, less LessFn[T]) int
- func Equals[T comparable](a, b T) bool
- func Less[T constraints.Ordered](a, b T) bool
- func Max[T constraints.Ordered](a, b T) T
- func MaxFunc[T comparable](a, b T, less LessFn[T]) T
- func Min[T constraints.Ordered](a, b T) T
- func MinFunc[T comparable](a, b T, less LessFn[T]) T
- type EqualsFn
- type HashFn
- type LessFn
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Clamp ¶
func Clamp[T constraints.Ordered](x, lo, hi T) T
Clamp returns x constrained within [lo:hi] range. If x compares less than lo, returns lo; otherwise if hi compares less than x, returns hi; otherwise returns v.
func Compare ¶
func Compare[T comparable](a, b T, less LessFn[T]) int
Compare uses a less function to determine the ordering of 'a' and 'b'. It returns:
* -1 if a < b
* 1 if a > b
* 0 if a == b
func Equals ¶
func Equals[T comparable](a, b T) bool
Equals wraps the '==' operator for comparable types.
func Less ¶
func Less[T constraints.Ordered](a, b T) bool
Less wraps the '<' operator for ordered types.
func MaxFunc ¶
func MaxFunc[T comparable](a, b T, less LessFn[T]) T
MaxFunc returns the max of a and b using the less func.
func MinFunc ¶
func MinFunc[T comparable](a, b T, less LessFn[T]) T
MinFunc returns the min of a and b using the less func.
Types ¶
type EqualsFn ¶
type EqualsFn[T comparable] func(a, b T) bool
EqualsFn is a function that returns whether 'a' and 'b' are equal.
type HashFn ¶
type HashFn[T comparable] func(t T) uint64
HashFn is a function that returns the hash of 't'.
type LessFn ¶
type LessFn[T comparable] func(a, b T) bool
LessFn is a function that returns whether 'a' is less than 'b'.
Source Files