Skip to content

Latest commit

 

History

History
276 lines (152 loc) · 4.83 KB

MAryTree.TreeNode.md

File metadata and controls

276 lines (152 loc) · 4.83 KB

Class: TreeNode<K, D>

MAryTree.TreeNode

Type parameters

Name Type
K TreeKey
D TreeData

Table of contents

Constructors

Properties

Accessors

Methods

Constructors

constructor

new TreeNode<K, D>(key, data, parent?)

TreeNode constructor

Type parameters

Name Type
K TreeKey
D TreeData

Parameters

Name Type Default value
key K undefined
data D undefined
parent TreeNode<K, D> null

Defined in

MAryTree.ts:40

Properties

children

children: TreeNode<K, D>[]

Memberof

TreeNode

Member

children array of child nodes

Defined in

MAryTree.ts:26


data

data: D

Memberof

TreeNode

Member

data information stored on node

Defined in

MAryTree.ts:16


key

key: K

Memberof

TreeNode

Member

key key for this node

Defined in

MAryTree.ts:11


leftNeighbor

leftNeighbor: TreeNode<K, D>

Memberof

TreeNode

Member

leftNeighbor reference to this nodes left neighbor

Defined in

MAryTree.ts:31


parent

parent: TreeNode<K, D>

Memberof

TreeNode

Member

parent reference to this nodes parent

Defined in

MAryTree.ts:21

Accessors

hasChildren

get hasChildren(): boolean

Returns true if this node has children.

Returns

boolean

Defined in

MAryTree.ts:88


isLeaf

get isLeaf(): boolean

Returns true if this node has no children.

Returns

boolean

Defined in

MAryTree.ts:80


leftSibling

get leftSibling(): TreeNode<K, D>

Returns the left sibling of this node if it exists.

Returns

TreeNode<K, D>

Defined in

MAryTree.ts:108


siblingIndex

get siblingIndex(): number

Returns the index of this node amoung its sibling nodes.

Returns

number

Defined in

MAryTree.ts:96

Methods

[iterator]

[iterator](): Generator<TreeNode<K, D>, void, unknown>

Returns

Generator<TreeNode<K, D>, void, unknown>

Defined in

MAryTree.ts:122


isDescendant

isDescendant(node?): boolean

Check if this node is a descendent of a parent.

Parameters

Name Type Default value Description
node TreeNode<K, D> null the parent node to check against

Returns

boolean

Defined in

MAryTree.ts:64


toJSON

toJSON(): Object

Returns

Object

Name Type
children TreeNode<K, D>[]
data D
key K
leftNeighbor K
parent K

Defined in

MAryTree.ts:48