Optional
options: AbstractBinaryTreeOptionsThe options
parameter is an optional object that can be passed to the
constructor of the BinaryTree
class. It allows you to customize the behavior of the binary tree by providing
different configuration options.
Performs a breadth-first search (BFS) on a binary tree, accumulating properties of each node based on their 'id' property.
An array of binary tree node IDs.
Performs a breadth-first search (BFS) on a binary tree, accumulating properties of each node based on the specified property name.
The name of the property to accumulate.
An array of values corresponding to the specified property.
Performs a breadth-first search (BFS) on a binary tree, accumulating the 'val' property of each node.
The name of the property to accumulate.
An array of 'val' properties from each node.
Performs a breadth-first search (BFS) on a binary tree, accumulating nodes themselves.
The name of the property to accumulate.
An array of binary tree nodes.
Performs a depth-first search (DFS) traversal on a binary tree and accumulates properties of each node based on their 'id' property.
An array of binary tree node IDs.
Performs a depth-first search (DFS) traversal on a binary tree and accumulates properties of each node based on the specified property name.
Optional
pattern: DFSOrderPatternThe traversal pattern: 'in' (in-order), 'pre' (pre-order), or 'post' (post-order).
Optional
nodeOrPropertyName: "id"The name of the property to accumulate.
An array of values corresponding to the specified property.
Performs a depth-first search (DFS) traversal on a binary tree and accumulates the 'val' property of each node.
Optional
pattern: DFSOrderPatternThe traversal pattern: 'in' (in-order), 'pre' (pre-order), or 'post' (post-order).
Optional
nodeOrPropertyName: "val"The name of the property to accumulate.
An array of 'val' properties from each node.
Performs a depth-first search (DFS) traversal on a binary tree and accumulates nodes themselves.
Optional
pattern: DFSOrderPatternThe traversal pattern: 'in' (in-order), 'pre' (pre-order), or 'post' (post-order).
Optional
nodeOrPropertyName: "node"The name of the property to accumulate.
An array of binary tree nodes.
Performs an iterative depth-first search (DFS) traversal on a binary tree and accumulates properties of each node based on their 'id' property.
An array of binary tree node IDs.
Performs an iterative depth-first search (DFS) traversal on a binary tree and accumulates properties of each node based on the specified property name.
Optional
pattern: DFSOrderPatternThe traversal pattern: 'in' (in-order), 'pre' (pre-order), or 'post' (post-order).
Optional
nodeOrPropertyName: "id"The name of the property to accumulate.
An array of values corresponding to the specified property.
Performs an iterative depth-first search (DFS) traversal on a binary tree and accumulates the 'val' property of each node.
Optional
pattern: DFSOrderPatternThe traversal pattern: 'in' (in-order), 'pre' (pre-order), or 'post' (post-order).
Optional
nodeOrPropertyName: "val"The name of the property to accumulate.
An array of 'val' properties from each node.
Performs an iterative depth-first search (DFS) traversal on a binary tree and accumulates nodes themselves.
Optional
pattern: DFSOrderPatternThe traversal pattern: 'in' (in-order), 'pre' (pre-order), or 'post' (post-order).
Optional
nodeOrPropertyName: "node"The name of the property to accumulate.
An array of binary tree nodes.
Protected
_accumulatedThe function _accumulatedByPropertyName
accumulates values from a given node based on the specified property name.
The node
parameter is of type N
, which represents a node in a data structure.
Optional
nodeOrPropertyName: NodeOrPropertyNameThe nodeOrPropertyName
parameter is an optional parameter that
can be either a string representing a property name or a reference to a Node
object. If it is a string, it
specifies the property name to be used for accumulating values. If it is a Node
object, it specifies
Protected
_addThe function adds a new node to a binary tree if there is an available position.
The newNode
parameter is of type N | null
, which means it can either be a node of
type N
or null
. It represents the node that you want to add to the binary tree.
The parent parameter is of type N, which represents a node in a binary tree.
either the left or right child node of the parent node, depending on which child is available for adding the new node. If a new node is added, the function also updates the size of the binary tree. If neither the left nor right child is available, the function returns undefined. If the parent node is null, the function also returns undefined.
Protected
_clearProtected
_getThe function _getResultByPropertyName
returns the corresponding property value based on the given node or property
name.
Optional
nodeOrPropertyName: NodeOrPropertyNameThe parameter nodeOrPropertyName
is an optional parameter that
can accept either a NodeOrPropertyName
type or be undefined.
The method _getResultByPropertyName
returns an instance of AbstractBinaryTreeNodeProperties<N>
.
Protected
_pushThe function checks if a given property of a binary tree node matches a specified value, and if so, adds the node to a result array.
The current node being processed.
An array that stores the matching nodes.
The nodeProperty
parameter is either a BinaryTreeNodeId
or a N
type. It represents the property value that we are comparing against in the switch statement.
Optional
propertyName: BinaryTreeNodePropertyNameThe propertyName
parameter is an optional parameter that
specifies the property name to compare against when pushing nodes into the result
array. It can be either 'id'
or 'val'
. If it is not provided or is not equal to 'id'
or 'val'
, the
Optional
onlyOne: booleanThe onlyOne
parameter is an optional boolean parameter that determines whether to
stop after finding the first matching node or continue searching for all matching nodes. If onlyOne
is set to
true
, the function will stop after finding the first matching node and return true
. If `onlyOne
a boolean value indicating whether only one matching node should be pushed into the result array.
Protected
_setThe function sets the loop type for a protected variable.
The value parameter is of type LoopType.
Protected
_setProtected
_setProtected
_setProtected
_setProtected
_setProtected
_setThe add
function adds a new node to a binary tree, either by ID or by creating a new node with a given value.
The idOrNode
parameter can be either a BinaryTreeNodeId
, which
is a number representing the ID of a binary tree node, or it can be a N
object, which represents a binary tree
node itself. It can also be null
if no node is specified.
Optional
val: N["val"]The val
parameter is an optional value that can be assigned to the val
property of the new node
being added to the binary tree.
The function add
returns either the inserted node (N
), null
, or undefined
.
The addMany
function takes an array of binary tree node IDs or nodes, and optionally an array of corresponding data
values, and adds them to the binary tree.
An array of BinaryTreeNodeId or BinaryTreeNode objects, or null values.
Optional
data: N["val"][]The data
parameter is an optional array of values (N['val'][]
) that corresponds to
the nodes or node IDs being added. It is used to set the value of each node being added. If data
is not provided,
the value of the nodes will be undefined
.
The function addMany
returns an array of N
, null
, or undefined
values.
The function creates a new binary tree node with an optional value.
The id
parameter is the identifier for the binary tree node. It is of type
BinaryTreeNodeId
, which represents the unique identifier for each node in the binary tree.
Optional
val: N["val"]The val
parameter is an optional value that can be assigned to the node. It represents the value
stored in the node.
a new instance of a BinaryTreeNode with the specified id and value.
The fill
function clears the binary tree and adds multiple nodes with the given IDs or nodes and optional data.
The idsOrNodes
parameter is an array that can contain either
BinaryTreeNodeId
or N
values.
Optional
data: N["val"][] | N[]The data
parameter is an optional array of values that will be assigned to
the nodes being added. If provided, the length of the data
array should be equal to the length of the idsOrNodes
array. Each value in the data
array will be assigned to the
The method is returning a boolean value.
The function returns the first node that matches the given property name and value, or null if no matching node is found.
The nodeProperty
parameter can be either a BinaryTreeNodeId
or N
.
It represents the property of the binary tree node that you want to search for.
Optional
propertyName: BinaryTreeNodePropertyNameThe propertyName
parameter is an optional parameter that
specifies the property name to be used for searching the binary tree nodes. If this parameter is not provided, the
default value is set to 'id'
.
either the value of the specified property of the node, or the node itself if no property name is provided. If no matching node is found, it returns null.
The getHeight
function calculates the maximum height of a binary tree, either recursively or iteratively.
Optional
beginRoot: null | number | NThe beginRoot
parameter is optional and can be of type N
(a
generic type representing a node in a binary tree), BinaryTreeNodeId
(a type representing the ID of a binary tree
node), or null
.
the height of the binary tree.
The function getLeftMost
returns the leftmost node in a binary tree, starting from a specified node or the root if
no node is specified.
generic type representing a node in a binary tree), BinaryTreeNodeId
(a type representing the ID of a binary tree
node), or null
.
The function getLeftMost
returns the leftmost node in a binary tree. If the beginRoot
parameter is
provided, it starts the traversal from that node. If beginRoot
is not provided or is null
, it starts the traversal
from the root of the binary tree. The function returns the leftmost node found during the traversal. If no leftmost
node is found (
The function getLeftMost
returns the leftmost node in a binary tree, starting from a specified node or the root if
no node is specified.
Optional
node: NThe beginRoot
parameter is optional and can be of type N
(a
generic type representing a node in a binary tree), BinaryTreeNodeId
(a type representing the ID of a binary tree
node).
The function getLeftMost
returns the leftmost node in a binary tree. If the beginRoot
parameter is
provided, it starts the traversal from that node. If beginRoot
is not provided or is null
, it starts the traversal
from the root of the binary tree. The function returns the leftmost node found during the traversal. If no leftmost
node is found (
The getMinHeight
function calculates the minimum height of a binary tree using either a recursive or iterative
approach.
Optional
beginRoot: null | NThe beginRoot
parameter is an optional parameter of type N
or null
. It
represents the starting node from which to calculate the minimum height of a binary tree. If no value is provided
for beginRoot
, the this.root
property is used as the default value.
The function getMinHeight
returns the minimum height of the binary tree.
The function getNodes
returns an array of nodes that match a given property name and value in a binary tree.
The nodeProperty
parameter can be either a BinaryTreeNodeId
or a
generic type N
. It represents the property of the binary tree node that you want to search for.
Optional
propertyName: BinaryTreeNodePropertyNameThe propertyName
parameter is an optional parameter that
specifies the property name to use when searching for nodes. If not provided, it defaults to 'id'.
Optional
onlyOne: booleanThe onlyOne
parameter is an optional boolean parameter that determines whether to
return only one node that matches the given nodeProperty
or propertyName
. If onlyOne
is set to true
, the
function will stop traversing the tree and return the first matching node. If `only
an array of nodes (type N).
The function getPathToRoot
returns an array of nodes representing the path from a given node to the root node, with
an option to reverse the order of the nodes.
The node
parameter represents a node in a tree structure. It is of type N
, which could be any
type that represents a node in your specific implementation.
Optional
isReverse: boolean = trueThe isReverse
parameter is a boolean flag that determines whether the resulting
path should be reversed or not. If isReverse
is set to true
, the path will be reversed before returning it. If
isReverse
is set to false
or not provided, the path will
The function getPathToRoot
returns an array of nodes (N[]
).
The getRightMost
function returns the rightmost node in a binary tree, either recursively or iteratively using tail
recursion optimization.
The getRightMost
function returns the rightmost node in a binary tree. It returns the
rightmost node starting from the root of the binary tree.
The getRightMost
function returns the rightmost node in a binary tree, either recursively or iteratively using tail
recursion optimization.
Optional
node: NThe node
parameter is an optional parameter of type N
or null
. It represents the
starting node from which we want to find the rightmost node. If no node is provided, the function will default to
using the root node of the data structure.
The getRightMost
function returns the rightmost node in a binary tree. It returns the rightmost node
starting from that node.
The function calculates the size of a subtree by traversing it either recursively or iteratively.
The subTreeRoot
parameter represents the root node of a subtree in a
binary tree.
the size of the subtree rooted at subTreeRoot
.
The function checks if a binary tree node has a specific property.
The nodeProperty
parameter can be either a BinaryTreeNodeId
or N
.
It represents the property of the binary tree node that you want to check.
Optional
propertyName: BinaryTreeNodePropertyNameThe propertyName
parameter is an optional parameter that
specifies the name of the property to be checked in the nodes. If not provided, it defaults to 'id'.
a boolean value.
The function checks if a binary tree is perfectly balanced by comparing the minimum height and the height of the tree.
Optional
beginRoot: null | NThe parameter beginRoot
is of type N
or null
. It represents the root node of a
tree or null if the tree is empty.
The method is returning a boolean value.
Performs a level-order traversal on a binary tree starting from the specified node and accumulates properties of each node based on their 'id' property.
The starting node for the level order traversal. If null, the root node of the tree is used as the starting node.
An array of binary tree node IDs.
Performs a level-order traversal on a binary tree starting from the specified node and accumulates properties of each node based on the specified property name.
The starting node for the level order traversal. If null, the root node of the tree is used as the starting node.
Optional
nodeOrPropertyName: "id"The name of the property to accumulate.
An array of values corresponding to the specified property.
Performs a level-order traversal on a binary tree starting from the specified node and accumulates the 'val' property of each node.
The starting node for the level order traversal. If null, the root node of the tree is used as the starting node.
Optional
nodeOrPropertyName: "val"The name of the property to accumulate.
An array of 'val' properties from each node.
Performs a level-order traversal on a binary tree starting from the specified node and accumulates nodes themselves.
The starting node for the level order traversal. If null, the root node of the tree is used as the starting node.
Optional
nodeOrPropertyName: "node"The name of the property to accumulate.
An array of binary tree nodes.
Collects nodes from a binary tree by a specified property and organizes them into levels.
The root node of the binary tree or null. If null, the function will use the root node of the current binary tree instance.
A 2D array of AbstractBinaryTreeNodeProperty
Collects nodes from a binary tree by a specified property and organizes them into levels.
The root node of the binary tree or null. If null, the function will use the root node of the current binary tree instance.
Optional
nodeOrPropertyName: "id"Collects nodes from a binary tree by a specified property and organizes them into levels.
The root node of the binary tree or null. If null, the function will use the root node of the current binary tree instance.
Optional
nodeOrPropertyName: "val"The property of the BinaryTreeNode object to collect at each level.
A 2D array of 'val' properties from each node.
Collects nodes from a binary tree by a specified property and organizes them into levels.
The root node of the binary tree or null. If null, the function will use the root node of the current binary tree instance.
Optional
nodeOrPropertyName: "node"The property of the BinaryTreeNode object to collect at each level.
A 2D array of binary tree nodes.
Performs an in-order, pre-order, or post-order traversal on a binary tree using the Morris traversal algorithm.
An array of binary tree node IDs.
Performs an in-order, pre-order, or post-order traversal on a binary tree using the Morris traversal algorithm and accumulates properties of each node based on the specified property name.
Optional
pattern: DFSOrderPatternThe traversal pattern: 'in' (in-order), 'pre' (pre-order), or 'post' (post-order).
Optional
nodeOrPropertyName: "id"The name of the property to accumulate.
An array of values corresponding to the specified property.
Performs an in-order, pre-order, or post-order traversal on a binary tree using the Morris traversal algorithm and accumulates the 'val' property of each node.
Optional
pattern: DFSOrderPatternThe traversal pattern: 'in' (in-order), 'pre' (pre-order), or 'post' (post-order).
Optional
nodeOrPropertyName: "val"The property of the BinaryTreeNode object to collect at each level.
An array of 'val' properties from each node.
Performs an in-order, pre-order, or post-order traversal on a binary tree using the Morris traversal algorithm and accumulates nodes themselves.
Optional
pattern: DFSOrderPatternThe traversal pattern: 'in' (in-order), 'pre' (pre-order), or 'post' (post-order).
Optional
nodeOrPropertyName: "node"The property of the BinaryTreeNode object to collect at each level.
An array of binary tree nodes.
The remove
function removes a node from a binary search tree and returns the deleted node along with the parent node
that needs to be balanced.
The nodeOrId
parameter can be either a node object (N
) or a binary tree
node ID (BinaryTreeNodeId
).
Optional
isUpdateAllLeftSum: booleanThe isUpdateAllLeftSum
parameter is an optional boolean parameter that
determines whether to update the left sum of all nodes in the binary tree after removing a node. If
isUpdateAllLeftSum
is set to true
, the left sum of all nodes will be updated. If it
The function remove
returns an array of BinaryTreeDeletedResult<N>
objects.
The function subTreeAdd
adds a delta value to a specified property of each node in a subtree.
The subTreeRoot
parameter represents the root node of a binary
tree or the ID of a node in the binary tree. It can also be null
if there is no subtree to add to.
The delta
parameter is a number that represents the amount by which the property value of
each node in the subtree should be incremented.
Optional
propertyName: BinaryTreeNodePropertyNameThe propertyName
parameter is an optional parameter that
specifies the property of the binary tree node that should be modified. If not provided, it defaults to 'id'.
a boolean value.
The function subTreeSum
calculates the sum of a specified property in a binary tree or subtree.
The subTreeRoot
parameter represents the root node of a binary
tree or the ID of a binary tree node. It can also be null
if there is no subtree.
Optional
propertyName: BinaryTreeNodePropertyNamepropertyName is an optional parameter that specifies the property of the binary tree node to use for calculating the sum. It can be either 'id' or 'val'. If propertyName is not provided, it defaults to 'id'.
a number, which is the sum of the values of the specified property in the subtree rooted at subTreeRoot
.
The swapLocation
function swaps the location of two nodes in a binary tree.
The source node that you want to swap with the destination node.
The destNode
parameter represents the destination node where the values from srcNode
will
be swapped to.
The destNode
is being returned.
Generated using TypeDoc
This is a constructor function for a binary tree class that takes an optional options parameter.