package
0.0.0-20250110111850-388dcc8fb34c
Repository: https://github.com/consensys/go-corset.git
Documentation: pkg.go.dev

# Functions

Append creates a new slice containing the result of appending the given item onto the end of the given slice.
AreLexicographicallySorted checks whether one or more columns are lexicographically sorted according to the given signs.
ArePermutationOf checks whether or not a set of given destination columns are a valid permutation of a given set of source columns.
BoldAnsiEscape constructs a reset term.
BoundsForArray determines the bounds for an array of expressions.
EnumerateElements returns an iterator which enumerates all arrays of size n over the given set of elements.
Equals2d returns true if two 2D arrays are equal.
FlatArrayIndexOf_2 returns the ith element of the flattened form of a 2d array.
FlatArrayIndexOf_3 returns the ith element of the flattened form of a 2d array.
FlatArrayIndexOf_4 returns the ith element of the flattened form of a 2d array.
FlatArrayIndexOf_5 returns the ith element of the flattened form of a 2d array.
FlatArrayIndexOf_6 returns the ith element of the flattened form of a 2d array.
FrArrayFromBigInts converts an array of big integers into an array of field elements.
FrElementToBytes converts a given field element into a slice of 32 bytes.
GenerateRandomElements generates n elements selected at random from the given array.
GenerateRandomUints generates n random unsigned integers in the range 0..m.
NewAbsolutePath constructs a new absolute path from the given segments.
NewAnsiEscape construct an empty escape.
NewAnySortedSet returns an empty sorted set.
NewAppendIterator construct an iterator over an array of items.
NewArrayIterator construct an iterator over an array of items.
NewBounds constructs a new set of bounds.
NewBytesKey constructs a new bytes key.
NewCastIterator construct an iterator over an array of items.
NewFlattenIterator adapts a sequence of items S which themselves can be iterated as items T, into a flat sequence of items T.
NewFrArray creates a new FrArray dynamically based on the given width.
NewFrBitPool constructs a new pool which uses a single bit for indexing.
NewFrElementArray constructs a new field array with a given capacity.
NewFrIndexPool constructs a new pool which uses a given key type for indexing.
NewFrMapPool constructs a new pool which uses map to index items.
NewFrPoolArray constructs a new pooled field array using a given pool.
NewFrPtrElementArray constructs a new field array with a given capacity.
NewHashSet creates a new HashSet with a given underlying capacity.
NewPair returns a new instance of Pair by value.
NewPairRef returns a reference to a new instance of Pair.
NewPerfStats creates a new snapshot of the current amount of memory allocated.
NewRelativePath constructs a new absolute path from the given segments.
NewSortedSet returns an empty sorted set.
NewTablePrinter constructs a new table with given dimensions.
NewUnitIterator construct an iterator over an array of items.
None constructs an option which doesn't hold a value.
ParExec executes a set of jobs in parallel using go-routines.
PermutationSort sorts an array of columns in row-wise fashion.
Pow takes a given value to the power n.
Prepend creates a new slice containing the result of prepending the given item onto the end of the given slice.
ReadInputFile reads an input file as a sequence of lines.
RemoveMatching removes all elements from an array matching the given item.
ReplaceFirstOrPanic replaces the first occurrence of a given item (from) in an array with another item (to).
ResetAnsiEscape constructs a reset term.
ShallowCloneMap makes a shallow clone of a given map.
Some constructs an option which holds a value.
UnderlineAnsiEscape constructs a reset term.
UnionAnySortedSets unions together a number of things which can be turn into a sorted set using a given mapping function.
UnionSortedSets unions together a number of things which can be turn into a sorted set using a given mapping function.

# Constants

TERM_BLACK represents black.
TERM_BLUE represents blue.
TERM_CYAN represents cyan.
TERM_GREEN represents green.
TERM_MAGENTA represents magenta.
TERM_RED represents red.
TERM_WHITE represents white.
TERM_YELLOW represents yellow.

# Variables

EMPTY_BOUND is the bound which overlaps exactly with the original range.

# Structs

AnsiEscape represents an ANSI escape code used for formatting text in a terminal.
Bounds captures the subrange of rows for which a computation is well-defined.
BytesKey wraps a bytes array as something which can be safely placed into a HashSet.
FrBitPool is a pool implementation indexed using a single bit which is backed by an array of a fixed size.
FrElementArray implements an array of field elements using an underlying byte array.
FrIndexPool is a pool implementation which is backed by an array of a fixed size.
FrMapPool is a pool implementation indexed using a map and backed using a dynamically sized array.
FrPoolArray implements an array of field elements using an index to pool identical elements.
FrPtrElementArray implements an array of field elements using an underlying byte array.
HashSet defines a generic set implementation backed by a map.
Option provides a simple encoding for an optional value.
Order provides a wrapper around primtive types for use with an AnySortedSet.
Pair provides a simple encapsulation of two items paired together.
Path is a construct for describing paths through trees.
PerfStats provides a snapshot of memory allocation at a given point in time.
TablePrinter is useful for printing tables to the terminal.

# Interfaces

Array provides a generice interface to an array of elements.
Boundable captures computations which are well-defined only for a specific subrange of rows (the bounds).
Comparable provides an interface which types used in a AnySortedSet must implement.
Enumerator abstracts the process of iterating over a sequence of elements.
FrPool captures a pool of field elements which are used to reduce unnecessary duplication of elements.
Hasher provides a generic definition of a hashing function suitable for use within the hashset.
Iterator is an adapter which sits on top of a BaseIterator and provides various useful and reusable functions.
ParBatchJob represents an atomic division of work which is composed of one or more jobs.

# Type aliases

AnySortedSet is an array of unique sorted values (i.e.
Predicate abstracts the notion of a function which identifies something.
SortedSet is an array of unique sorted values (i.e.