funcy

README

funcy

What is this?

A library providing functional-style operations like Map/Reduce/Filter (to name a few) implemented in Go w/ generics.

But Rob Pike says we should just write for loops instead...

Sorry, I guess I just couldn't resist. I extend apologies to all the Go purists who are annoyed by this.

Are you aware that this approach lacks lazy evaluation, generates a ton of garbage, and won't scale for increasingly large inputs?

Yup. I extend apologies to all the functional purists who are annoyed by this.

How would one install it? (Asking for a friend...)

go get github.com/mdwhatcott/funcy

Enjoy!

Documentation

Index

• func Abs[T Number](t T) T
• func Add[T Number](a, b T) T
• func All(inputs []bool) bool
• func Any(inputs []bool) bool
• func As[T any](v any) T
• func ByLength[T any](t T) int
• func ByNumericValue[T Number](t T) T
• func Complement[T any](predicate func(t T) bool) func(t T) bool
• func Concat[T any](slices ...[]T) (result []T)
• func Drain[T any](channel <-chan T) (slice []T)
• func Drop[T any](n int, values []T) []T
• func DropAllBut[T any](n int, values []T) []T
• func DropWhile[T any](predicate func(T) bool, values []T) (result []T)
• func Filter[T any](predicate func(t T) bool, values []T) (result []T)
• func FilterAs[T any](collection []any) []T
• func First[T any](values []T) T
• func FirstNonDefault[T comparable](values ...T) (zero T)
• func FirstOrDefault[T any](values []T) (default_ T)
• func Flatten[T any](matrix [][]T) (result []T)
• func Frequencies[T comparable](values []T) map[T]int
• func GroupBy[K comparable, V any](key func(V) K, list []V) (result [][]V)
• func IndexBy[K comparable, V any](key func(V) K, list []V) map[K]V
• func Is[T any](v any) bool
• func IsEven[T Integer](t T) bool
• func IsNegative[T Integer](t T) bool
• func IsNil[T any](t T) bool
• func IsOdd[T Integer](t T) bool
• func IsPositive[T Integer](t T) bool
• func IsZero[T Integer](t T) bool
• func KeyValueIndexBy[K comparable, V1, V2 any](kv func(V1) (K, V2), list []V1) map[K]V2
• func Last[T any](values []T) T
• func LastOrDefault[T any](values []T) (default_ T)
• func Load[T any](result chan<- T, stream []T)
• func Map[I, O any](transform func(i I) O, values []I) (result []O)
• func Map2[Ia, Ib, O any](transform func(Ia, Ib) O, a []Ia, b []Ib) (result []O)
• func MapAsAny[T any](items []T) (result []any)
• func MapCat[I, O any](transform func(i I) []O, values []I) (result []O)
• func MapKeys[K comparable, V any](m map[K]V) (results []K)
• func MapLookup[K comparable, V any](m map[K]V) func(K) V
• func MapValues[K comparable, V any](m map[K]V) (results []V)
• func MapVoid[T any](f func(T), values []T)
• func Max[T LessThan](all []T) T
• func Min[T LessThan](all []T) T
• func Multiply[T Number](a, b T) T
• func None(inputs []bool) bool
• func PairsMap[K comparable, V any](pairs []Pair[K, V]) map[K]V
• func Partition[T any](length, increment int, values []T) (result [][]T)
• func Product[T Number](rolls []T) T
• func Range[N Number](start, stop N) (result []N)
• func RangeStep[N Number](start, stop, step N) (result []N)
• func Reduce[T any](calc func(a, b T) T, start T, values []T) (result T)
• func Remove[T any](predicate func(t T) bool, values []T) []T
• func Repeat[T any](n int, t T) (result []T)
• func Rest[T any](values []T) []T
• func Reverse[T any](values []T) (result []T)
• func Shuffle[T any](values []T) (result []T)
• func SliceLookup[V any](s []V) func(int) V
• func SlicedIndexBy[K comparable, V any](key func(V) K, list []V) map[K][]V
• func SlicedKeyValueIndexBy[K comparable, V1, V2 any](kv func(V1) (K, V2), list []V1) map[K][]V2
• func SortAscending[C LessThan, V any](key func(V) C, original []V) (result []V)
• func SortDescending[C LessThan, V any](key func(V) C, original []V) (result []V)
• func Square[T Number](t T) T
• func String[T any](t T) string
• func Sum[T Number](rolls []T) T
• func Take[T any](n int, values []T) []T
• func TakeAllBut[T any](n int, values []T) []T
• func TakeWhile[T any](predicate func(T) bool, values []T) (result []T)
• func Unique[T comparable](values []T) []T
• func ZipMap[A comparable, B any](a []A, b []B) (result map[A]B)
• type Integer
• type LessThan
• type Number
• type Pair
  • func MapPairs[K comparable, V any](m map[K]V) (results []Pair[K, V])
  • func Zip[A, B any](a []A, b []B) (result []Pair[A, B])

Functions

func Abs

func Abs[T Number](t T) T

func Add

func Add[T Number](a, b T) T

func All

func All(inputs []bool) bool

func Any

func Any(inputs []bool) bool

func As

func As[T any](v any) T

func ByLength

func ByLength[T any](t T) int

func ByNumericValue

func ByNumericValue[T Number](t T) T

func Complement

func Complement[T any](predicate func(t T) bool) func(t T) bool

func Concat

func Concat[T any](slices ...[]T) (result []T)

func Drain

func Drain[T any](channel <-chan T) (slice []T)

func Drop

func Drop[T any](n int, values []T) []T

func DropAllBut

func DropAllBut[T any](n int, values []T) []T

func DropWhile

func DropWhile[T any](predicate func(T) bool, values []T) (result []T)

func Filter

func Filter[T any](predicate func(t T) bool, values []T) (result []T)

func FilterAs

func FilterAs[T any](collection []any) []T

func First

func First[T any](values []T) T

func FirstNonDefault

func FirstNonDefault[T comparable](values ...T) (zero T)

func FirstOrDefault

func FirstOrDefault[T any](values []T) (default_ T)

func Flatten

func Flatten[T any](matrix [][]T) (result []T)

func Frequencies

func Frequencies[T comparable](values []T) map[T]int

func GroupBy

func GroupBy[K comparable, V any](key func(V) K, list []V) (result [][]V)

func IndexBy

func IndexBy[K comparable, V any](key func(V) K, list []V) map[K]V

func Is

func Is[T any](v any) bool

func IsEven

func IsEven[T Integer](t T) bool

func IsNegative

func IsNegative[T Integer](t T) bool

func IsNil

func IsNil[T any](t T) bool

func IsOdd

func IsOdd[T Integer](t T) bool

func IsPositive

func IsPositive[T Integer](t T) bool

func IsZero

func IsZero[T Integer](t T) bool

func KeyValueIndexBy

func KeyValueIndexBy[K comparable, V1, V2 any](kv func(V1) (K, V2), list []V1) map[K]V2

func Last

func Last[T any](values []T) T

func LastOrDefault

func LastOrDefault[T any](values []T) (default_ T)

func Load

func Load[T any](result chan<- T, stream []T)

func Map

func Map[I, O any](transform func(i I) O, values []I) (result []O)

func Map2

func Map2[Ia, Ib, O any](transform func(Ia, Ib) O, a []Ia, b []Ib) (result []O)

func MapAsAny

func MapAsAny[T any](items []T) (result []any)

func MapCat

func MapCat[I, O any](transform func(i I) []O, values []I) (result []O)

func MapKeys

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

func MapLookup

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

func MapValues

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

func MapVoid

func MapVoid[T any](f func(T), values []T)

func Max

func Max[T LessThan](all []T) T

func Min

func Min[T LessThan](all []T) T

func Multiply

func Multiply[T Number](a, b T) T

func None

func None(inputs []bool) bool

func PairsMap

func PairsMap[K comparable, V any](pairs []Pair[K, V]) map[K]V

func Partition

func Partition[T any](length, increment int, values []T) (result [][]T)

func Product

func Product[T Number](rolls []T) T

func Range

func Range[N Number](start, stop N) (result []N)

func RangeStep

func RangeStep[N Number](start, stop, step N) (result []N)

func Reduce

func Reduce[T any](calc func(a, b T) T, start T, values []T) (result T)

func Remove

func Remove[T any](predicate func(t T) bool, values []T) []T

func Repeat

func Repeat[T any](n int, t T) (result []T)

func Rest

func Rest[T any](values []T) []T

func Reverse

func Reverse[T any](values []T) (result []T)

func Shuffle

func Shuffle[T any](values []T) (result []T)

func SliceLookup

func SliceLookup[V any](s []V) func(int) V

func SlicedIndexBy

func SlicedIndexBy[K comparable, V any](key func(V) K, list []V) map[K][]V

func SlicedKeyValueIndexBy

func SlicedKeyValueIndexBy[K comparable, V1, V2 any](kv func(V1) (K, V2), list []V1) map[K][]V2

func SortAscending

func SortAscending[C LessThan, V any](key func(V) C, original []V) (result []V)

func SortDescending

func SortDescending[C LessThan, V any](key func(V) C, original []V) (result []V)

func Square

func Square[T Number](t T) T

func String

func String[T any](t T) string

func Sum

func Sum[T Number](rolls []T) T

func Take

func Take[T any](n int, values []T) []T

func TakeAllBut

func TakeAllBut[T any](n int, values []T) []T

func TakeWhile

func TakeWhile[T any](predicate func(T) bool, values []T) (result []T)

func Unique

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

func ZipMap

func ZipMap[A comparable, B any](a []A, b []B) (result map[A]B)

Types

type Integer

type Integer interface {
	int | int8 | int16 | int32 | int64 | uint | uint8 | uint16 | uint32 | uint64
}

type LessThan

type LessThan interface {
	Number | string
}

type Number

type Number interface {
	Integer | uintptr | float64 | float32
}

type Pair

type Pair[A, B any] struct {
	A A
	B B
}

func MapPairs

func MapPairs[K comparable, V any](m map[K]V) (results []Pair[K, V])

func Zip

func Zip[A, B any](a []A, b []B) (result []Pair[A, B])