slices

Documentation

Overview

Package slices implements generic (type-parameterized) utilities for working with simple Go slices.

Index

• func Contains[T comparable](needle T, haystack []T) bool
• func Max[T constraints.Ordered](a T, rest ...T) T
• func Min[T constraints.Ordered](a T, rest ...T) T
• func RemoveAll[T comparable](haystack []T, needle T) []T
• func RemoveAllFunc[T any](haystack []T, f func(T) bool) []T
• func Reverse[T any](slice []T)
• func Search[T any](slice []T, fn func(T) int) (int, bool)
• func SearchHighest[T any](slice []T, fn func(T) int) (int, bool)
• func SearchLowest[T any](slice []T, fn func(T) int) (int, bool)
• func Sort[T constraints.Ordered](slice []T)

Functions

func Contains

func Contains[T comparable](needle T, haystack []T) bool

func Max

func Max[T constraints.Ordered](a T, rest ...T) T

func Min

func Min[T constraints.Ordered](a T, rest ...T) T

func RemoveAll

func RemoveAll[T comparable](haystack []T, needle T) []T

func RemoveAllFunc

func RemoveAllFunc[T any](haystack []T, f func(T) bool) []T

func Reverse

func Reverse[T any](slice []T)

func Search

func Search[T any](slice []T, fn func(T) int) (int, bool)

Search searches the slice for a value for which `fn(slice[i]) = 0`.

: + + + 0 0 0 - - -
:       ^ ^ ^
:       any of

You can conceptualize `fn` as subtraction:

func(straw T) int {
    return needle - straw
}

func SearchHighest

func SearchHighest[T any](slice []T, fn func(T) int) (int, bool)

SearchHighest searches the slice for the right-most value for which `fn(slice[i]) = 0`.

: + + + 0 0 0 - - -
:           ^

You can conceptualize `fn` as subtraction:

func(straw T) int {
    return needle - straw
}

func SearchLowest

func SearchLowest[T any](slice []T, fn func(T) int) (int, bool)

SearchLowest searches the slice for the left-most value for which `fn(slice[i]) = 0`.

: + + + 0 0 0 - - -
:       ^

You can conceptualize `fn` as subtraction:

func(straw T) int {
    return needle - straw
}

func Sort

func Sort[T constraints.Ordered](slice []T)