list

package
v0.11.0-alpha.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 5, 2024 License: Apache-2.0 Imports: 12 Imported by: 0

Documentation

Overview

Package list contains functions for manipulating and examining lists.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Avg added in v0.0.9

func Avg(xs []*internal.Decimal) (*internal.Decimal, error)

Avg returns the average value of a non empty list xs.

func Concat added in v0.3.0

func Concat(a []cue.Value) ([]cue.Value, error)

Concat takes a list of lists and concatenates them.

Concat([a, b, c]) is equivalent to

[for x in a {x}, for x in b {x}, for x in c {x}]

func Contains

func Contains(a []cue.Value, v cue.Value) bool

Contains reports whether v is contained in a. The value must be a comparable value.

func Drop added in v0.0.10

func Drop(x []cue.Value, n int) ([]cue.Value, error)

Drop reports the suffix of list x after the first n elements, or [] if n > len(x).

For instance:

Drop([1, 2, 3, 4], 2)

results in

[3, 4]

func FlattenN added in v0.0.12

func FlattenN(xs cue.Value, depth int) ([]cue.Value, error)

FlattenN reports a flattened sequence of the list xs by expanding any elements depth levels deep. If depth is negative all elements are expanded.

For instance:

FlattenN([1, [[2, 3], []], [4]], 1)

results in

[1, [2, 3], [], 4]

func IsSorted added in v0.1.0

func IsSorted(list []cue.Value, cmp cue.Value) bool

IsSorted tests whether a list is sorted.

See Sort for an example comparator.

func IsSortedStrings added in v0.1.0

func IsSortedStrings(a []string) bool

IsSortedStrings tests whether a list is a sorted lists of strings.

func MatchN added in v0.11.0

func MatchN(list []cue.Value, n pkg.Schema, matchValue pkg.Schema) (bool, error)

MatchN is a validator that checks that the number of elements in the given list that unifies with the schema "matchValue" matches "n". "n" may be a number constraint and does not have to be a concrete number. Likewise, "matchValue" will usually be a non-concrete value.

func Max added in v0.0.9

func Max(xs []*internal.Decimal) (*internal.Decimal, error)

Max returns the maximum value of a non empty list xs.

func MaxItems

func MaxItems(list pkg.List, n int) (bool, error)

MaxItems reports whether a has at most n items.

func Min added in v0.0.9

func Min(xs []*internal.Decimal) (*internal.Decimal, error)

Min returns the minimum value of a non empty list xs.

func MinItems

func MinItems(list pkg.List, n int) (bool, error)

MinItems reports whether a has at least n items.

func Product added in v0.0.9

func Product(xs []*internal.Decimal) (*internal.Decimal, error)

Product returns the product of a non empty list xs.

func Range added in v0.0.12

func Range(start, limit, step *internal.Decimal) ([]*internal.Decimal, error)

Range generates a list of numbers using a start value, a limit value, and a step value.

For instance:

Range(0, 5, 2)

results in

[0, 2, 4]

func Repeat added in v0.3.0

func Repeat(x []cue.Value, count int) ([]cue.Value, error)

Repeat returns a new list consisting of count copies of list x.

For instance:

Repeat([1, 2], 2)

results in

[1, 2, 1, 2]

func Reverse added in v0.10.0

func Reverse(x []cue.Value) []cue.Value

Reverse reverses a list.

For instance:

Reverse([1, 2, 3, 4])

results in

[4, 3, 2, 1]

func Slice added in v0.0.10

func Slice(x []cue.Value, i, j int) ([]cue.Value, error)

Slice extracts the consecutive elements from list x starting from position i up till, but not including, position j, where 0 <= i < j <= len(x).

For instance:

Slice([1, 2, 3, 4], 1, 3)

results in

[2, 3]

func Sort added in v0.1.0

func Sort(list []cue.Value, cmp cue.Value) (sorted []cue.Value, err error)

Sort sorts data while keeping the original order of equal elements. It does O(n*log(n)) comparisons.

cmp is a struct of the form {T: _, x: T, y: T, less: bool}, where less should reflect x < y.

Example:

Sort([2, 3, 1], list.Ascending)

Sort([{a: 2}, {a: 3}, {a: 1}], {x: {}, y: {}, less: x.a < y.a})

func SortStable deprecated added in v0.1.0

func SortStable(list []cue.Value, cmp cue.Value) (sorted []cue.Value, err error)

Deprecated: use Sort, which is always stable

func SortStrings added in v0.1.0

func SortStrings(a []string) []string

SortStrings sorts a list of strings in increasing order.

func Sum added in v0.0.9

func Sum(xs []*internal.Decimal) (*internal.Decimal, error)

Sum returns the sum of a list non empty xs.

func Take added in v0.0.10

func Take(x []cue.Value, n int) ([]cue.Value, error)

Take reports the prefix of length n of list x, or x itself if n > len(x).

For instance:

Take([1, 2, 3, 4], 2)

results in

[1, 2]

func UniqueItems

func UniqueItems(a []cue.Value) bool

UniqueItems reports whether all elements in the list are unique.

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL