added doctests

Author: Alex de la Cruz

data_structures/trie/radix_tree.py

@@ -1,6 +1,6 @@
 """
-A Radix Tree is a data structure that represents a space-optimized trie (prefix tree) in which 
-each node that is the only child is merged with its parent
+A Radix Tree is a data structure that represents a space-optimized trie (prefix tree) in which
+each node that is the only child is merged with its parent [https://en.wikipedia.org/wiki/Radix_tree]
 """
 
 
@@ -22,6 +22,9 @@ def match(self, word):
 
         Returns:
             (str, str, str): common substring, remaining prefix, remaining word
+
+        >>> RadixNode("myprefix").match("mystring")
+        ('my', 'prefix', 'string')
         """
         x = 0
         for q, w in zip(self.prefix, word):
@@ -37,6 +40,8 @@ def insert_many(self, words: list[str]) -> None:
 
         Args:
             words (list[str]): list of words
+
+        >>> RadixNode("myprefix").insert_many(["mystring", "hello"])
         """
         for word in words:
             self.insert(word)
@@ -46,6 +51,8 @@ def insert(self, word: str) -> None:
 
         Args:
             word (str): word to insert
+
+        >>> RadixNode("myprefix").insert("mystring")
         """
         # Case 1: If the word is the prefix of the node
         # Solution: We set the current node as leaf
@@ -90,6 +97,9 @@ def find(self, word: str) -> bool:
 
         Returns:
             bool: True if the word appears on the tree
+
+        >>> RadixNode("myprefix").find("mystring")
+        False
         """
         incoming_node = self.nodes.get(word[0], None)
         if not incoming_node:
@@ -116,6 +126,9 @@ def delete(self, word: str) -> bool:
 
         Returns:
             bool: _description_
+
+        >>> RadixNode("myprefix").delete("mystring")
+        False
         """
         incoming_node = self.nodes.get(word[0], None)
         if not incoming_node:
@@ -203,6 +216,5 @@ def main() -> None:
     root.print_tree()
 
 
-
 if __name__ == "__main__":
     main()