maputil

Documentation

Index

• Constants
• Variables
• func DuplicateValues[C comparable](m map[C]C) map[C][]C
• func Keys[K constraints.Ordered, V any](m map[K]V) []K
• func KeysExist[K comparable, V any](m map[K]V, keys []K, requireAll bool) bool
• func MapSSToKeyValues(kvs map[string]string, sep string) string
• func MapStringMapStringIntFuncExactMatch(valWant int) func(string, string, int) bool
• func MapStringMapStringIntFuncIncludeAll(str1, str2 string, val int) bool
• func MapStringSliceCondenseSpace(m map[string][]string, dedupeVals, sortVals bool) map[string][]string
• func NumberValuesAverage[K comparable, V constraints.Float | constraints.Integer](m map[K]V) float64
• func StringKeys[V any](m map[string]V, xf func(s string) string) []string
• func UniqueValues[C comparable](m map[C]C) bool
• func ValueIntOrDefault[K comparable, V constraints.Integer](m map[K]V, key K, def V) V
• func ValueStringOrDefault[K comparable](m map[K]string, key K, def string) string
• func Values[K constraints.Ordered, V any](m map[K]V) []V
• func ValuesSorted[K comparable, V constraints.Ordered](m map[K]V) []V
• type MapInt64Int64
  • func (m MapInt64Int64) KeysSorted() []int64
  • func (m MapInt64Int64) ValuesSortedByKeys() []int64
• type MapStringInt
  • func NewMapStringIntSlice(slice []string) MapStringInt
  • func (msi MapStringInt) Add(key string, val int)
  • func (msi MapStringInt) Exists(key string) bool
  • func (msi MapStringInt) Keys(sortKeys bool) []string
  • func (msi MapStringInt) MinMaxValues() (int, int)
  • func (msi MapStringInt) MustGet(key string, defaultValue int) int
  • func (msi MapStringInt) Set(key string, val int)
  • func (msi MapStringInt) Sorted(sortBy string) []Record
• type MapStringMapStringInt
  • func (msmsi MapStringMapStringInt) Add(str1, str2 string, val int)
  • func (msmsi MapStringMapStringInt) Counts(sep string) (int, int)
  • func (msmsi MapStringMapStringInt) CountsWithVal(wantVal int, sep string) (int, int)
  • func (msmsi MapStringMapStringInt) Flatten(prefix, sep string, fnInclude func(string, string, int) bool, ...) []string
  • func (msmsi MapStringMapStringInt) Set(str1, str2 string, val int)
• type MapStringSlice
  • func NewMapStringSlice() MapStringSlice
  • func (mss MapStringSlice) Add(key, value string)
  • func (mss MapStringSlice) Keys() []string
  • func (mss MapStringSlice) KeysByValueCounts() map[int][]string
  • func (mss MapStringSlice) Sort(dedupe bool)
• type Record
• type RecordSet
  • func (rs RecordSet) Markdown(prefix, sep string, countFirst, addTotal bool) string
  • func (rs RecordSet) Total() int

Constants

const (
	SortNameAsc   = "name asc"
	SortNameDesc  = "name desc"
	SortValueAsc  = "value asc"
	SortValueDesc = "value desc"
)

Variables

var ErrMapDuplicateValues = errors.New("map has duplicate values")

Functions

func DuplicateValues

func DuplicateValues[C comparable](m map[C]C) map[C][]C

func Keys

func Keys[K constraints.Ordered, V any](m map[K]V) []K

Keys returns a list of sorted keys.

func KeysExist

func KeysExist[K comparable, V any](m map[K]V, keys []K, requireAll bool) bool

KeysExist checks to verify if a set of keys exists within a map with string keys. If `requireAll` is set, then all keys must be present for the function to return `true`. If `requireAll` is not set, then only one key must exist for the function to return `true`.

func MapSSToKeyValues

func MapSSToKeyValues(kvs map[string]string, sep string) string

func MapStringMapStringIntFuncExactMatch

func MapStringMapStringIntFuncExactMatch(valWant int) func(string, string, int) bool

MapStringMapStringIntFuncExactMatch returns a match function that matches an exact vaule.

func MapStringMapStringIntFuncIncludeAll

func MapStringMapStringIntFuncIncludeAll(str1, str2 string, val int) bool

MapStringMapStringIntFuncIncludeAll returns match function that matches all values.

func MapStringSliceCondenseSpace

func MapStringSliceCondenseSpace(m map[string][]string, dedupeVals, sortVals bool) map[string][]string

MapStringSliceCondenseSpace will trim spaces for keys and values, and remove empty values. It will also optionally dedupe and sort values.

func NumberValuesAverage

func NumberValuesAverage[K comparable, V constraints.Float | constraints.Integer](m map[K]V) float64

NumberValuesAverage returns a `float64` average of a map's values.

func StringKeys

func StringKeys[V any](m map[string]V, xf func(s string) string) []string

StringKeys takes a map where the keys are strings and reurns a slice of key names. An optional transform function, `xf`, can be supplied along with an option to sort the results. If both transform and sort are requested, the sort is performed on the transformed strings.

func UniqueValues

func UniqueValues[C comparable](m map[C]C) bool

UniqueValues returns `true` if the number of unique values is the same as the number of keys.

func ValueIntOrDefault

func ValueIntOrDefault[K comparable, V constraints.Integer](m map[K]V, key K, def V) V

func ValueStringOrDefault

func ValueStringOrDefault[K comparable](m map[K]string, key K, def string) string

func Values

func Values[K constraints.Ordered, V any](m map[K]V) []V

func ValuesSorted

func ValuesSorted[K comparable, V constraints.Ordered](m map[K]V) []V

ValuesSorted returns a string slice of sorted values.

Types

type MapInt64Int64

type MapInt64Int64 map[int64]int64

func (MapInt64Int64) KeysSorted

func (m MapInt64Int64) KeysSorted() []int64

func (MapInt64Int64) ValuesSortedByKeys

func (m MapInt64Int64) ValuesSortedByKeys() []int64

type MapStringInt

type MapStringInt map[string]int

MapStringInt represents a `map[string]int`

func NewMapStringIntSlice

func NewMapStringIntSlice(slice []string) MapStringInt

func (MapStringInt) Add

func (msi MapStringInt) Add(key string, val int)

Add adds the value of `val` to `key`.

func (MapStringInt) Exists

func (msi MapStringInt) Exists(key string) bool

Exists returns a boolean whether a string key exists.

func (MapStringInt) Keys

func (msi MapStringInt) Keys(sortKeys bool) []string

Keys returns a string slice of the map's keys.

func (MapStringInt) MinMaxValues

func (msi MapStringInt) MinMaxValues() (int, int)

MinMaxValues returns the minium and maximum values of the `map[string]int`.

func (MapStringInt) MustGet

func (msi MapStringInt) MustGet(key string, defaultValue int) int

MustGet returns a value or a default.

func (MapStringInt) Set

func (msi MapStringInt) Set(key string, val int)

Set sets the value of `val` to `key`.

func (MapStringInt) Sorted

func (msi MapStringInt) Sorted(sortBy string) []Record

Sorted returns a set of key names and values sorted by the sort type.

type MapStringMapStringInt

type MapStringMapStringInt map[string]map[string]int

MapStringMapStringInt represents a `map[string]map[string]int`

func (MapStringMapStringInt) Add

func (msmsi MapStringMapStringInt) Add(str1, str2 string, val int)

Add supports adding values to `MapStringMapStringInt` easily.

func (MapStringMapStringInt) Counts

func (msmsi MapStringMapStringInt) Counts(sep string) (int, int)

Counts returns key counts regardless of value.

func (MapStringMapStringInt) CountsWithVal

func (msmsi MapStringMapStringInt) CountsWithVal(wantVal int, sep string) (int, int)

CountsWithVal returns key counts with the desired value.

func (MapStringMapStringInt) Flatten

func (msmsi MapStringMapStringInt) Flatten(prefix, sep string, fnInclude func(string, string, int) bool, dedupe, sortResults bool) []string

Flatten returns the values in the `MapStringMapStringInt` in an string slice.

func (MapStringMapStringInt) Set

func (msmsi MapStringMapStringInt) Set(str1, str2 string, val int)

Set supports setting values to `MapStringMapStringInt` easily.

type MapStringSlice

type MapStringSlice url.Values

func NewMapStringSlice

func NewMapStringSlice() MapStringSlice

func (MapStringSlice) Add

func (mss MapStringSlice) Add(key, value string)

Add adds a key and value to the `map[string][]string`. It will panic on a nil struct, so do not precede with `var mss MapStringSlice`

func (MapStringSlice) Keys

func (mss MapStringSlice) Keys() []string

func (MapStringSlice) KeysByValueCounts

func (mss MapStringSlice) KeysByValueCounts() map[int][]string

KeysByValueCounts returns a `map[int][]string` where the key is the count of values and the values are the keys with that value count.

func (MapStringSlice) Sort

func (mss MapStringSlice) Sort(dedupe bool)

type Record

type Record struct {
	Name  string
	Value int
}

type RecordSet

type RecordSet []Record

func (RecordSet) Markdown

func (rs RecordSet) Markdown(prefix, sep string, countFirst, addTotal bool) string

func (RecordSet) Total

func (rs RecordSet) Total() int