Class LogootPosition

Hierarchy

Comparable<LogootPosition>
- LogootPosition

Index

Namespaces

JSON

Type aliases

Constructors

constructor

Properties

Accessors

Methods

Type aliases

Static JSON

JSON: [LogootInt.JSON, number | string][]

Static MappedOrderJSON

MappedOrderJSON: [LogootInt.JSON, number][]

Constructors

constructor

new LogootPosition(br: BranchKey, len?: number, start?: LogootPosition, end?: LogootPosition, branch_order?: BranchOrder): LogootPosition

- Defined in src/listmodel/position.ts:292
Parameters
- br: BranchKey
- Default value len: number = 0
- Optional start: LogootPosition
- Optional end: LogootPosition
- Optional branch_order: BranchOrder
Returns LogootPosition

Properties

Protected branch_array

branch_array: BranchKey[] = []

Readonly branch_order

branch_order: BranchOrder

Optional Readonly end

end: LogootPosition

Protected lp

lp: LogootishPosition = new LogootishPosition()

Optional Readonly start

start: LogootPosition

Accessors

length

get length(): number

- Defined in src/listmodel/position.ts:426
Returns number

levels

get levels(): number

- Defined in src/listmodel/position.ts:434
Returns the last index of the array. This is useful because before this, the algorithm code often contained many occurences of length - 1. This is used to cut down redundancy.

Returns number

Methods

cmp

cmp(pos: LogootPosition): CompareResult

Overrides Comparable.cmp
- Defined in src/listmodel/position.ts:490
Parameters
- pos: LogootPosition
Returns CompareResult

Private cmp_level

cmp_level(pos: LogootPosition, level: number): CompareResult

- Defined in src/listmodel/position.ts:460
Parameters
- pos: LogootPosition
- level: number
Returns CompareResult

copy

copy(): LogootPosition

- Defined in src/listmodel/position.ts:405
Returns LogootPosition

eq

eq(n: LogootPosition): boolean

Inherited from Comparable.eq
- Defined in src/compare.ts:59
Parameters
- n: LogootPosition
Returns boolean

True if this object is equal to the one provided.

equalsHigherLevel

equalsHigherLevel(to: LogootPosition): boolean

- Defined in src/listmodel/position.ts:520
Parameters
- to: LogootPosition
Returns boolean

gt

gt(n: LogootPosition): boolean

Inherited from Comparable.gt
- Defined in src/compare.ts:47
Parameters
- n: LogootPosition
Returns boolean

True if this object is greater than the one provided.

gteq

gteq(n: LogootPosition): boolean

Inherited from Comparable.gteq
- Defined in src/compare.ts:53
Parameters
- n: LogootPosition
Returns boolean

True if this object is greater than or equal to the one provided.

inverseOffsetLowest

inverseOffsetLowest(n: number): LogootPosition

- Defined in src/listmodel/position.ts:502
Parameters
- n: number
Returns LogootPosition

iterator

iterator(): IterableIterator<[LogootInt, BranchKey]>

- Defined in src/listmodel/position.ts:441
Returns IterableIterator<[LogootInt, BranchKey]>

l

l(l: number): [LogootInt, BranchKey]

- Defined in src/listmodel/position.ts:494
Parameters
- l: number
Returns [LogootInt, BranchKey]

lt

lt(n: LogootPosition): boolean

Inherited from Comparable.lt
- Defined in src/compare.ts:71
Parameters
- n: LogootPosition
Returns boolean

True if this object is less than the one provided.

lteq

lteq(n: LogootPosition): boolean

Inherited from Comparable.lteq
- Defined in src/compare.ts:65
Parameters
- n: LogootPosition
Returns boolean

True if this object is less than or equal to the one provided.

offsetLowest

offsetLowest(n: number): LogootPosition

- Defined in src/listmodel/position.ts:497
Parameters
- n: number
Returns LogootPosition

selfTest

selfTest(): void

- Defined in src/listmodel/position.ts:418
Returns void

toJSON

toJSON(): JSON

- Defined in src/listmodel/position.ts:524
Returns JSON

toMappedOrderJSON

toMappedOrderJSON(order: BranchOrder): MappedOrderJSON

- Defined in src/listmodel/position.ts:535
Parameters
- order: BranchOrder
Returns MappedOrderJSON

toString

toString(): string

- Defined in src/listmodel/position.ts:542
Returns string

truncateTo

truncateTo(level: number): LogootPosition

- Defined in src/listmodel/position.ts:508
Parameters
- level: number
Returns LogootPosition

Static fromIntsBranches

fromIntsBranches(order: BranchOrder, ...els: [number | LogootInt, BranchKey][]): LogootPosition

- Defined in src/listmodel/position.ts:395
Parameters
- order: BranchOrder
- Rest ...els: [number | LogootInt, BranchKey][]
Returns LogootPosition

Generated using TypeDoc