@zfunction/genetics-js/README.md

Genetic and evolutionary algorithms framework for the web

<h1 align="center">
  <img src="https://github.com/CristianAbrante/GeneticsJS/raw/master/assets/images/logo.png" alt="genetics.js logo" width="400">
</h1>

<h4 align="center">
  Evolutionary algorithms library for the web.
</h4>

<p align="center">
    <a href="https://github.com/CristianAbrante/GeneticsJS/blob/master/LICENSE">
        <img alt="GitHub" src="https://img.shields.io/github/license/CristianAbrante/GeneticsJS.svg">
    </a>
    <a href="https://circleci.com/gh/CristianAbrante/workflows/GeneticsJS">
        <img alt="CircleCI branch" src="https://img.shields.io/circleci/project/github/CristianAbrante/GeneticsJS/master.svg">
    </a>
    <a href="https://coveralls.io/github/CristianAbrante/GeneticsJS">
        <img src='https://coveralls.io/repos/github/CristianAbrante/GeneticsJS/badge.svg?branch=master' alt='Coverage Status' />
    </a>
    <a href="https://github.com/ellerbrock/open-source-badges/">
        <img src="https://badges.frapsoft.com/os/v1/open-source.svg?v=103g" alt="Open source">
    </a>
    <a href="https://coveralls.io/github/CristianAbrante/GeneticsJS">
        <img alt="GitHub tag (latest SemVer)" src="https://img.shields.io/github/tag/CristianAbrante/GeneticsJS.svg">
    </a>
    <a href="https://geneticsjs.wordpress.com/">
        <img alt="Website" src="https://img.shields.io/website/https/geneticsjs.wordpress.com.svg">
    </a>
    <a href="https://twitter.com/GeneticsJs">
        <img alt="Twitter Follow" src="https://img.shields.io/twitter/follow/GeneticsJS.svg?label=Follow&style=social">
    </a>
</p>

<p align="center">
  <a href="#introduction">Introduction</a> •
  <a href="#installation">Installation</a> •
  <a href="#usage">Usage</a> •
  <a href="#roadmap">Roadmap</a> •
  <a href="#contributing">Contributing</a> •
  <a href="#authors">Authors</a> •
  <a href="#license">License</a>
</p>

## :books: Introduction
Evolutionary computing is one of the main techniques nowadays
for solving complex optimization problems. This library provides 
with the basic structure for implementing the most common evolutionary
algorithms, such as **genetic algorithms**.

<p align="center">
    <img src="assets/images/ea-structure.jpg" align="center" alt="drawing" width="400"/>
</p>

> Evolutionary algorithms basic structure

Evolutionary algorithms are composed basically by four elements:

* **Individuals**: Represent possible solutions of our problem in a determinate search space.
* **Mutation**: Mutation operator alterates one individual.
* **Recombination**: Recombination operator takes two parents and creates the offspring.
* **Parent selection**: Selection of the *best* parents that are going to be reproduced in the next generation.
* **Survivor selection**: Selection of the offspring and parents that are going to be the next generation.
 
This framework is going to provide the most common techniques for each component.

## :wrench: Installation
Currently project is **under development (no stable version released :warning:)**, but it is going to be installed
through npm:

```
npm install genetics-js
```

## 🧬 Usage
No major versions have been released, so only **Individuals** creation is implemented:
```typescript
import Genetics from 'genetics-js';
const { BinaryIndividual } = Genetics.individual;

let individual = new BinaryIndividual('001100');
individual.genotype // [false, false, true, true, false, false]
```

## :stars: Roadmap
The roadmap is strictly determined by the operations that are going to be 
implemented:

- [x] `v0.1.0`: Implementation of **individuals**.
- [ ] `v0.2.0`: Implementation of **mutation operators**.
- [ ] `v0.3.0`: Implementation of **recombination operators**.
- [ ] `v0.4.0`: Implementation of **parent selection methods**.
- [ ] `v0.5.0`: Implementation of **survivor selection methods**.
- [ ] `v0.6.0`: Implementation of **population and offspring management**.
- [ ] `v0.7.0`: Implementation of **common evolutionary algorithms** with fixed configurations.

## :open_hands: Contributing
You can report a bug, or request a feature with an issue:

* [Report a bug :bug: with this template.](https://github.com/CristianAbrante/GeneticsJS/issues/new?assignees=&labels=&template=bug-report.md&title=%3Abug%3A).
* [Request a feature :bulb: with this template.](https://github.com/CristianAbrante/GeneticsJS/issues/new?assignees=&labels=&template=feature_request.md&title=)

Any help would be welcome :smile:.

## :muscle: Authors
* **Cristian Abrante** - [CristianAbrante](https://github.com/CristianAbrante) - ([cristian@abrante.me])

## :memo: License
This project is licensed under the **[MIT License](https://github.com/CristianAbrante/GeneticsJS/blob/master/LICENSE)**