Optional options: BSTOptionsAn optional object that contains configuration options for the binary search tree.
Protected _comparatorThe BFS function performs a breadth-first search on a binary tree, accumulating properties of each node based on a specified property name.
an instance of the AbstractBinaryTreeNodeProperties class with generic type N.
The BFS function performs a breadth-first search on a binary tree, accumulating properties of each node based on a specified property name.
The parameter nodeOrPropertyName is an optional parameter that
represents either a node or a property name. If a node is provided, the breadth-first search (BFS) algorithm will be
performed starting from that node. If a property name is provided, the BFS algorithm will be performed starting from
the
an instance of the AbstractBinaryTreeNodeProperties class with generic type N.
The BFS function performs a breadth-first search on a binary tree, accumulating properties of each node based on a specified property name.
The parameter nodeOrPropertyName is an optional parameter that
represents either a node or a property name. If a node is provided, the breadth-first search (BFS) algorithm will be
performed starting from that node. If a property name is provided, the BFS algorithm will be performed starting from
the
an instance of the AbstractBinaryTreeNodeProperties class with generic type N.
The BFS function performs a breadth-first search on a binary tree, accumulating properties of each node based on a specified property name.
The parameter nodeOrPropertyName is an optional parameter that
represents either a node or a property name. If a node is provided, the breadth-first search (BFS) algorithm will be
performed starting from that node. If a property name is provided, the BFS algorithm will be performed starting from
the
an instance of the AbstractBinaryTreeNodeProperties class with generic type N.
The DFS function performs a depth-first search traversal on a binary tree and returns the accumulated properties of each node based on the specified pattern and property name.
an instance of the AbstractBinaryTreeNodeProperties class, which contains the accumulated properties of the binary tree nodes based on the specified pattern and node or property name.
The DFS function performs a depth-first search traversal on a binary tree and returns the accumulated properties of each node based on the specified pattern and property name.
Optional pattern: DFSOrderPatternThe "pattern" parameter is used to specify the traversal order of the binary tree. It can have three possible values:
Optional nodeOrPropertyName: "id"The nodeOrPropertyName parameter is a string that represents
the name of a property of the nodes in the binary tree. This property will be used to accumulate values during the
depth-first search traversal. If no nodeOrPropertyName is provided, the default value is 'id'.
an instance of the AbstractBinaryTreeNodeProperties class, which contains the accumulated properties of the binary tree nodes based on the specified pattern and node or property name.
The DFS function performs a depth-first search traversal on a binary tree and returns the accumulated properties of each node based on the specified pattern and property name.
Optional pattern: DFSOrderPatternThe "pattern" parameter is used to specify the traversal order of the binary tree. It can have three possible values:
Optional nodeOrPropertyName: "val"The nodeOrPropertyName parameter is a string that represents
the name of a property of the nodes in the binary tree. This property will be used to accumulate values during the
depth-first search traversal. If no nodeOrPropertyName is provided, the default value is 'id'.
an instance of the AbstractBinaryTreeNodeProperties class, which contains the accumulated properties of the binary tree nodes based on the specified pattern and node or property name.
The DFS function performs a depth-first search traversal on a binary tree and returns the accumulated properties of each node based on the specified pattern and property name.
Optional pattern: DFSOrderPatternThe "pattern" parameter is used to specify the traversal order of the binary tree. It can have three possible values:
Optional nodeOrPropertyName: "node"The nodeOrPropertyName parameter is a string that represents
the name of a property of the nodes in the binary tree. This property will be used to accumulate values during the
depth-first search traversal. If no nodeOrPropertyName is provided, the default value is 'id'.
an instance of the AbstractBinaryTreeNodeProperties class, which contains the accumulated properties of the binary tree nodes based on the specified pattern and node or property name.
The DFSIterative function performs an iterative depth-first search traversal on a binary tree, with the option to specify the traversal pattern and the property name to accumulate results by.
an object of type AbstractBinaryTreeNodeProperties
The DFSIterative function performs an iterative depth-first search traversal on a binary tree, with the option to specify the traversal pattern and the property name to accumulate results by.
Optional pattern: DFSOrderPatternThe "pattern" parameter determines the order in which the nodes of the binary tree are visited during the depth-first search. It can have one of the following values:
Optional nodeOrPropertyName: "id"The nodeOrPropertyName parameter is used to specify the
property of the nodes that you want to retrieve or perform operations on during the depth-first search traversal. By
default, it is set to 'id', which means that the traversal will accumulate results based on the id property of
the
an object of type AbstractBinaryTreeNodeProperties
The DFSIterative function performs an iterative depth-first search traversal on a binary tree, with the option to specify the traversal pattern and the property name to accumulate results by.
Optional pattern: DFSOrderPatternThe "pattern" parameter determines the order in which the nodes of the binary tree are visited during the depth-first search. It can have one of the following values:
Optional nodeOrPropertyName: "val"The nodeOrPropertyName parameter is used to specify the
property of the nodes that you want to retrieve or perform operations on during the depth-first search traversal. By
default, it is set to 'id', which means that the traversal will accumulate results based on the id property of
the
an object of type AbstractBinaryTreeNodeProperties
The DFSIterative function performs an iterative depth-first search traversal on a binary tree, with the option to specify the traversal pattern and the property name to accumulate results by.
Optional pattern: DFSOrderPatternThe "pattern" parameter determines the order in which the nodes of the binary tree are visited during the depth-first search. It can have one of the following values:
Optional nodeOrPropertyName: "node"The nodeOrPropertyName parameter is used to specify the
property of the nodes that you want to retrieve or perform operations on during the depth-first search traversal. By
default, it is set to 'id', which means that the traversal will accumulate results based on the id property of
the
an object of type AbstractBinaryTreeNodeProperties
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 _compareThe function compares two binary tree node IDs using a comparator function and returns whether the first ID is greater than, less than, or equal to the second ID.
a is a BinaryTreeNodeId, which represents the identifier of a binary tree node.
The parameter "b" in the above code refers to a BinaryTreeNodeId.
a value of type CP (ComparisonResult). The possible return values are CP.gt (greater than), CP.lt (less than), or CP.eq (equal).
Protected _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 search tree, either by creating a new node or by updating an existing
node with the same ID.
The idOrNode parameter can be either a BinaryTreeNodeId or a N
(which represents a binary tree node) or null.
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 search tree.
The function add returns the inserted node (inserted) which can be of type N, null, or undefined.
The addMany function overrides the base class method to add multiple nodes to a binary search tree in a balanced
manner.
The idsOrNodes parameter in the addMany function is an array of
BinaryTreeNodeId or N (node) objects, or null values. It represents the nodes or node IDs that need to be added
to the binary search tree.
Optional data: N["val"][]The values of tree nodes
If true the nodes will be balance inserted in binary search method.
The function addMany returns an array of N, null, or undefined values.
The allGreaterNodesAdd function adds a delta value to the specified property of all nodes in a binary tree that
have a greater value than a given node.
The node parameter can be either of type N (a generic type),
BinaryTreeNodeId, or null. It represents the node in the binary tree to which the delta value will be added.
The delta parameter is a number that represents the amount by which the property value of
each greater node should be increased.
Optional propertyName: BinaryTreeNodePropertyNameThe propertyName parameter is an optional parameter that
specifies the property name of the nodes in the binary tree that you want to update. If not provided, it defaults to
'id'.
a boolean value.
The function creates a new binary search tree node with the given id and value.
The id parameter is the identifier for the binary tree node. It is used to uniquely
identify 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
that will be stored in the node.
a new instance of the BSTNode class 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 in a binary tree that matches the given property name and value.
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 for searching the binary tree nodes. If not provided, it defaults to 'id'.
The method is returning either a BinaryTreeNodeId or N (generic type) or 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 getLeftMost function returns the leftmost node in a binary tree, starting from a specified node or the root if
no node is specified.
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. If there are no nodes in the binary tree, it returns null.
The getLeftMost function returns the leftmost node in a binary tree, starting from a specified node or the root if
no node is specified.
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. If there are no nodes in the binary tree, it returns null.
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 in a binary tree that match a given property value.
The nodeProperty parameter can be either a BinaryTreeNodeId or an
N type. It represents the property of the binary tree node that you want to compare with.
Optional propertyName: BinaryTreeNodePropertyName = 'id'The propertyName parameter is an optional parameter that
specifies the property name to use for comparison. 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 all nodes that match the nodeProperty. If onlyOne
is set to true, the function will return an array with only one node (if
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 function getRightMost returns the rightmost node (N) in a binary tree. If the node parameter is
not provided, it defaults to the root node of the tree. If the tree is empty or the node parameter is null, the
function returns null.
The getRightMost function returns the rightmost node in a binary tree, either recursively or iteratively using
tail recursion optimization.
The 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 node parameter defaults
to this.root, which is the root node of the data structure
The function getRightMost returns the rightmost node (N) in a binary tree. If the node parameter is
not provided, it defaults to the root node of the tree. If the tree is empty or the node parameter is null, the
function returns null.
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.
The function returns the id of the rightmost node if the comparison between two values is less than, the id of the leftmost node if the comparison is greater than, and the id of the rightmost node otherwise.
The method lastKey() returns the id of the rightmost node in the binary tree if the comparison between
the values at index 0 and 1 is less than, otherwise it returns the id of the leftmost node. If the comparison is
equal, it returns the id of the rightmost node. If there are no nodes in the tree, it returns 0.
The lesserSum function calculates the sum of property values in a binary tree for nodes that have a property value
less than a given node.
The beginNode parameter can be one of the following:
Optional propertyName: BinaryTreeNodePropertyNameThe propertyName parameter is an optional parameter that
specifies the property name to use for calculating the sum. If not provided, it defaults to 'id'.
The function lesserSum returns a number, which represents the sum of the values of the nodes in the
binary tree that have a lesser value than the specified beginNode based on the propertyName.
The levelIterative function performs a level-order traversal on a binary tree and returns the values of the nodes
in an array, based on a specified property name.
The node parameter is a BinaryTreeNode object representing the starting
node for the level order traversal. It can be null if no specific node is provided, in which case the root node of
the tree is used as the starting node.
The function levelIterative returns an object of type AbstractBinaryTreeNodeProperties<N>.
The levelIterative function performs a level-order traversal on a binary tree and returns the values of the nodes
in an array, based on a specified property name.
The node parameter is a BinaryTreeNode object representing the starting
node for the level order traversal. It can be null if no specific node is provided, in which case the root node of
the tree is used as the starting node.
Optional nodeOrPropertyName: "id"The nodeOrPropertyName parameter is an optional parameter that
can be either a BinaryTreeNode property name or the string 'id'. If a property name is provided, the function
will accumulate results based on that property. If no property name is provided, the function will default to
accumulating results
The function levelIterative returns an object of type AbstractBinaryTreeNodeProperties<N>.
The levelIterative function performs a level-order traversal on a binary tree and returns the values of the nodes
in an array, based on a specified property name.
The node parameter is a BinaryTreeNode object representing the starting
node for the level order traversal. It can be null if no specific node is provided, in which case the root node of
the tree is used as the starting node.
Optional nodeOrPropertyName: "val"The nodeOrPropertyName parameter is an optional parameter that
can be either a BinaryTreeNode property name or the string 'id'. If a property name is provided, the function
will accumulate results based on that property. If no property name is provided, the function will default to
accumulating results
The function levelIterative returns an object of type AbstractBinaryTreeNodeProperties<N>.
The levelIterative function performs a level-order traversal on a binary tree and returns the values of the nodes
in an array, based on a specified property name.
The node parameter is a BinaryTreeNode object representing the starting
node for the level order traversal. It can be null if no specific node is provided, in which case the root node of
the tree is used as the starting node.
Optional nodeOrPropertyName: "node"The nodeOrPropertyName parameter is an optional parameter that
can be either a BinaryTreeNode property name or the string 'id'. If a property name is provided, the function
will accumulate results based on that property. If no property name is provided, the function will default to
accumulating results
The function levelIterative returns an object of type AbstractBinaryTreeNodeProperties<N>.
The listLevels function collects nodes from a binary tree by a specified property and organizes them into levels.
The node parameter is a BinaryTreeNode object or null. It represents the
root node of a binary tree. If it is null, the function will use the root node of the current binary tree instance.
The function listLevels returns a 2D array of AbstractBinaryTreeNodeProperty<N> objects.
The listLevels function collects nodes from a binary tree by a specified property and organizes them into levels.
The node parameter is a BinaryTreeNode object or null. It represents the
root node of a binary tree. If it is null, the function will use the root node of the current binary tree instance.
Optional nodeOrPropertyName: "id"The nodeOrPropertyName parameter is an optional parameter that
specifies the property of the BinaryTreeNode object to collect at each level. It can be one of the following
values:
The function listLevels returns a 2D array of AbstractBinaryTreeNodeProperty<N> objects.
The listLevels function collects nodes from a binary tree by a specified property and organizes them into levels.
The node parameter is a BinaryTreeNode object or null. It represents the
root node of a binary tree. If it is null, the function will use the root node of the current binary tree instance.
Optional nodeOrPropertyName: "val"The nodeOrPropertyName parameter is an optional parameter that
specifies the property of the BinaryTreeNode object to collect at each level. It can be one of the following
values:
The function listLevels returns a 2D array of AbstractBinaryTreeNodeProperty<N> objects.
The listLevels function collects nodes from a binary tree by a specified property and organizes them into levels.
The node parameter is a BinaryTreeNode object or null. It represents the
root node of a binary tree. If it is null, the function will use the root node of the current binary tree instance.
Optional nodeOrPropertyName: "node"The nodeOrPropertyName parameter is an optional parameter that
specifies the property of the BinaryTreeNode object to collect at each level. It can be one of the following
values:
The function listLevels returns a 2D array of AbstractBinaryTreeNodeProperty<N> objects.
The morris function performs an in-order, pre-order, or post-order traversal on a binary tree using the Morris
traversal algorithm.
an array of AbstractBinaryTreeNodeProperties
The morris function performs an in-order, pre-order, or post-order traversal on a binary tree using the Morris
traversal algorithm.
Optional pattern: DFSOrderPatternThe pattern parameter determines the traversal pattern for the binary
tree. It can have one of three values:
Optional nodeOrPropertyName: "id"The nodeOrPropertyName parameter is used to specify the
property name of the nodes that you want to retrieve. It can be any valid property name of the nodes in the binary
tree.
an array of AbstractBinaryTreeNodeProperties
The morris function performs an in-order, pre-order, or post-order traversal on a binary tree using the Morris
traversal algorithm.
Optional pattern: DFSOrderPatternThe pattern parameter determines the traversal pattern for the binary
tree. It can have one of three values:
Optional nodeOrPropertyName: "val"The nodeOrPropertyName parameter is used to specify the
property name of the nodes that you want to retrieve. It can be any valid property name of the nodes in the binary
tree.
an array of AbstractBinaryTreeNodeProperties
Time complexity is O(n) Space complexity of Iterative DFS equals to recursive DFS which is O(n) because of the stack
Optional pattern: DFSOrderPatternOptional nodeOrPropertyName: "node"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
The constructor function initializes a binary search tree object with an optional comparator function.