slices

Documentation

Overview

Package slices defines various functions useful with slices of any type. Unless otherwise specified, these functions all apply to the elements of a slice at index 0 <= i < len(s).

Index

• func Clip[S constraints.Slice[T], T any](s S) S
• func Clone[S constraints.Slice[T], T any](s S) S
• func Compact[S constraints.Slice[T], T comparable](s S) S
• func CompactFunc[S constraints.Slice[T], T any](s S, cmp func(T, T) bool) S
• func Compare[T constraints.Ordered](s1, s2 []T) int
• func CompareFunc[T any](s1, s2 []T, cmp func(T, T) int) int
• func Contains[T comparable](s []T, v T) bool
• func Delete[S constraints.Slice[T], T any](s S, i, j int) S
• func Equal[T comparable](s1, s2 []T) bool
• func EqualFunc[T1, T2 any](s1 []T1, s2 []T2, eq func(T1, T2) bool) bool
• func Grow[S constraints.Slice[T], T any](s S, n int) S
• func Index[T comparable](s []T, v T) int
• func IndexFunc[T any](s []T, f func(T) bool) int
• func Insert[S constraints.Slice[T], T any](s S, i int, v ...T) S

Functions

func Clip

func Clip[S constraints.Slice[T], T any](s S) S

Clip removes unused capacity from the slice, returning s[:len(s):len(s)].

func Clone

func Clone[S constraints.Slice[T], T any](s S) S

Clone returns a copy of the slice. The elements are copied using assignment, so this is a shallow clone.

func Compact

func Compact[S constraints.Slice[T], T comparable](s S) S

Compact replaces consecutive runs of equal elements with a single copy. This is like the uniq command found on Unix. Compact modifies the contents of the slice s; it does not create a new slice.

func CompactFunc

func CompactFunc[S constraints.Slice[T], T any](s S, cmp func(T, T) bool) S

CompactFunc is like Compact, but uses a comparison function.

func Compare

func Compare[T constraints.Ordered](s1, s2 []T) int

Compare compares the elements of s1 and s2. The elements are compared sequentially starting at index 0, until one element is not equal to the other. The result of comparing the first non-matching elements is the result of the comparison. If both slices are equal until one of them ends, the shorter slice is considered less than the longer one The result will be 0 if s1==s2, -1 if s1 < s2, and +1 if s1 > s2.

func CompareFunc

func CompareFunc[T any](s1, s2 []T, cmp func(T, T) int) int

CompareFunc is like Compare, but uses a comparison function on each pair of elements. The elements are compared in index order, and the comparisons stop after the first time cmp returns non-zero. The result will be the first non-zero result of cmp; if cmp always returns 0 the result is 0 if len(s1) == len(s2), -1 if len(s1) < len(s2), and +1 if len(s1) > len(s2).

func Contains

func Contains[T comparable](s []T, v T) bool

Contains reports whether v is present in s.

func Delete

func Delete[S constraints.Slice[T], T any](s S, i, j int) S

Delete removes the elements s[i:j] from s, returning the modified slice. Delete panics if s[i:j] is not a valid slice of s. Delete modifies the contents of the slice s; it does not create a new slice. Delete is O(len(s)-(j-i)), so if many items must be deleted, it is better to make a single call deleting them all together than to delete one at a time.

func Equal

func Equal[T comparable](s1, s2 []T) bool

Equal reports whether two slices are equal: the same length and all elements equal. If the lengths are different, Equal returns false. Otherwise, the elements are compared in index order, and the comparison stops at the first unequal pair. Floating point NaNs are not considered equal.

func EqualFunc

func EqualFunc[T1, T2 any](s1 []T1, s2 []T2, eq func(T1, T2) bool) bool

EqualFunc reports whether two slices are equal using a comparison function on each pair of elements. If the lengths are different, EqualFunc returns false. Otherwise, the elements are compared in index order, and the comparison stops at the first index for which eq returns false.

func Grow

func Grow[S constraints.Slice[T], T any](s S, n int) S

Grow grows the slice's capacity, if necessary, to guarantee space for another n elements. After Grow(n), at least n elements can be appended to the slice without another allocation. If n is negative or too large to allocate the memory, Grow will panic.

func Index

func Index[T comparable](s []T, v T) int

Index returns the index of the first occurrence of v in s, or -1 if not present.

func IndexFunc

func IndexFunc[T any](s []T, f func(T) bool) int

IndexFunc returns the index into s of the first element satisfying f(c), or -1 if none do.

func Insert

func Insert[S constraints.Slice[T], T any](s S, i int, v ...T) S

Insert inserts the values v... into s at index i, returning the modified slice. In the returned slice r, r[i] == the first v. Insert panics if i is out of range. This function is O(len(s) + len(v)).