Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jakubkorytko/algorithms-library
A versatile project with a comprehensive collection of basic algorithms designed for easy customization
https://github.com/jakubkorytko/algorithms-library
algorithms-library dotnet mit-license open-source visual-studio
Last synced: 3 days ago
JSON representation
A versatile project with a comprehensive collection of basic algorithms designed for easy customization
- Host: GitHub
- URL: https://github.com/jakubkorytko/algorithms-library
- Owner: JakubKorytko
- License: mit
- Created: 2023-03-28T21:55:57.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-11-24T12:11:16.000Z (12 months ago)
- Last Synced: 2023-11-24T14:26:51.987Z (12 months ago)
- Topics: algorithms-library, dotnet, mit-license, open-source, visual-studio
- Language: C#
- Homepage:
- Size: 59.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Algorithms Library
[](LICENSE)
[](https://github.com/ellerbrock/open-source-badges/)
[](https://github.com/JakubKorytko/algorithms-library/actions/workflows/super-linter.yml)
## Table of Contents
- [Algorithms Library](#algorithms-library)
- [Table of Contents](#table-of-contents)
- [Introduction](#introduction)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Usage](#usage)
- [Menu](#menu)
- [Available commands](#available-commands)
- [Available algorithms](#available-algorithms)
- [Extending the library](#extending-the-library)
- [Adding new algorithms](#adding-new-algorithms)
- [Adding shared methods](#adding-shared-methods)
- [Contributing](#contributing)
- [Contact](#contact)
- [License](#license)
## Introduction
The Algorithms Library is a versatile C# project
that provides a comprehensive collection of basic algorithms
implemented within the .NET 4.7.3 framework.
This library is designed with extensibility in mind,
allowing users to easily add their own algorithms.
It's a great tool for learning algorithms and their implementation.
It also allows you to quickly test your own algorithms or create a collection of your favorite / custom algorithms.
It is built using the Visual Studio 2022.
**This project was created targeting Windows. It has not been tested on other operating systems.**
## Prerequisites
Before using the Algorithms Library, make sure that you have the following prerequisites installed on your system:
- [Visual Studio 2022 (version 17.6.3 or later)](https://visualstudio.microsoft.com/vs/)
- ".NET desktop development" workload installed.
## Installation
1. Clone this repository to your local machine using Git,
or download the ZIP file and extract it to a directory of your choice:
```bash
git clone https://github.com/JakubKorytko/algorithms-library.git
```
1. Change to the project directory:
```bash
cd algorithms-library
```
1. In Visual Studio, open the `AlgorithmsLibrary.sln' solution file.
1. Build or run the project in Visual Studio:
- **Run the project** in the Visual Studio
- `F5` / `Ctrl + F5` by default
- or `Debug` -> `Start Debugging` / `Start Without Debugging` on the toolbar
- or **Build project** executable
- `Ctrl + B` / `Ctrl + Shift + B` by default
- or `Build` -> `Build Solution` / `Build AlgorithmsLibrary` on the toolbar
The executable will be available in the `build` directory in both cases.
## Usage
### Menu
The application has an intuitive text-based menu.
When launched, the menu is displayed and the application waits for your input **(case-insensitive)**.
#### Available commands
- `` - execute the selected [algorithm](#available-algorithms)
- `menu` - show the menu options
- `exit`
### Available algorithms
- [Eratosthenes](./Components/Algorithms/Eratosthenes.cs) (Sieve of Eratosthenes)
- [SuperAlgorithm](./Components/Algorithms/Algorithm.example.cs) (an example algorithm without input)
- [Factorial](./Components/Algorithms/Factorial.cs) (Factorial calculator)
- [Fibonacci](./Components/Algorithms/Fibonacci.cs) (Fibonacci sequence calculator)
- [Hanoi](./Components/Algorithms/Hanoi.cs) (Hanoi tower solver)
- [Triangular](./Components/Algorithms/Triangular.cs) (Triangular numbers calculator)
## Extending the library
### Adding new algorithms
Add a new class to the [Components/Algorithms](./Components/Algorithms/) folder.
Make sure that the class is derived from the [Algorithm](./Components/AlgorithmsCore/BaseClass.cs) class
(`AlgorithmsLibrary.AlgorithmsCore` namespace).
Also, the class should:
1. Override the public void method named `Display`
which is used to execute the algorithm
(you must handle the output within this function)
- **IF NOT**: The application displays
`No display method defined for this algorithm`
when you try to select it from the menu.
1. Override the public virtual string `Description`:
```c#
public override string Description { get { return "..."; } }
```
- **IF NOT**: The application displays
`No description provided for this algorithm`
next to it in the printed menu.
1. Have a unique class name that is displayed in the menu.
For example, see [Components/Algorithms/Algorithm.example.cs](./Components/Algorithms/Algorithm.example.cs)
### Adding shared methods
If you need to add a method that is available to all algorithms,
add a new method to the [Components/AlgorithmsCore/BaseClassTools.cs](./Components/AlgorithmsCore/BaseClassTools.cs) file.
The file contains a sample method that you can check to create your own.
*(Also, there are already some methods there to parse integers from the input,
check them out if you are interested)*.
## Contributing
If you find issues or have suggestions for improvements,
feel free to open an issue or submit a pull request.
Contributions are welcome!
## Contact
If you have any questions, feel free to contact me at .
## License
This project is released under the MIT License. See the [LICENSE](LICENSE) file for details.