From 0d0dc4551cd15e2083fbe57edb7200b74e9201c3 Mon Sep 17 00:00:00 2001 From: Florian Fischer Date: Wed, 13 May 2020 23:18:01 +0200 Subject: add simple README --- README.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 README.md (limited to 'README.md') diff --git a/README.md b/README.md new file mode 100644 index 0000000..676558f --- /dev/null +++ b/README.md @@ -0,0 +1,30 @@ +# pso - a simple particle swarm optimization + +This is a basic particle swarm optimization I wrote as an exercise for university. +It is implemented in simple and clean standard C. +Included are 4 different optimization problems: sphere, rosenbrock, rastrigin, schwefel. + +Particles leaving the search space are evaluated to positive infinity. + +## Installation + +Clone the repository. +`git clone https://muhq.space/software/pso.git` + +Build pso by running `make` in the repository. + +## Usage + + Usage: ./pso [OPTIONS] + OPTIONS: + -p number of particles + -h print this help and exit + -t number of threads + -i iterations + -f the function to optimize + 0 - sphere function + 1 - rosenbrock function + 2 - rastrigin function + 3 - schwefel function + -a the a parameter + -b the b parameter -- cgit v1.2.3