Class NodeUtils

Index

Constructors

Methods

isContinuous isFromSameSentence isSorted sort sorted toSimpleString

Constructors

constructor

new NodeUtils(): NodeUtils
Returns NodeUtils

Methods

`Static`isContinuous

isContinuous<T extends Node<T>>(tokens: T[]): boolean
Checks if this list of nodes forms a continuous sequence. Assumes the nodes to be sorted and from the same sentence (not checked).
Type Parameters
- T extends Node<T>
Parameters
- tokens: T[]
  A list of nodes
Returns boolean
true if the list is continuous, false otherwise.
- Defined in g3/model/node.ts:262

`Static`isFromSameSentence

isFromSameSentence<T extends Node<T>>(tokens: T[]): boolean
Checks if all nodes come from the same sentence.
Type Parameters
- T extends Node<T>
Parameters
- tokens: T[]
  A list of nodes.
Returns boolean
true if the list of nodes is empty or all nodes are within the same sentence; false otherwise.
- Defined in g3/model/node.ts:247

`Static`isSorted

isSorted<T extends Node<T>>(tokens: T[]): boolean
Checks if this list of nodes is sorted by word-order (i.e. their sentence index).
Type Parameters
- T extends Node<T>
Parameters
- tokens: T[]
  A list of nodes, assumed to be from the same sentenced (not checked).
Returns boolean
- Defined in g3/model/node.ts:238

`Static`sort

sort<T extends Node<T>>(tokens: T[]): T[]
Orders the list of nodes in-place by word-order (i.e. their sentence index).
Type Parameters
- T extends Node<T>
Parameters
- tokens: T[]
  A list of nodes, assumed to be from the same sentence (not checked).
Returns T[]
- Defined in g3/model/node.ts:222

`Static`sorted

sorted<T extends Node<T>>(tokens: T[]): T[]
Orders a copy of this list of nodes by word-order (i.e. their sentence index).
Type Parameters
- T extends Node<T>
Parameters
- tokens: T[]
  A list of nodes, assumed to be from the same sentenced (not checked).
Returns T[]
- Defined in g3/model/node.ts:230

`Static`toSimpleString

toSimpleString<T extends Node<T>>(tokens: T[], quote?: boolean): string
Utility method converting this list of nodes to a string with a simplified node representation, using [Node.toSimpleString].
Type Parameters
- T extends Node<T>
Parameters
- tokens: T[]
  A list of nodes.
- quote: boolean = false
  Should each node string be surrounded with double quotes?
Returns string
- Defined in g3/model/node.ts:272