glinq

README

Glinq

Go implemention of LINQ using generics

Examples

---

package main

import (
	"github.com/rlarkin212/glinq"
)

type user struct {
	name string
	age  int
}

func main() {
	users := []user{
		{
			name: "a",
			age:  20,
		},
		{
			name: "b",
			age:  12,
		},
		{
			name: "c",
			age:  5,
		},
		{
			name: "d",
			age:  90,
		},
	}

	userNames := glinq.Select(users, func(x user) string {
		return x.name
	})
    
    //output: [a b c d]

	userAges := glinq.Select(users, func(x user) int {
		return x.age
	})

    //output: [20 12 5 90]

	maxAge := glinq.Max(userAges)

    //output: 90

    minAge := glinq.Min(userAges)

    //output: 5

	ageAverage := glinq.Average(userAges)

    //output: 31.75

	orderByAgeAscending := glinq.OrderBy(users, func(x user) int {
		return x.age
	})

    //output: [{c 5} {b 12} {a 20} {d 90}]

	orderByAgeDescending := glinq.OrderByDescending(users, func(x user) int {
		return x.age
	})

    //output: [{d 90} {a 20} {b 12} {c 5}]
}

Documentation

Index

• func All[T any](s []T, f func(x T) bool) bool
• func Any[T comparable](s []T, f func(T) bool) bool
• func Average[T Number](s []T) float64
• func Contains[T comparable](term T, s []T) bool
• func Distinct[T comparable](s []T) []T
• func Except[T comparable](s []T, s1 []T) []T
• func Exists[T comparable](s []T, item T) bool
• func First[T any](s []T) (T, error)
• func FirstWhere[T any](s []T, f func(x T) bool) (T, error)
• func Flatten[T any](s [][]T) []T
• func Index[T comparable](term T, s []T) int
• func Intersct[T comparable](s []T, s1 []T) []T
• func Join[T any](s ...[]T) []T
• func JoinWhere[T any](f func(x T) bool, s ...[]T) []T
• func Last[T any](s []T) (T, error)
• func LastWhere[T any](s []T, f func(x T) bool) (T, error)
• func Max[T Number](s []T) T
• func Min[T Number](s []T) T
• func OrderBy[T any, T2 constraints.Ordered](s []T, f func(x T) T2) []T
• func OrderByDescending[T any, T1 constraints.Ordered](s []T, f func(x T) T1) []T
• func Range[T any](s []T, start int, end int) []T
• func Reduce[T any](s []T, f func(x T, y T) T, initial T) T
• func Reverse[T any](s []T) []T
• func Select[T any, T2 any](s []T, f func(T) T2) []T2
• func Skip[T any](s []T, n int) ([]T, error)
• func Sum[T Number](s []T) T
• func Take[T any](s []T, n int) ([]T, error)
• func Where[T comparable](s []T, f func(T) bool) []T
• type Number

Functions

func All

func All[T any](s []T, f func(x T) bool) bool

All return true if all items in slice satisfy func

func Any

func Any[T comparable](s []T, f func(T) bool) bool

Any return true if item in slice satisfies func

func Average

func Average[T Number](s []T) float64

Average return the average of items in slice

func Contains

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

Contains returns true if term is contained in slice, else false

func Distinct

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

Distinct returns slice of distinct values

func Except

func Except[T comparable](s []T, s1 []T) []T

Except retusn slice of items in first slice but not in second

func Exists

func Exists[T comparable](s []T, item T) bool

Exists return true if item exists in slice

func First

func First[T any](s []T) (T, error)

First returns first item in slice or error if slice contains no items

func FirstWhere

func FirstWhere[T any](s []T, f func(x T) bool) (T, error)

FirstWhere returns first item in slice in slice that satisfies func or error if slice contains no items

func Flatten

func Flatten[T any](s [][]T) []T

Flatten returns slice from slice of slice

func Index

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

Index returns index of item if found in slice else returns -1

func Intersct

func Intersct[T comparable](s []T, s1 []T) []T

Intersect returns slice of items that are in both slices

func Join

func Join[T any](s ...[]T) []T

Join merges the provided slices into one

func JoinWhere

func JoinWhere[T any](f func(x T) bool, s ...[]T) []T

JoinWhere merges items in provided slices where item satisfies func

func Last

func Last[T any](s []T) (T, error)

Last returns last item in slice or error if slice contains no items

func LastWhere

func LastWhere[T any](s []T, f func(x T) bool) (T, error)

LastWhere returns last item in slice in slice that satisfies func or error if slice contains no items

func Max

func Max[T Number](s []T) T

Max returns max value in slice

func Min

func Min[T Number](s []T) T

Min returns min value of slice

func OrderBy

func OrderBy[T any, T2 constraints.Ordered](s []T, f func(x T) T2) []T

OrderBy returns slice with items ordered by returned item in func in ascending order

func OrderByDescending

func OrderByDescending[T any, T1 constraints.Ordered](s []T, f func(x T) T1) []T

OrderByDescending returns slice with items ordered by returned item in func in descending order

func Range

func Range[T any](s []T, start int, end int) []T

Range returns slice of items between index start & end

func Reduce

func Reduce[T any](s []T, f func(x T, y T) T, initial T) T

Reduce executes a user-supplied "reducer" function on each element of the slice

func Reverse

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

func Select

func Select[T any, T2 any](s []T, f func(T) T2) []T2

Select return slice of T based on supplied func

func Skip

func Skip[T any](s []T, n int) ([]T, error)

Skip skips over supplied number iof items and returns rest of slice

func Sum

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

Sum returns sum of items in slice

func Take

func Take[T any](s []T, n int) ([]T, error)

Take returns suppleid number of items from slice

func Where

func Where[T comparable](s []T, f func(T) bool) []T

Where return slice of items where item in slice satisfies func

Types

type Number

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