Class Heap

The heap stores the function definition's root TreeNodes, for later use.

it stores error data and errorCallbacks for the nodejs API

it also stores line attributes

Hierarchy

Heap

Index

Constructors

constructor

new Heap(): Heap
Create a Heap instance

Returns Heap
- Defined in src/ludit/Heap/index.ts:49

Properties

data

data: Map<HeapSlot>

The stored function definitions

error

error: undefined | error

The error data, used for the Nodejs api

errorCall

errorCall: undefined | errorCall

The error callback, use for the Nodejs api

lineAttributes

lineAttributes: Map<attributes>

The attributes for each line, map keys are line numbers, values are arrays of specified attributes

`Static` emptyTree

emptyTree: TreeNode = ...

Create an empty TreeNode instance, acts as a placeholder

Methods

getAttributes

getAttributes(key: number): undefined | attributes
Get stored attributes at a line or row location

Returns
The attributes at a given line
Parameters
- key: number
Returns undefined | attributes
- Defined in src/ludit/Heap/index.ts:82

getProfile

getProfile(key: string, e?: error): string
Get a function definition's profile
Parameters
- key: string
  
  The function definition's name
- e: error = ...
  
  The error data in case one is thrown
Returns string
- Defined in src/ludit/Heap/index.ts:162

getTree

getTree(key: string, e?: error): TreeNode
Get a funciton definition's root TreeNode instance
Parameters
- key: string
  
  The function definition's name
- e: error = ...
  
  The error data in case one is thrown
Returns TreeNode
- Defined in src/ludit/Heap/index.ts:181

hasError

hasError(): boolean
Detect if the Heap instance has an error definition

Returns boolean
- Defined in src/ludit/Heap/index.ts:92

initSlot

initSlot(key: string): void
Instantiate a placeholder for a HeapSlot
Parameters
- key: string
  
  The function definition's name
Returns void
- Defined in src/ludit/Heap/index.ts:101

setAttributes

setAttributes(key: number, values: attribute[]): void
Store attributes for a line
Parameters
- key: number
  
  The line number
- values: attribute[]
  
  An array of the specified attributes
Returns void
- Defined in src/ludit/Heap/index.ts:67

setProfile

setProfile(key: string, profile: string): void
Set a profile for a function definition
Parameters
- key: string
  
  The function definition's name
- profile: string
  
  The function's profile
Returns void
- Defined in src/ludit/Heap/index.ts:116

setTree

setTree(key: string, tree: TreeNode): void
Set a root TreeNode instance for a function definition
Parameters
- key: string
  
  The function definition's name
- tree: TreeNode
  
  The root TreeNode instance of the function definition
Returns void
- Defined in src/ludit/Heap/index.ts:130

setValue

setValue(key: string, tree: TreeNode, profile: string): void
Set a HeapSlot value
Parameters
- key: string
  
  The function definition's name
- tree: TreeNode
  
  The function definition's root TreeNode instance
- profile: string
  
  The function's profile
Returns void
- Defined in src/ludit/Heap/index.ts:145

Class Heap

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns Heap

Properties

data

error

errorCall

lineAttributes

Static emptyTree

Methods

getAttributes

Returns

Parameters

key: number

Returns undefined | attributes

getProfile

Parameters

key: string

e: error = ...

Returns string

getTree

Parameters

key: string

e: error = ...

Returns TreeNode

hasError

Returns boolean

initSlot

Parameters

key: string

Returns void

setAttributes

Parameters

key: number

values: attribute[]

Returns void

setProfile

Parameters

key: string

profile: string

Returns void

setTree

Parameters

key: string

tree: TreeNode

Returns void

setValue

Parameters

key: string

tree: TreeNode

profile: string

Returns void

Settings

Member Visibility

Theme

`Static` emptyTree