IterableElementBase
data-structure-typed / IterableElementBase
Abstract Class: IterableElementBase<E, R>
Defined in: data-structures/base/iterable-element-base.ts:15
Base class that makes a data structure iterable and provides common element-wise utilities (e.g., map/filter/reduce/find).
Remarks
This class implements the JavaScript iteration protocol (via Symbol.iterator)
and offers array-like helpers with predictable time/space complexity.
Extended by
Type Parameters
E
E
The public element type yielded by the structure.
R
R
The underlying "raw" element type used internally or by converters.
Implements
Iterable<E>
Constructors
toElementFn
Get Signature
get toElementFn(): ((rawElement) => E) | undefined;
Defined in: data-structures/base/iterable-element-base.ts:48
Exposes the current toElementFn, if configured.
Remarks
Time O(1), Space O(1).
Returns
((rawElement) => E) | undefined
The converter function or undefined when not set.
Methods
[iterator]()
iterator: IterableIterator<E>;
Defined in: data-structures/base/iterable-element-base.ts:61
Returns an iterator over the structure's elements.
Parameters
args
...unknown[]
Optional iterator arguments forwarded to the internal iterator.
Returns
IterableIterator<E>
An IterableIterator<E> that yields the elements in traversal order.
Remarks
Producing the iterator is O(1); consuming the entire iterator is Time O(n) with O(1) extra space.
Implementation of
Iterable.[iterator]
clear()
abstract clear(): void;
Defined in: data-structures/base/iterable-element-base.ts:318
Removes all elements from the structure.
Returns
void
void.
Remarks
Expected Time O(1) or O(n) depending on the implementation; Space O(1).
clone()
abstract clone(): this;
Defined in: data-structures/base/iterable-element-base.ts:327
Creates a structural copy with the same element values and configuration.
Returns
this
A clone of the current instance (same concrete type).
Remarks
Expected Time O(n) to copy elements; Space O(n).
entries()
entries(): IterableIterator<[number, E]>;
Defined in: data-structures/base/iterable-element-base.ts:207
Return an iterator of [index, value] pairs (Array-compatible).
Returns
IterableIterator<[number, E]>
Remarks
Provided for familiarity when migrating from Array. Time O(n), Space O(1) per step.
every()
every(predicate, thisArg?): boolean;
Defined in: data-structures/base/iterable-element-base.ts:87
Tests whether all elements satisfy the predicate.
Parameters
predicate
ElementCallback<E, R, boolean>
Function invoked for each element with signature (value, index, self).
thisArg?
unknown
Optional this binding for the predicate.
Returns
boolean
true if every element passes; otherwise false.
Remarks
Time O(n) in the worst case; may exit early when the first failure is found. Space O(1).
filter()
abstract filter(predicate, thisArg?): this;
Defined in: data-structures/base/iterable-element-base.ts:370
Filters elements using the provided predicate and returns the same concrete structure type.
Parameters
predicate
ElementCallback<E, R, boolean>
Function with signature (value, index, self) => boolean.
thisArg?
unknown
Optional this binding for the predicate.
Returns
this
A new instance of the same concrete type containing only elements that pass the predicate.
Remarks
Time O(n), Space O(k) where k is the number of kept elements.
find()
Call Signature
find<S>(predicate, thisArg?): S | undefined;
Defined in: data-structures/base/iterable-element-base.ts:163
Finds the first element that satisfies the predicate and returns it.
Finds the first element of type S (a subtype of E) that satisfies the predicate and returns it.
Type Parameters
S
S
Parameters
predicate
ElementCallback<E, R, S>
Type-guard predicate: (value, index, self) => value is S.
thisArg?
unknown
Optional this binding for the predicate.
Returns
S | undefined
The matched element typed as S, or undefined if not found.
Remarks
Time O(n) in the worst case; may exit early on the first match. Space O(1).
Call Signature
find(predicate, thisArg?): E | undefined;
Defined in: data-structures/base/iterable-element-base.ts:164
Finds the first element that satisfies the predicate and returns it.
Finds the first element of type S (a subtype of E) that satisfies the predicate and returns it.
Parameters
predicate
ElementCallback<E, R, unknown>
Type-guard predicate: (value, index, self) => value is S.
thisArg?
unknown
Optional this binding for the predicate.
Returns
E | undefined
The matched element typed as S, or undefined if not found.
Remarks
Time O(n) in the worst case; may exit early on the first match. Space O(1).
forEach()
forEach(callbackfn, thisArg?): void;
Defined in: data-structures/base/iterable-element-base.ts:133
Invokes a callback for each element in iteration order.
Parameters
callbackfn
ElementCallback<E, R, void>
Function invoked per element with signature (value, index, self).
thisArg?
unknown
Optional this binding for the callback.
Returns
void
void.
Remarks
Time O(n), Space O(1).
has()
has(element): boolean;
Defined in: data-structures/base/iterable-element-base.ts:188
Checks whether a strictly-equal element exists in the structure.
Parameters
element
E
The element to test with === equality.
Returns
boolean
true if an equal element is found; otherwise false.
Remarks
Time O(n) in the worst case. Space O(1).
includes()
includes(element): boolean;
Defined in: data-structures/base/iterable-element-base.ts:199
Check whether a value exists (Array-compatible alias for has).
Parameters
element
E
Element to search for (uses ===).
Returns
boolean
true if found.
Remarks
Provided for familiarity when migrating from Array. Time O(n), Space O(1).
isEmpty()
abstract isEmpty(): boolean;
Defined in: data-structures/base/iterable-element-base.ts:309
Indicates whether the structure currently contains no elements.
Returns
boolean
true if empty; otherwise false.
Remarks
Expected Time O(1), Space O(1) for most implementations.
keys()
keys(): IterableIterator<number>;
Defined in: data-structures/base/iterable-element-base.ts:218
Return an iterator of numeric indices (Array-compatible).
Returns
IterableIterator<number>
Remarks
Provided for familiarity when migrating from Array. Time O(n), Space O(1) per step.
map()
abstract map<EM, RM>(
callback,
options?,
thisArg?): IterableElementBase<EM, RM>;
Defined in: data-structures/base/iterable-element-base.ts:342
Maps each element to a new element and returns a new iterable structure.
Type Parameters
EM
EM
The mapped element type.
RM
RM
The mapped raw element type used internally by the target structure.
Parameters
callback
ElementCallback<E, R, EM>
Function with signature (value, index, self) => mapped.
options?
IterableElementBaseOptions<EM, RM>
Optional options for the returned structure, including its toElementFn.
thisArg?
unknown
Optional this binding for the callback.
Returns
IterableElementBase<EM, RM>
A new IterableElementBase<EM, RM> containing mapped elements.
Remarks
Time O(n), Space O(n).
mapSame()
abstract mapSame(callback, thisArg?): this;
Defined in: data-structures/base/iterable-element-base.ts:358
Maps each element to the same element type and returns the same concrete structure type.
Parameters
callback
ElementCallback<E, R, E>
Function with signature (value, index, self) => mappedValue.
thisArg?
unknown
Optional this binding for the callback.
Returns
this
A new instance of the same concrete type with mapped elements.
Remarks
Time O(n), Space O(n).
print()
print(): void;
Defined in: data-structures/base/iterable-element-base.ts:298
Prints toVisual() to the console. Intended for quick debugging.
Returns
void
void.
Remarks
Time O(n) due to materialization, Space O(n) for the intermediate representation.
reduce()
Reduces all elements to a single accumulated value.
Param
Reducer of signature (acc, value, index, self) => nextAcc. The first element is used as the initial accumulator.
Param
Reducer of signature (acc, value, index, self) => nextAcc.
Param
The initial accumulator value of type E.
Template
The accumulator type when it differs from E.
Param
Reducer of signature (acc: U, value, index, self) => U.
Param
The initial accumulator value of type U.
Remarks
Time O(n), Space O(1). Throws if called on an empty structure without initialValue.
Call Signature
reduce(callbackfn): E;
Defined in: data-structures/base/iterable-element-base.ts:225
Parameters
callbackfn
ReduceElementCallback<E, R>
Returns
E
Call Signature
reduce(callbackfn, initialValue): E;
Defined in: data-structures/base/iterable-element-base.ts:226
Parameters
callbackfn
ReduceElementCallback<E, R>
initialValue
E
Returns
E
Call Signature
reduce<U>(callbackfn, initialValue): U;
Defined in: data-structures/base/iterable-element-base.ts:227
Type Parameters
U
U
Parameters
callbackfn
ReduceElementCallback<E, R, U>
initialValue
U
Returns
U
some()
some(predicate, thisArg?): boolean;
Defined in: data-structures/base/iterable-element-base.ts:110
Tests whether at least one element satisfies the predicate.
Parameters
predicate
ElementCallback<E, R, boolean>
Function invoked for each element with signature (value, index, self).
thisArg?
unknown
Optional this binding for the predicate.
Returns
boolean
true if any element passes; otherwise false.
Remarks
Time O(n) in the worst case; may exit early on first success. Space O(1).
toArray()
toArray(): E[];
Defined in: data-structures/base/iterable-element-base.ts:275
Materializes the elements into a new array.
Returns
E[]
A shallow array copy of the iteration order.
Remarks
Time O(n), Space O(n).
toVisual()
toVisual(): E[];
Defined in: data-structures/base/iterable-element-base.ts:287
Returns a representation of the structure suitable for quick visualization. Defaults to an array of elements; subclasses may override to provide richer visuals.
Returns
E[]
A visual representation (array by default).
Remarks
Time O(n), Space O(n).
values()
values(): IterableIterator<E>;
Defined in: data-structures/base/iterable-element-base.ts:72
Returns an iterator over the values (alias of the default iterator).
Returns
IterableIterator<E>
An IterableIterator<E> over all elements.
Remarks
Creating the iterator is O(1); full iteration is Time O(n), Space O(1).
Protected Members
Constructor
protected new IterableElementBase<E, R>(options?): IterableElementBase<E, R>;
Defined in: data-structures/base/iterable-element-base.ts:25
Create a new iterable base.
Parameters
options?
IterableElementBaseOptions<E, R>
Optional behavior overrides. When provided, a toElementFn
is used to convert a raw element (R) into a public element (E).
Returns
IterableElementBase<E, R>
Remarks
Time O(1), Space O(1).
Properties
_toElementFn?
protected optional _toElementFn?: (rawElement) => E;
Defined in: data-structures/base/iterable-element-base.ts:39
The converter used to transform a raw element (R) into a public element (E).
Parameters
rawElement
R
Returns
E
Remarks
Time O(1), Space O(1).
Accessors
_getIterator()
abstract protected _getIterator(...args): IterableIterator<E>;
Defined in: data-structures/base/iterable-element-base.ts:381
Internal iterator factory used by the default iterator.
Parameters
args
...unknown[]
Optional iterator arguments.
Returns
IterableIterator<E>
An iterator over elements.
Remarks
Implementations should yield in O(1) per element with O(1) extra space when possible.