plentiful
v0.2.0
Published
A bountyful amount of algorithms to pick from, choose your poison.
Downloads
38
Maintainers
Readme
A bountyful amount of algorithms ripe for the picking, choose your poison. runs with node.
import { Plentiful } from "plentiful";
Plentiful.sorts.timSort();
Plentiful();
This repository is a collection of many if not all common and popular algorithms implemented and rewritten in JavaScript. The list in constantly expanding-- feel free to contribute!
An algorithm is an unambiguous specification of how to solve a class of problems. It is a set of rules and steps that precisely define a set or sequence of operations.
Each algorithm has its own separate README containing relevant information and explanations and links for further reading.
Installation
This is a Node.js package available through the npm registry.
Before installing, download and install Node.js. Node.js 0.10 or higher is required.
Installation is done using the
npm install
command:
$ npm install -g plentiful
Follow our installing guide for more information.
Features
- List of most to all algorithms
- Everything implemented in Javascript
- Focus on high performance
Docs & Community
- Website and Documentation - [website repo]
- #plentiful on freenode IRC
- Visit the Wiki
- Slack for discussion
Security Issues
If you discover a security vulnerability in Plentiful, please see Security Policies and Procedures.
Quick Start
The quickest way to get started with Plentiful is to install the package to your project and then call and use the algorithm you are looking for your needs:
import { Plentiful } from "plentiful";
Plentiful.sorts.timSort();
Plentiful();
Otherwise, for research or testing purposes you can install Plentiful globally and then use the implementType implementType
which will apply the best algorithm for the given task:
Install the Plentiful repo:
$ npm install -g plentiful
Utilize implementType on any data set and find the best algorithm to use:
$ plentiful implementType $data
$ timsort(data)? [Y/n]
$ ...
Install dependencies:
$ npm install
Philosophy
Just find the right algorithm and have fun, don't waste your time porting to a C++ library when you can call any common and popular algorithm with Plentiful!
Tests
To run the test suite, first install the dependencies, then run npm test
:
$ npm install
$ npm test
License
TODOs
- Feature Description
- Example => Porting a new algorithm to javascript source Array.prototype.sort = Plentiful.sort.sorted().