https://github.com/raphsenn/prefix-search-engine
Simple Prefix Binary Tree-based string search engine written in Rust.
https://github.com/raphsenn/prefix-search-engine
algorithms-and-data-structures binary-search binary-search-tree binary-tree fltk prefix prefix-search rust rust-lang search-algorithm search-engine searchengine searching-algorithms
Last synced: 5 months ago
JSON representation
Simple Prefix Binary Tree-based string search engine written in Rust.
- Host: GitHub
- URL: https://github.com/raphsenn/prefix-search-engine
- Owner: raphsenn
- License: mit
- Created: 2023-10-08T18:16:56.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-10-09T11:28:22.000Z (over 1 year ago)
- Last Synced: 2024-11-20T18:50:27.845Z (7 months ago)
- Topics: algorithms-and-data-structures, binary-search, binary-search-tree, binary-tree, fltk, prefix, prefix-search, rust, rust-lang, search-algorithm, search-engine, searchengine, searching-algorithms
- Language: Rust
- Homepage:
- Size: 7.73 MB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# prefix-search-engine
This project contains a BinaryTree struct that represents the prefix binary tree data structure used for efficient string searching. The BinaryTree struct is responsible for organizing and managing the dataset of strings, enabling quick prefix-based searches.
For testing purposes, i included a sample file named "top-1m.csv" that contains the top 1 million web URLs. This allows you to demonstrate the speed and efficiency of this search engine when performing prefix searches on a large dataset.
Please note that in a real-world scenario, you would typically obtain such data from a web source or another relevant data provider..
### Features
- Fast and efficient string searching using a prefix binary tree.
- Supports searching in text files with one string per line.
- Simple and easy-to-use interface.
### Binary-Search-Tree
The binary tree implemented in this project uses lexicographical order (lexikographische Ordnung) for organizing and searching strings. This means that strings are arranged in the tree according to their lexicographical (dictionary) order, where "smaller" strings come before "larger" strings based on their character sequences.
#### Example Tree
For simplicity, we translate this binary tree with strings into one with integers, ensuring that the trees are isomorphic.
#### Translated Tree
##### How the lookup and lookup_recursive method works
First create the translated tree, for simplicity we work here with integers, not with strings..
```js
let mut tree = SearchTree::new();
tree.push(4);
tree.push(2);
tree.push(6);
tree.push(1);
tree.push(3);
tree.push(5);
tree.push(7);
```
Call the lookup method:
```js
tree.lookup(2, 5));
```
The result of lookup(2,5) would look visual like that:
### Dependencies
This project uses the FLTK library for creating the user interface. You can add it to your Cargo.toml file:
#### Install FLTK-libary
Run the following Cargo command in your project directory:
```js
Cargo add fltk
Cargo add fltk-theme
```
#### About FLTK
```js
https://crates.io/crates/fltk
```
### Usage
1. Clone the Repository to your local machine:
```js
git clone https://github.com/raphsenn/prefix-search-engine.git
```
2. Navigate to the directory:
```js
cd prefix-search-engine
```
3. Check if your Cargo.toml has the fltk flag under [dependencies]:
```js
[dependencies]
fltk = "1.4.13"
fltk-theme = "0.7.1"
[[bin]]
name = "searchengine"
path = "searchengine.rs"
```
4. You can specify the input dataset file by modifying top-1m.csv file, to a file of your own:
```js
search_engine.read("top-1m.csv")?;
```
5. Compile and run the project using Cargo:
```js
cargo run
```
### License
This project is licensed under the MIT License. See the LICENSE file for details.