cmp

Documentation

Index

• func Max[T cmp.Ordered](t ...T) T
• func MaxBy[T any](fn func(x, y T) Ordering, t ...T) T
• func Min[T cmp.Ordered](t ...T) T
• func MinBy[T any](fn func(x, y T) Ordering, t ...T) T
• type Ordering
  • func Cmp[T cmp.Ordered](x, y T) Ordering
  • func (o Ordering) IsEq() bool
  • func (o Ordering) IsGt() bool
  • func (o Ordering) IsLt() bool
  • func (o Ordering) Reverse() Ordering
  • func (o Ordering) String() string
  • func (o Ordering) Then(other Ordering) Ordering

Functions

func Max

func Max[T cmp.Ordered](t ...T) T

Max returns the maximum value among the given values. The values must be of a type that implements the cmp.Ordered interface for comparison.

func MaxBy

func MaxBy[T any](fn func(x, y T) Ordering, t ...T) T

MaxBy finds the maximum value in the collection t according to the provided comparison function fn. It returns the maximum value found.

func Min

func Min[T cmp.Ordered](t ...T) T

Min returns the minimum value among the given values. The values must be of a type that implements the cmp.Ordered interface for comparison.

func MinBy

func MinBy[T any](fn func(x, y T) Ordering, t ...T) T

MinBy finds the minimum value in the collection t according to the provided comparison function fn. It returns the minimum value found.

Types

type Ordering

type Ordering int

Ordering is the result of a comparison between two values.

const (
	Less    Ordering = iota - 1 // Less represents an ordered value where a compared value is less than another.
	Equal                       // Equal represents an ordered value where a compared value is equal to another.
	Greater                     // Greater represents an ordered value where a compared value is greater than another.
)

func Cmp

func Cmp[T cmp.Ordered](x, y T) Ordering

Cmp compares two ordered values and returns the result as an Ordering value.

func (Ordering) IsEq

func (o Ordering) IsEq() bool

IsEq returns true if the Ordering value is Equal.

func (Ordering) IsGt

func (o Ordering) IsGt() bool

IsGt returns true if the Ordering value is Greater.

func (Ordering) IsLt

func (o Ordering) IsLt() bool

IsLt returns true if the Ordering value is Less.

func (Ordering) Reverse

func (o Ordering) Reverse() Ordering

Reverse reverses the ordering.

func (Ordering) String

func (o Ordering) String() string

String returns the string representation of the Ordering value.

func (Ordering) Then

func (o Ordering) Then(other Ordering) Ordering

Then returns the receiver if it's equal to Equal, otherwise returns the receiver.