g_lib

README

# Go 1.18 Library with Basic Generic Functions and Tests

1. Min, Max
2. MinArray, MaxArray
3. String keys for a Map
4. Sorting of Type
5. Search a slice for a value
6. Convert map[string]value to []SliceType with name/value

Documentation

Index

• func Abs[T SignedNumeric](a T) T
• func EqualSlice[T comparable](s, t []T) bool
• func GetMapKeys[K comparable, V any](m map[K]V) []K
• func IfTrue[T any](on bool, a T, b T) (rv T)
• func InArray[T comparable](needle T, haystack []T) bool
• func KeysForStringMap[T any](aMap map[string]T) (rv []string)
• func LocationInArray[T comparable](needle T, haystack []T) int
• func Max[T constraints.Ordered](a, b T) T
• func MaxArray[T constraints.Ordered](a []T) (rv T)
• func Min[T constraints.Ordered](a, b T) T
• func MinArray[T constraints.Ordered](a []T) (rv T)
• func Remove[T any](haystack []T, needle T) (result []T)
• func RemoveAt[T any](slice []T, pos int) []T
• func RemoveComparable[T comparable](slice []T, element T) (result []T)
• func SortSlice[T constraints.Ordered](s []T)
• func SortedKeysForStringMap[T any](aMap map[string]T) (rv []string)
• func ToBoolMap[T comparable](src []T) map[T]bool
• func Unique[T comparable](s []T) []T
• type Numeric
• type SignedInteger
• type SignedNumeric
• type Unsigned

Functions

func Abs

func Abs[T SignedNumeric](a T) T

func EqualSlice

func EqualSlice[T comparable](s, t []T) bool

func GetMapKeys

func GetMapKeys[K comparable, V any](m map[K]V) []K

func IfTrue

func IfTrue[T any](on bool, a T, b T) (rv T)

func InArray

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

InArray uses Dijkstra's "L" algorythm to search 'haystack' for 'needle'. "L" is the linear search algorythm. Exampel of Use:

func KeysForStringMap

func KeysForStringMap[T any](aMap map[string]T) (rv []string)

func LocationInArray

func LocationInArray[T comparable](needle T, haystack []T) int

func Max

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

func MaxArray

func MaxArray[T constraints.Ordered](a []T) (rv T)

func Min

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

func MinArray

func MinArray[T constraints.Ordered](a []T) (rv T)

func Remove

func Remove[T any](haystack []T, needle T) (result []T)

Remove will take 'needle' from 'haystack' if it matches based on reflect.DeepEqual

func RemoveAt

func RemoveAt[T any](slice []T, pos int) []T

RemoveAt removes from `slice` the item at postion `pos`. If pos is out of range it returns the original `slice`.

func RemoveComparable

func RemoveComparable[T comparable](slice []T, element T) (result []T)

func SortSlice

func SortSlice[T constraints.Ordered](s []T)

func SortedKeysForStringMap

func SortedKeysForStringMap[T any](aMap map[string]T) (rv []string)

SortedKeysForStringMap will Extract the keys from a map[string]interface{}, sort them and return the sorted slice.

func ToBoolMap

func ToBoolMap[T comparable](src []T) map[T]bool

ToBoolMap will convert a slice to a set of true flags in a map that can then be looked up in (or set to false to get rid of items)

For eample,

x := []string{ "a", "b" }

Will produce `x`, a map[string]bool with values of:

x == map[string]bool{ "a": true, "b": true }

func Unique

func Unique[T comparable](s []T) []T

Types

type Numeric

type Numeric interface {
	~int | ~int8 | ~int16 | ~int32 | ~int64 |
		~uint | ~uint8 | ~uint16 | ~uint32 | ~uint64 |
		~float32 | ~float64
}

type SignedInteger

type SignedInteger interface {
	~int | ~int8 | ~int16 | ~int32 | ~int64
}

Signed is a constraint with a type set of all signed integer types.

type SignedNumeric

type SignedNumeric interface {
	~int | ~int8 | ~int16 | ~int32 | ~int64 |
		~float32 | ~float64
}

SignedNumeric is a constraint with a type set of all signed types.

type Unsigned

type Unsigned interface {
	~uint | ~uint8 | ~uint16 | ~uint32 | ~uint64 | ~uintptr
}

Unsigned is a constraint with a type set of all unsigned integer types.