Added doctest to binary_search_tree.py (#11141)

* Added doctest to binary_search_tree.py

* Update binary_search_tree.py

* Update binary_search_tree.py

---------

Co-authored-by: Christian Clauss <cclauss@me.com>
This commit is contained in:
Suyash Dongre 2023-11-05 14:08:39 +05:30 committed by GitHub
parent 257cfbdf6e
commit 1e50cf3660
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -10,8 +10,7 @@ Example
/ \ / / \ /
4 7 13 4 7 13
>>> t = BinarySearchTree() >>> t = BinarySearchTree().insert(8, 3, 6, 1, 10, 14, 13, 4, 7)
>>> t.insert(8, 3, 6, 1, 10, 14, 13, 4, 7)
>>> print(" ".join(repr(i.value) for i in t.traversal_tree())) >>> print(" ".join(repr(i.value) for i in t.traversal_tree()))
8 3 1 6 4 7 10 14 13 8 3 1 6 4 7 10 14 13
@ -40,7 +39,16 @@ Other example:
>>> testlist = (8, 3, 6, 1, 10, 14, 13, 4, 7) >>> testlist = (8, 3, 6, 1, 10, 14, 13, 4, 7)
>>> t = BinarySearchTree() >>> t = BinarySearchTree()
>>> for i in testlist: >>> for i in testlist:
... t.insert(i) ... t.insert(i) # doctest: +ELLIPSIS
BinarySearchTree(root=8)
BinarySearchTree(root={'8': (3, None)})
BinarySearchTree(root={'8': ({'3': (None, 6)}, None)})
BinarySearchTree(root={'8': ({'3': (1, 6)}, None)})
BinarySearchTree(root={'8': ({'3': (1, 6)}, 10)})
BinarySearchTree(root={'8': ({'3': (1, 6)}, {'10': (None, 14)})})
BinarySearchTree(root={'8': ({'3': (1, 6)}, {'10': (None, {'14': (13, None)})})})
BinarySearchTree(root={'8': ({'3': (1, {'6': (4, None)})}, {'10': (None, {'14': ...
BinarySearchTree(root={'8': ({'3': (1, {'6': (4, 7)})}, {'10': (None, {'14': (13, ...
Prints all the elements of the list in order traversal Prints all the elements of the list in order traversal
>>> print(t) >>> print(t)
@ -84,7 +92,7 @@ from __future__ import annotations
from collections.abc import Iterable, Iterator from collections.abc import Iterable, Iterator
from dataclasses import dataclass from dataclasses import dataclass
from typing import Any from typing import Any, Self
@dataclass @dataclass
@ -145,7 +153,18 @@ class BinarySearchTree:
self.root = new_children self.root = new_children
def empty(self) -> bool: def empty(self) -> bool:
return self.root is None """
Returns True if the tree does not have any element(s).
False if the tree has element(s).
>>> BinarySearchTree().empty()
True
>>> BinarySearchTree().insert(1).empty()
False
>>> BinarySearchTree().insert(8, 3, 6, 1, 10, 14, 13, 4, 7).empty()
False
"""
return not self.root
def __insert(self, value) -> None: def __insert(self, value) -> None:
""" """
@ -173,9 +192,10 @@ class BinarySearchTree:
parent_node = parent_node.right parent_node = parent_node.right
new_node.parent = parent_node new_node.parent = parent_node
def insert(self, *values) -> None: def insert(self, *values) -> Self:
for value in values: for value in values:
self.__insert(value) self.__insert(value)
return self
def search(self, value) -> Node | None: def search(self, value) -> Node | None:
if self.empty(): if self.empty():