https://github.com/mgrechanik/ant-colony-optimization
The implementation of the ant colony optimization algorithm. Allows to solve Travelling Salesman Problem , Shortest path problem, etc.
https://github.com/mgrechanik/ant-colony-optimization
aco adjacency-matrix ant-colony-optimization graph optimization-algorithms path-planning php php8 salesman-problem search-algorithm shortest-path-algorithm shortest-path-problem shortest-paths travelling-salesman-problem tsp tsp-problem tsp-solver
Last synced: 6 months ago
JSON representation
The implementation of the ant colony optimization algorithm. Allows to solve Travelling Salesman Problem , Shortest path problem, etc.
- Host: GitHub
- URL: https://github.com/mgrechanik/ant-colony-optimization
- Owner: mgrechanik
- License: other
- Created: 2023-12-06T03:37:17.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-29T04:15:48.000Z (about 1 year ago)
- Last Synced: 2024-12-14T15:09:08.883Z (6 months ago)
- Topics: aco, adjacency-matrix, ant-colony-optimization, graph, optimization-algorithms, path-planning, php, php8, salesman-problem, search-algorithm, shortest-path-algorithm, shortest-path-problem, shortest-paths, travelling-salesman-problem, tsp, tsp-problem, tsp-solver
- Language: PHP
- Homepage:
- Size: 223 KB
- Stars: 7
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Ant colony optimization
[Русская версия](docs/README_ru.md)
## Table of contents
* [Introdution](#introducion)
* [Demo](#demo)
* [Installing](#installing)
* [How to use](#use)
* [Settings](#settings)
* [Performance](#performance)
* [TSPLIB95](#tsplib95)
* [Terminology](#terminology)
---
## Introdution
The Ant colony optimization is a probabilistic technique for solving computational problems which can be reduced to finding good paths through graphs (from Wikipedia).
The task we are solving could be either "[Travelling salesman problem](#tsp-example 'Code example of solving TSP with ACO')" or "[Shortest path problem](#spp-example 'Code example of solving SPP with ACO')", or Constrained Shortest Path First, etc.
The two first tasks are solved within this library.
There are a lot of strategies and variations of Classic ACO algorithm.
This library out of the box implements Classic ACO and ACO with elitist ants.
The library could be easily extended so you can implement your ACO variations and to solve the tasks you need.
The initial data about the graph comes either from adjacency matrix or from a list of nodes (cities, vertices, etc) with their X and Y coordinates.
The work of library had been tested with [TSPLIB95](#tsplib95) data sets, so we could check it's [performance](#performance) and efficiency.
Amount of ants, all coefficients and parameters could be [changed](#settings) to your need.
Now we have [a web app](https://github.com/mgrechanik/aco-workshop-for-tsp "Ant colony optimization workshop for solving a travelling salesman problem") which you can install and run locally to practice with this algorithm. Look for it's video demo for details.
---
## Demo
Solving the travelling salesman problem with the ant colony optimization algorithm:
Another example:
---
## Installing
#### Installing through composer::
The preferred way to install this library is through composer.
Either run
```
composer require --prefer-dist mgrechanik/ant-colony-optimization
```
or add
```
"mgrechanik/ant-colony-optimization" : "~1.0.0"
```
to the require section of your `composer.json`.
---
## How to use
### Basic API
1) **Creating a Manager with the dependencies we need**
```php
Manager::__construct(DistanceInterface $distanceStrategy = null, AFinder $finder = null,
MathematicsInterface $mathematics = null, Task $task = null);
```
- By default **Finder** will be Classic one, and the **Task** will be the Travelling salesman problem
2) **Loading data from an adjacency matrix**
```php
$manager->setMatrix(array $matrix, int $nameStart = 0)
```
- ```$nameStart``` - from which number start naming aliases of nodes
3) **Loading data from an array of cities**
```php
$manager->setCities(City ...$cities)
```
- This array of cities will be transformed to adjacency matrix. Distances will be calculated according to the strategy we set to a Manager.
- If city has a ```name``` property it will become it's name alias
4) **Changing of the adjacency matrix**
```php
$manager->updateMatrix(int $y, int $x, float|int $value, bool $double = true)
```
- For example we could make some path impassable - ```$manager->updateMatrix(1, 0, 1000000);```
5) **Run the computational process**
```php
$distance = $manager->run(int $iterations = 400)
```
- for small graphs we could reduce amount of iterations.
- It will return the distance we found or ```null``` when the search gave no result
6) **Getting the path we found**
```php
$path = $manager->getInnerPath()
```
- The path we found who consists of node's numbers.
All nodes are internally named as numbers from 0 to N-1, where N is node's amount.
7) **Getting aliased path we found**
```php
$path = $manager->getNamedPath()
```
- The path we found which consists of node's name aliases, if we set them.
### Examples
#### Solving "Travelling salesman problem" with Classic ACO
```php
use mgrechanik\aco\Manager;
$manager = new Manager();
$matrix = [
[ 0, 8, 4, 11],
[ 8, 0, 9, 5 ],
[ 4, 9, 0, 8 ],
[11, 5, 8, 0 ]
];
$manager->setMatrix($matrix);
$distance = $manager->run(20);
var_dump('Distance=' . $distance);
var_dump($manager->getInnerPath())
```
We will get:
```php
Distance=25
Array
(
[0] => 0
[1] => 1
[2] => 3
[3] => 2
[4] => 0
)
```
#### Solving "Shortest path problem" with Classic ACO
```php
use mgrechanik\aco\Manager;
use mgrechanik\aco\SppTask;
$task = new SppTask(0, 3);
$manager = new Manager(task : $task);
$matrix = [
[ 0 , 8, 4, 100],
[ 8 , 0, 9, 5 ],
[ 4 , 9, 0, 8 ],
[100, 5, 8, 0 ]
];
$manager->setMatrix($matrix);
$finder = $manager->getFinder();
// increase amount of ants to 6
$finder->setM(6);
$distance = $manager->run(50);
var_dump('Distance=' . $distance);
var_dump($manager->getInnerPath())
```
We will get:
```php
Distance=12
Array
(
[0] => 0
[1] => 2
[2] => 3
)
// for comparison, the direct path [0, 3] is closed by big distance and distance of path [0, 1, 3] is 13
```
#### Loading data as an array of cities
```php
use mgrechanik\aco\Manager;
use mgrechanik\aco\City;
$cities = [new City(10,10), new City(50,50), new City(10,50), new City(60,10)];
$manager = new Manager();
$manager->setCities(...$cities);
```
#### Loading data as an adjacency matrix
```php
use mgrechanik\aco\Manager;
$matrix = [
[ 0, 8, 4, 11],
[ 8, 0, 9, 5 ],
[ 4, 9, 0, 8 ] ,
[11, 5, 8, 0 ]
];
$manager = new Manager();
$manager->setMatrix($matrix);
```
#### Using the Elitist Finder
```php
$finder = new \mgrechanik\aco\elitist\Finder();
$manager = new Manager(finder : $finder);
//...
```
#### Have a look at the history of our work - best solutions we had been finding
```php
use mgrechanik\aco\Manager;
$matrix = [
[ 0, 8, 4, 11],
[ 8, 0, 9, 5 ],
[ 4, 9, 0, 8 ] ,
[11, 5, 8, 0 ]
];
$manager = new Manager();
$finder = $manager->getFinder();
$manager->setMatrix($matrix);
$manager->run();
var_dump($finder->getHistory());
```
#### Loading a list of cities from an image file
With the use of [this library](https://github.com/mgrechanik/image-points-searcher "library to search for points on image") we can load a list of cities from the image. And the result of the search could be displayed on the image too. It will look like images on [Demo](#demo "the images we get this way").
Read docs of that library for more information how to prepare images but briefly it is this: On white canvas draw points of 10 px diameter (they are vertices of the graph) and use this image with the code below
```php
use mgrechanik\aco\Manager;
use mgrechanik\aco\City;
try {
$imageSearcher = new \mgrechanik\imagepointssearcher\Searcher(
'./images/your_image.jpg',
);
$found = $imageSearcher->run();
if ($found > 1) {
$points = $imageSearcher->getPoints();
$cities = [];
foreach ($points as $point) {
$cities[] = new City($point['x'], $point['y']);
}
$manager = new Manager();
$manager->setCities(...$cities);
if ($res = $manager->run()) {
$innerPath = $manager->getInnerPath();
$imageResult = new \mgrechanik\imagepointssearcher\ImageResult($imageSearcher);
$imageResult->drawLabels();
$imageResult->drawMargins();
$imageResult->drawPath($innerPath);
$imageResult->save('./images/result.jpg');
}
}
} catch (Exception $e) {
//
}
```
---
## Settings
### Finder settings
The base object we tune is the Finder.
Lets get it:
```php
$manager = new Manager();
$finder = $manager->getFinder();
// Settings
//$finder->set...
// ...
//$manager->run();
```
**Settings available:**
- Set the distance value which makes the path between two nodes impassable
```->setClosedPathValue(int $value)```
- Set amount of ants
```->setM(int $m)```
- Set amount of ants in percents relatively to amount of nodes. Default behavior (=40%)
```->setMPercent(int $mPercent)```
- Set the coefficients for formulas
```php
->setAlpha(float $alpha);
->setBeta(float $beta);
->setP(float $p);
->setC(float $c);
->setQ(int $q);
```
- Set the strategy to do the mathematical work
```->setMathematics(MathematicsInterface $mathematics)```
- Set the task we are solving. Say TSP, SPP or other.
```->setTask(Task $task)```
- Set an amount of elitist ants (when we use Elitist Finder)
```->setSigma(int $sigma)```
- Set an amount of elitist ants in percents relatively to amount of regular ants. Default behavior (=50%) (when we use Elitist Finder)
```->setSigmaPercent(int $sPercent)```
---
## Performance
> First of all turn off XDebug or it's analogies, since they could significantly affect the time the algorithm works
This ACO algorithm finds [good](#demo) paths on a graph. And sometimes even best paths.
Lets take, for example, the ```berlin52.tsp``` task from [TSPLIB95](#tsplib95) library, which has 52 nodes.
Solving this task with the next code:
```php
$cities = TspLibLoader::loadCitiesFromEuc2dFile(__DIR__ . '/images/data/berlin52.tsp');
$finder = new \mgrechanik\aco\elitist\Finder();
$finder->setSigmaPercent(150);
$finder->setMPercent(30);
$finder->setAlpha(0.7);
$manager = new Manager(finder : $finder);
$manager->setCities(...$cities);
$distance = $manager->run(300);
var_dump('Distance=' . $distance);
var_dump($finder->getHistory());
```
We will see:
```php
Distance=7542
Array ...
[85] => Array
(
[distance] => 7542
[inner_path] => 0_21_30_17_2_16_20_41_6_1_29_22_19_49_28_15_45_43_33_34_35_38_39_36_37_47_23_4_14_5_3_24_11_27_26_25_46_12_13_51_10_50_32_42_9_8_7_40_18_44_31_48_0
[iteration] => 85
[time_spent] => 1.94 sec
)
)
```
This code, working on an office computer, found the best path ever known for less than 2 seconds.
We used here Elitist ACO algorithm since in practice it gives better results than Classic one.
An Algorithm is probabilistic, ants travel differently each new search. A lot depends upon amount of nodes, amount of ants, all coefficients and parameters used with formulas.
---
## TSPLIB95
The [TSPLIB95](http://comopt.ifi.uni-heidelberg.de/software/TSPLIB95/) library ships with a lot of ```Travelling salesman problems``` - initial data and solutions - best results ever found for these tasks ([paths](#tsplib95 "The best paths are located in the corresponding name.opt.tour file") and [distances](http://comopt.ifi.uni-heidelberg.de/software/TSPLIB95/STSP.html "Here you can see the best distances ever found")).
The library is valuable that with it's data we could test the efficiency of our algorithms, coefficients and parameters.
The library consists of a lot of different initial data formats. Out of the box we support two of them.
### Loading data as a set of X and Y coordinates of cities. Distance is euclidean.
Example of the file with this format - **berlin52.tsp** .
Loading the list of nodes (cities) and transfer it to Manager:
```php
use mgrechanik\aco\TspLibLoader;
use mgrechanik\aco\Manager;
$fileName = __DIR__ . '/berlin52.tsp';
$cities = TspLibLoader::loadCitiesFromEuc2dFile($fileName);
$manager = new Manager();
$manager->setCities(...$cities);
```
### Loading data as an adjacency matrix
Example of the file with this format - **bays29.tsp** .
Loading the adjacency matrix and transfer it to Manager:
```php
use mgrechanik\aco\TspLibLoader;
use mgrechanik\aco\Manager;
$fileName = __DIR__ . '/bays29.tsp';
$matrix = TspLibLoader::loadMatrixFromExplicitMatrixFile($fileName);
$manager = new Manager();
// tsplib95 library names nodes starting with "1"
$manager->setMatrix($matrix, 1);
```
---
## Terminology
#### ```ACO``` - Ant colony optimization algorithm
#### ```Nodes``` - Nodes or vertices or cities. Ants travel between them.
#### ```Adjacency Matrix``` - Adjacency Matrix sets the distances between graph nodes. It is a basic structure our algorithm starts work with.
When graph is loaded like ```Cities``` with their coordinates, this information will be converted to Adjacency Matrix
#### ```Classic Finder``` - Finder who implements Classic ACO algorithm
#### ```Elitist Finder``` - Finder who implements ACO algorithm when we use elitist ants
#### ```Ant``` - ant, working unit, who move through the graph searching for the paths
#### ```Task``` - The task we are solving on the graph. For example it could be ```"Travelling salesman problem"``` or ```"Shortest path problem"```. Or other.
#### ```TSP``` - Travelling salesman problem. With this library we can solve both symmetric and asymmetric types of tsp
#### ```Manager``` - The manager which task is to form adjacency matrix , give it to ```Finder``` to solve ```Task```.
#### ```Iteration``` - The iteration during which all ants find one path and put pheromones on it. We set amount of iterations themselves.
#### ```Pheromon``` - is the instance ants leave on paths
#### ```m``` - Amount of ants
#### ```mPercent``` - Amount of ants in percents relatively to the amount of nodes
#### ```sigma``` - Amount of elitist ants, if we use corresponding algorithm
#### ```sigmaPercent``` - Amount of elitist ants in percents relatively to the amount of regular ants
#### ```alpha``` - The coefficient to control the influence of pheromone amount
#### ```beta``` - The coefficient to control the influence of desirability of path
#### ```p``` - The evaporation coefficient
#### ```c``` - The starting amount of pheromones on paths
#### ```Q``` - The constant used to calculate how many pheromones an ant puts on the path it found