module

package module
v5.7.0 Latest Latest
Warning

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

Go to latest
Published: Apr 26, 2025 License: MIT Imports: 2 Imported by: 9

Documentation

Overview

┌────────────────────────────────── WARNING ───────────────────────────────────┐ │ This "Module.go" file was automatically generated. │ │ Updates to any part of this file—other than the Module Description │ │ and the Global Functions sections may be overwritten. │ └──────────────────────────────────────────────────────────────────────────────┘

Package "module" declares type aliases for the commonly used types declared in the packages contained in this module. It also provides a default constructor for each commonly used class that is exported by the module. Each constructor delegates the actual construction process to its corresponding concrete class declared in the corresponding package contained within this module.

For detailed documentation on this entire module refer to the wiki:

Index

Constants

View Source
const (
	LesserRank  = age.LesserRank
	EqualRank   = age.EqualRank
	GreaterRank = age.GreaterRank
)

Variables

This section is empty.

Functions

func Association

func Association[K comparable, V any](
	key K,
	value V,
) col.AssociationLike[K, V]

func Catalog

func Catalog[K comparable, V any]() col.CatalogLike[K, V]

func CatalogExtract added in v5.6.0

func CatalogExtract[K comparable, V any](
	catalog col.CatalogLike[K, V],
	keys col.Sequential[K],
) col.CatalogLike[K, V]

func CatalogFromArray added in v5.1.0

func CatalogFromArray[K comparable, V any](
	associations []col.AssociationLike[K, V],
) col.CatalogLike[K, V]

func CatalogFromMap added in v5.1.0

func CatalogFromMap[K comparable, V any](
	associations map[K]V,
) col.CatalogLike[K, V]

func CatalogFromSequence added in v5.1.0

func CatalogFromSequence[K comparable, V any](
	associations col.Sequential[col.AssociationLike[K, V]],
) col.CatalogLike[K, V]

func CatalogMerge added in v5.6.0

func CatalogMerge[K comparable, V any](
	first col.CatalogLike[K, V],
	second col.CatalogLike[K, V],
) col.CatalogLike[K, V]

func Collator

func Collator[V any]() age.CollatorLike[V]

func CollatorWithMaximumDepth added in v5.1.0

func CollatorWithMaximumDepth[V any](
	maximumDepth age.Size,
) age.CollatorLike[V]

func Iterator

func Iterator[V any](
	array []V,
) age.IteratorLike[V]

func List

func List[V any]() col.ListLike[V]

func ListConcatenate added in v5.6.0

func ListConcatenate[V any](
	first col.ListLike[V],
	second col.ListLike[V],
) col.ListLike[V]

func ListFromArray added in v5.1.0

func ListFromArray[V any](
	values []V,
) col.ListLike[V]

func ListFromSequence added in v5.1.0

func ListFromSequence[V any](
	values col.Sequential[V],
) col.ListLike[V]

func Queue

func Queue[V any]() col.QueueLike[V]

func QueueFork added in v5.6.0

func QueueFork[V any](
	group col.Synchronized,
	input col.QueueLike[V],
	size age.Size,
) col.Sequential[col.QueueLike[V]]

func QueueFromArray added in v5.1.0

func QueueFromArray[V any](
	values []V,
) col.QueueLike[V]

func QueueFromSequence added in v5.1.0

func QueueFromSequence[V any](
	values col.Sequential[V],
) col.QueueLike[V]

func QueueJoin added in v5.6.0

func QueueJoin[V any](
	group col.Synchronized,
	inputs col.Sequential[col.QueueLike[V]],
) col.QueueLike[V]

func QueueSplit added in v5.6.0

func QueueSplit[V any](
	group col.Synchronized,
	input col.QueueLike[V],
	size age.Size,
) col.Sequential[col.QueueLike[V]]

func QueueWithCapacity added in v5.1.0

func QueueWithCapacity[V any](
	capacity age.Size,
) col.QueueLike[V]

func Set

func Set[V any]() col.SetLike[V]

func SetAnd added in v5.6.0

func SetAnd[V any](
	first col.SetLike[V],
	second col.SetLike[V],
) col.SetLike[V]

func SetFromArray added in v5.1.0

func SetFromArray[V any](
	values []V,
) col.SetLike[V]

func SetFromSequence added in v5.1.0

func SetFromSequence[V any](
	values col.Sequential[V],
) col.SetLike[V]

func SetOr added in v5.6.0

func SetOr[V any](
	first col.SetLike[V],
	second col.SetLike[V],
) col.SetLike[V]

func SetSans added in v5.6.0

func SetSans[V any](
	first col.SetLike[V],
	second col.SetLike[V],
) col.SetLike[V]

func SetWithCollator added in v5.1.0

func SetWithCollator[V any](
	collator age.CollatorLike[V],
) col.SetLike[V]

func SetXor added in v5.6.0

func SetXor[V any](
	first col.SetLike[V],
	second col.SetLike[V],
) col.SetLike[V]

func Sorter

func Sorter[V any]() age.SorterLike[V]

func SorterWithRanker added in v5.1.0

func SorterWithRanker[V any](
	ranker age.RankingFunction[V],
) age.SorterLike[V]

func Stack

func Stack[V any]() col.StackLike[V]

func StackFromArray added in v5.1.0

func StackFromArray[V any](
	values []V,
) col.StackLike[V]

func StackFromSequence added in v5.1.0

func StackFromSequence[V any](
	values col.Sequential[V],
) col.StackLike[V]

func StackWithCapacity added in v5.1.0

func StackWithCapacity[V any](
	capacity age.Size,
) col.StackLike[V]

Types

type Index

type Index = col.Index

type Rank

type Rank = age.Rank

type Size

type Size = age.Size

type Slot

type Slot = age.Slot

type Synchronized

type Synchronized = col.Synchronized

Directories

Path Synopsis
Package "agent" declares a set of agents that operate on values that have a generic type.
Package "agent" declares a set of agents that operate on values that have a generic type.
Package "collection" declares a set of collection classes that maintain values of a generic type:
Package "collection" declares a set of collection classes that maintain values of a generic type:

Jump to

Keyboard shortcuts

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