CommonsBuilder | algorithms-ts

Contains factory functions for creating instances of commonly used ADTs.

Index

Functions

Functions

collectionFromArray

collectionFromArray<E>(array: E[], copyArray?: boolean): Collection<E>

- Defined in commons/builders.ts:29
Creates new instance of Collection that contains all items from the given array. The instance doesn't depends on underlying array, IOW changes in the array won't affect the container.

Type parameters
- E
Parameters
- array: E[]
  
  array to copy items from.
- Default value copyArray: boolean = true
  
  defines either elements from given array will be copied into the result collection or given array will be reused by the collection. Be aware that in the second case changes in the array mean changes in the collection. By default it copies the array.
Returns Collection<E>

new instance of Collection.

emptyCollection

emptyCollection<E>(): Collection<E>

- Defined in commons/builders.ts:16
Creates new instance of empty Collection.

Type parameters
- E
Returns Collection<E>

new instance of empty Collection.

numberComparator

numberComparator(left: number, right: number): Ordering

- Defined in commons/builders.ts:36
Compares two numbers. Uses default comparison operators.

Parameters
- left: number
- right: number
Returns Ordering

stringComparator

stringComparator(left: string, right: string): Ordering

- Defined in commons/builders.ts:49
Compares two numbers. Uses default lexicographical string comparison.

Parameters
- left: string
- right: string
Returns Ordering

Generated using TypeDoc