API/nerdamer/structures

Class

Collection

src/core/classes/collection/Collection.ts:24

An ordered heterogeneous collection of parser entities.

remarks

The constructor retains the supplied array and its element references. getElements likewise exposes the live backing array. Use copy for an independent collection; it copies every contained parser entity. each and indexed assignment mutate the collection. A callback passed to each may return a replacement value or return nothing to leave the current value unchanged. Use forEach for observation-only iteration. Evaluation and expansion operate on a deep copy. Equality and relational predicates compare corresponding elements and return false for a non-Collection or length mismatch; these component-wise predicates do not define a lexicographic ordering for heterogeneous values.

Members

__get__(indices: number[]): ParserEntityMethod

Returns the element at the given index.

Parameters

Name	Type	Description
`indices`	`number[]`	A single-element array [i]

Returns

__set__(indices: number[], value: ParserEntity): voidMethod

Sets the element at the given index.

Parameters

Name	Type	Description
`indices`	`number[]`	A single-element array [i]
`value`	`ParserEntity`	The value to set

Returns

void

[iterator](): Iterator<ParserEntity>Method

Iterates over the stored entity references in insertion order.

Returns

Iterator<ParserEntity>

abs(): CollectionMethod

No description is available yet.

Returns

at(index: number): ParserEntity | undefinedMethod

Returns the stored entity reference at a zero-based index, or undefined when absent.

Parameters

Name	Type	Description
`index`	`number`	—

Returns

ParserEntity | undefined

buildFunction(argsArray?: string[]): (...args: number[]): numberMethod

Compiles this value to a native JavaScript-number function when the parsed result is an Expression. Structured parser results expose this method so values returned by nerdamer(...) have one consistent TypeScript surface, but they cannot be compiled as scalar functions and throw core!UnexpectedDataType when called.

Parameters

Name	Type	Description
`argsArray`	`string[]`	Optional variable names in positional call order.

Returns

(...args: number[]): number — A JavaScript-number function compiled from the scalar expression.

Collection(elements?: ParserEntity[]): CollectionConstructor

Creates a Collection, retaining elements when it is supplied.

Parameters

Name	Type	Description
`elements`	`ParserEntity[]`	Initial backing array.

Returns

copy(): CollectionMethod

Copies the collection and every contained entity.

Returns

count(): numberMethod

Returns the number of values in the collection.

Returns

number

dataType: "COL"Property

Runtime type discriminator for collections.

diff(variable?: ExpressionInput, n?: number | Expression): CollectionMethod

No description is available yet.

Parameters

Name	Type	Description
`variable`	`ExpressionInput`	—
`n`	`number \| Expression`	—

Returns

dimensions(): number[]Method

Returns the collection length as a one-dimensional shape.

Returns

number[]

dimensionsMatch(x: ParserEntity): xMethod

No description is available yet.

Parameters

Name	Type	Description
`x`	`ParserEntity`	—

Returns

x

div(x: NerdamerInput): CollectionMethod

No description is available yet.

Parameters

Name	Type	Description
`x`	`NerdamerInput`	—

Returns

each(callback: (a: ParserEntity, b: number): void | ParserEntity): thisMethod

Visits or replaces values in ascending index order. Returning a ParserEntity replaces the current value. Returning void leaves that value unchanged, so callers can inspect a collection without a dummy return. Use forEach when no transformation is intended.

Parameters

Name	Type	Description
`callback`	`(a: ParserEntity, b: number): void \| ParserEntity`	Function receiving each value and index.

Returns

this

elements: ParserEntity[]Property

Live array containing the collection's values.

eq(x: ParserEntity): booleanMethod

Tests whether another Collection has equal values in the same order.

Parameters

Name	Type	Description
`x`	`ParserEntity`	Value to compare.

Returns

boolean

evaluate(): CollectionMethod

Evaluates a copied collection, leaving this one unchanged.

Returns

expand(): CollectionMethod

Expands every value in a copied collection.

Returns

factor(): CollectionMethod

No description is available yet.

Returns

forEach(callback: (value: ParserEntity, index: number): void): voidMethod

Visits stored entity references without changing the collection.

Parameters

Name	Type	Description
`callback`	`(value: ParserEntity, index: number): void`	—

Returns

void

getElements(): ParserEntity[]Method

Returns the live backing array; mutations to it affect this Collection.

Returns

ParserEntity[]

gt(x: ParserEntity): booleanMethod

Tests whether every value is greater than its corresponding value.

Parameters

Name	Type	Description
`x`	`ParserEntity`	Value to compare.

Returns

boolean

gte(x: ParserEntity): booleanMethod

Tests component-wise greater-than-or-equal comparison.

Parameters

Name	Type	Description
`x`	`ParserEntity`	Value to compare.

Returns

boolean

integrate(variable?: ExpressionInput): CollectionMethod

No description is available yet.

Parameters

Name	Type	Description
`variable`	`ExpressionInput`	—

Returns

isCollection(obj: unknown): objMethod

Returns whether a value is a Collection.

Parameters

Name	Type	Description
`obj`	`unknown`	Value to test.

Returns

obj

isEnumerable: booleanProperty

Indicates that parser operations may be applied to each element.

lt(x: ParserEntity): booleanMethod

Tests whether every value is less than its corresponding value.

Parameters

Name	Type	Description
`x`	`ParserEntity`	Value to compare.

Returns

boolean

lte(x: ParserEntity): booleanMethod

Tests component-wise less-than-or-equal comparison.

Parameters

Name	Type	Description
`x`	`ParserEntity`	Value to compare.

Returns

boolean

minus(x: NerdamerInput): CollectionMethod

No description is available yet.

Parameters

Name	Type	Description
`x`	`NerdamerInput`	—

Returns

numeric(precision?: ExpressionInput): CollectionMethod

No description is available yet.

Parameters

Name	Type	Description
`precision`	`ExpressionInput`	—

Returns

plus(x: NerdamerInput): CollectionMethod

No description is available yet.

Parameters

Name	Type	Description
`x`	`NerdamerInput`	—

Returns

pow(x: NerdamerInput): CollectionMethod

No description is available yet.

Parameters

Name	Type	Description
`x`	`NerdamerInput`	—

Returns

precision: numberProperty

Precision metadata when the collection carries an approximate result.

simplify(): CollectionMethod

No description is available yet.

Returns

subst(value: ExpressionInput, withValue: ExpressionInput): CollectionMethod

No description is available yet.

Parameters

Name	Type	Description
`value`	`ExpressionInput`	—
`withValue`	`ExpressionInput`	—

Returns

text(): stringMethod

Returns the collection in Nerdamer notation.

Returns

string

times(x: NerdamerInput): CollectionMethod

No description is available yet.

Parameters

Name	Type	Description
`x`	`NerdamerInput`	—

Returns

toArray(): ParserEntity[]Method

Returns a new array containing the stored entity references in insertion order.

Returns

ParserEntity[]

toString(): stringMethod

No description is available yet.

Returns

string