Collection
An ordered heterogeneous collection of parser entities.
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. 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[]): ParserEntityMethodReturns the element at the given index.
Parameters
| Name | Type | Description |
|---|---|---|
indices | number[] | A single-element array [i] |
Returns
__set__(indices: number[], value: ParserEntity): voidMethodSets 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
abs(): CollectionMethodNo description is available yet.
Returns
Collection(elements?: ParserEntity[]): CollectionConstructorCreates a Collection, retaining
`elements`when it is supplied.
Parameters
| Name | Type | Description |
|---|---|---|
elements | ParserEntity[] | — |
Returns
copy(): CollectionMethodCopies the collection and every contained entity.
Returns
count(): numberMethodNo description is available yet.
Returns
number
dataType: "COL"PropertyNo description is available yet.
diff(variable?: ExpressionInput, n?: number | Expression): CollectionMethodNo description is available yet.
Parameters
| Name | Type | Description |
|---|---|---|
variable | ExpressionInput | — |
n | number | Expression | — |
Returns
dimensions(): number[]MethodNo description is available yet.
Returns
number[]
dimensionsMatch(x: ParserEntity): xMethodNo description is available yet.
Parameters
| Name | Type | Description |
|---|---|---|
x | ParserEntity | — |
Returns
x
div(x: NerdamerInput): CollectionMethodNo description is available yet.
Parameters
| Name | Type | Description |
|---|---|---|
x | NerdamerInput | — |
Returns
each(callback: (a: ParserEntity, b: number): ParserEntity): thisMethodReplaces each value with the callback result in ascending index order.
Parameters
| Name | Type | Description |
|---|---|---|
callback | (a: ParserEntity, b: number): ParserEntity | — |
Returns
this
elements: ParserEntity[]PropertyNo description is available yet.
eq(x: ParserEntity): booleanMethodNo description is available yet.
Parameters
| Name | Type | Description |
|---|---|---|
x | ParserEntity | — |
Returns
boolean
evaluate(): CollectionMethodEvaluates a copied collection, leaving this one unchanged.
Returns
expand(): CollectionMethodNo description is available yet.
Returns
factor(): CollectionMethodNo description is available yet.
Returns
getElements(): ParserEntity[]MethodReturns the live backing array; mutations to it affect this Collection.
Returns
gt(x: ParserEntity): booleanMethodNo description is available yet.
Parameters
| Name | Type | Description |
|---|---|---|
x | ParserEntity | — |
Returns
boolean
gte(x: ParserEntity): booleanMethodNo description is available yet.
Parameters
| Name | Type | Description |
|---|---|---|
x | ParserEntity | — |
Returns
boolean
integrate(variable?: ExpressionInput): CollectionMethodNo description is available yet.
Parameters
| Name | Type | Description |
|---|---|---|
variable | ExpressionInput | — |
Returns
isCollection(obj: unknown): objMethodNo description is available yet.
Parameters
| Name | Type | Description |
|---|---|---|
obj | unknown | — |
Returns
obj
isEnumerable: booleanPropertyNo description is available yet.
lt(x: ParserEntity): booleanMethodNo description is available yet.
Parameters
| Name | Type | Description |
|---|---|---|
x | ParserEntity | — |
Returns
boolean
lte(x: ParserEntity): booleanMethodNo description is available yet.
Parameters
| Name | Type | Description |
|---|---|---|
x | ParserEntity | — |
Returns
boolean
minus(x: NerdamerInput): CollectionMethodNo description is available yet.
Parameters
| Name | Type | Description |
|---|---|---|
x | NerdamerInput | — |
Returns
plus(x: NerdamerInput): CollectionMethodNo description is available yet.
Parameters
| Name | Type | Description |
|---|---|---|
x | NerdamerInput | — |
Returns
pow(x: NerdamerInput): CollectionMethodNo description is available yet.
Parameters
| Name | Type | Description |
|---|---|---|
x | NerdamerInput | — |
Returns
precision: numberPropertyNo description is available yet.
simplify(): CollectionMethodNo description is available yet.
Returns
subst(value: ExpressionInput, withValue: ExpressionInput): CollectionMethodNo description is available yet.
Parameters
| Name | Type | Description |
|---|---|---|
value | ExpressionInput | — |
withValue | ExpressionInput | — |
Returns
symbolicAccessor: Expression[]PropertyPublic index expressions retained when bracket access cannot yet be resolved. This state belongs to a copied structured entity, never the stored source value.
symbolicTarget: ExpressionPropertyOriginal symbolic target used to render and later re-evaluate bracket access.
text(): stringMethodNo description is available yet.
Returns
string
times(x: NerdamerInput): CollectionMethodNo description is available yet.
Parameters
| Name | Type | Description |
|---|---|---|
x | NerdamerInput | — |
Returns
toString(): stringMethodNo description is available yet.
Returns
string
withSymbolicAccessor(target: Expression, indices: Expression[]): CollectionMethodReturns a copied structured entity carrying an unresolved bracket access. Existing accessor state is retained so chained symbolic access can be extended.
Parameters
| Name | Type | Description |
|---|---|---|
target | Expression | — |
indices | Expression[] | — |