Skip to content

Commit 001aaae

Browse files
committed
docs: add toc for content
1 parent ff672f5 commit 001aaae

File tree

1 file changed

+12
-15
lines changed

1 file changed

+12
-15
lines changed

README.md

+12-15
Original file line numberDiff line numberDiff line change
@@ -4,26 +4,23 @@
44
[![codecov](https://codecov.io/gh/Ja7ad/algo/graph/badge.svg?token=9fLKrkUviU)](https://codecov.io/gh/Ja7ad/algo)
55
[![Go Report Card](https://goreportcard.com/badge/github.com/Ja7ad/algo)](https://goreportcard.com/report/github.com/Ja7ad/algo)
66

7-
**`algo`** is a Golang library featuring a variety of **efficient** and **well-optimized** algorithms
8-
designed for diverse **problem-solving needs**.
7+
**`algo`** is a Golang library featuring a variety of **efficient** and **well-optimized** algorithms designed for diverse **problem-solving needs**.
98

10-
## 📌 Features
11-
12-
**Optimized Performance** – Algorithms are designed with efficiency in mind.
13-
**Modular Structure** – Each algorithm is in its own package for easy use.
14-
**Well-Documented** – Clear documentation and examples for every algorithm.
15-
**Tested & Benchmarked** – Includes comprehensive tests and benchmarks.
9+
The purpose of this package is to implement specific algorithms in a simplified manner based on formulaic documentation available on Wikipedia or other sources. These algorithms
10+
been validated in terms of functionality and testing.
1611

12+
- [📚 Available Algorithms](#-available-algorithms)
13+
- [🚀 Installation >= go 1.19](#-installation--go-119)
14+
- [✅ Usage Example](#-usage-example)
15+
- [📌 Contribution](#-contribution)
16+
- [📜 License](#-license)
1717

1818
## 📚 Available Algorithms
1919

20-
| Algorithm | Description |
21-
|--------------------------------------------------|-------------|
22-
| [Random Weighted Selection](./rws/README.md) | Selects items randomly based on assigned weights. Useful in load balancing, gaming, and AI. |
23-
| [Reservoir Sampling Algorithm R](./rs/README.md) | Basic reservoir sampling, replaces elements with probability `k/i`. Efficient for uniform random sampling. |
24-
| [Reservoir Sampling Algorithm L](./rs/README.md) | Optimized reservoir sampling for large `N`, reduces unnecessary replacements using skipping. |
25-
| [Weighted Reservoir Sampling](./rs/README.md) | Selects items with probability proportional to their weights using a heap-based approach. Used in recommendation systems and A/B testing. |
26-
| [Random Sort Reservoir Sampling](./rs/README.md) | Uses a min-heap and random priorities to maintain the top `k` elements in a streaming dataset. |
20+
| Algorithm | Description |
21+
|-----------|-------------|
22+
| [Random Weighted Selection](./rws/README.md) | Selects items randomly based on assigned weights. Useful in load balancing, gaming, and AI. |
23+
2724

2825
## 🚀 Installation >= go 1.19
2926

0 commit comments

Comments
 (0)