compare

Documentation

Overview

Package compare contains support functions for comparison of values.

Comparison Functions

For the purposes of this package, a comparison function takes two values A and B of a type and reports their relative order, returning:

-1 if A precedes B,
 0 if A and B are equivalent,
+1 if A follows B

Comparison functions are expected to implement a strict weak ordering. Unless otherwise noted, any negative value is accepted in place of -1, and any positive value in place of 1.

Less Functions

For the purposes of this package, a less function takes two values A and B of a type and reports whether A precedes B in relative order.

Index

• func Bool(a, b bool) int
• func FromLessFunc[T any](less func(a, b T) bool) func(a, b T) int
• func Reversed[T any](c func(a, b T) int) func(a, b T) int
• func Time(a, b time.Time) int
• func ToLessFunc[T any](cmp func(a, b T) int) func(a, b T) bool

Functions

func Bool

func Bool(a, b bool) int

Bool is a comparison function for bool values that orders false before true.

func FromLessFunc

func FromLessFunc[T any](less func(a, b T) bool) func(a, b T) int

FromLessFunc converts a less function, which reports whether its first argument precedes its second in an ordering relation, into a comparison function on that same relation.

func Reversed

func Reversed[T any](c func(a, b T) int) func(a, b T) int

Reversed returns a comparison function that orders its elements in the reverse of the ordering expressed by c.

func Time

func Time(a, b time.Time) int

Time is a comparison function for time.Time values that orders earlier times before later ones.

func ToLessFunc

func ToLessFunc[T any](cmp func(a, b T) int) func(a, b T) bool

ToLessFunc converts a comparison function into a less function on the same relation.