feat: Enhance Trie with New Features

[asmit27rai]

Enhance Trie with New Features

FIXES: #616

Description

This PR adds multiple new features to the Trie class, making it more versatile and functional. The following methods have been introduced:

1. Count of Words (count_words()) - Returns the total number of words stored in the Trie.
2. Longest Common Prefix (longest_common_prefix()) - Finds the longest common prefix among all words in the Trie.
3. Autocomplete (autocomplete(prefix)) - Provides a list of words that match a given prefix.
4. Bulk Insert (bulk_insert(words)) - Inserts multiple words into the Trie in a single operation.
5. Clear Trie (clear()) - Removes all words from the Trie, resetting it.
6. Check if Trie is Empty (is_empty()) - Returns True if the Trie is empty, otherwise False.
7. Find All Words (find_all_words()) - Retrieves all words currently stored in the Trie.
8. Find the Shortest Unique Prefix (shortest_unique_prefix(word)) - Determines the shortest unique prefix for a given word.
9. Check if Any Word Starts with a Given Prefix (starts_with(prefix)) - Returns True if any word in the Trie starts with the given prefix.
10. Find the Longest Word (longest_word()) - Finds and returns the longest word in the Trie.

Why This is Needed

The Trie previously supported only basic operations like insertion, deletion, and searching. These new features significantly improve its usability by adding useful functionalities for searching, autocompletion, and prefix analysis.

How These Features Were Implemented

• A count variable was introduced to track the number of inserted words.
• Recursive and iterative approaches were used to implement prefix and word retrieval functionalities.
• Helper functions were added for efficient traversal and search optimizations.

How to Test

trie = Trie()
trie.bulk_insert(["apple", "app", "apricot", "bat", "ball"])

assert trie.count_words() == 5
assert trie.longest_common_prefix() == "a"
assert trie.autocomplete("ap") == ["apple", "app", "apricot"]
assert trie.find_all_words() == ["apple", "app", "apricot", "bat", "ball"]
assert trie.starts_with("ba") == True
assert trie.longest_word() == "apricot"
assert trie.shortest_unique_prefix("apple") == "appl"
assert trie.is_empty() == False

trie.clear()
assert trie.is_empty() == True

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.373%. Comparing base (f4c1677) to head (e49db80).

Additional details and impacted files

@@              Coverage Diff              @@
##              main      #617       +/-   ##
=============================================
+ Coverage   97.345%   97.373%   +0.027%     
=============================================
  Files           36        36               
  Lines         4445      4492       +47     
=============================================
+ Hits          4327      4374       +47     
  Misses         118       118               

Files with missing lines	Coverage Δ
pydatastructs/strings/trie.py	100.000% <100.000%> (ø)

🚀 New features to boost your workflow:

• ❄ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[czgdp1807]

There are many new methods added here. Would recommend to fork out multiple PRs from this one so that its easy to review.

[czgdp1807]

A stack implementation is better than recursive one. Please revert this change.

[czgdp1807]

I would recommend to support iterators in insert method only.

[czgdp1807]

Well nothing is removed here. Just the root is reset.