Class SortContext<T>

A class for helping in complex sorting patterns.

Type Parameters

T

Hierarchy

SortContext
- KeySortedContext

Implements

Comparer<T>

Index

Constructors

Properties

_comparer _next _order

Accessors

comparison order

Methods

compare generateSortedIndexes

Constructors

constructor

new SortContext<T>(_next: null | Comparer<T>, _comparer: Comparison<T>, _order?: Order): SortContext<T>
Constructs a SortContext.
Type Parameters
- T
Parameters
- _next: null | Comparer<T>
  
  If provided (not null) any items that are considered equal will use this comparer to decided their order.
- _comparer: Comparison<T>
  
  The comparison function that will differentiate between items.
- _order: Order = Order.Ascending
  
  Ascending or Descending.
Returns SortContext<T>
- Defined in SortContext.ts:21

Properties

`Protected` _comparer

_comparer: Comparison<T>

The comparison function that will differentiate between items.

`Protected` _next

_next: null | Comparer<T>

If provided (not null) any items that are considered equal will use this comparer to decided their order.

`Protected` _order

_order: Order = Order.Ascending

Ascending or Descending.

Accessors

comparison

get comparison(): Comparison<T>
A scope safe comparison function (delegate).

Returns

Returns Comparison<T>
- Defined in SortContext.ts:43

order

get order(): Order
Direction of the comparison.

Returns Order
- Defined in SortContext.ts:32

Methods

compare

compare(a: T, b: T): number
Compares two values based upon SortContext parameters.

Returns
Parameters
- a: T
- b: T
Returns number
Implementation of Comparer.compare
- Defined in SortContext.ts:70

generateSortedIndexes

generateSortedIndexes(source: T[]): number[]
Generates an array of indexes from the source in order of their expected internalSort without modifying the source.

Returns
Parameters
- source: T[]
Returns number[]
- Defined in SortContext.ts:56

Generated using TypeDoc