Merge pull request #8 from firefly-cpp/modifications

Add test

Author: firefly-cpp

FireflyAlgorithm.py

@@ -26,20 +26,20 @@ dnf install python-fireflyalgorithm
 
 ```python
 import numpy as np
-from FireflyAlgorithm import FireflyAlgorithm
-
+from fireflyalgorithm import FireflyAlgorithm
 
 def sphere(x):
     return np.sum(x ** 2)
 
+FA = FireflyAlgorithm()
+best = FA.run(function=sphere, dim=10, lb=-5, ub=5, max_evals=10000)
 
-best = FireflyAlgorithm(function=sphere, dim=10, lb=-5, ub=5, max_evals=10000)
 print(best)
 ```
 
 ## Reference Papers:
 
-I. Fister Jr.,  X.-S. Yang,  I. Fister, J. Brest. [Memetic firefly algorithm for combinatorial optimization](http://www.iztok-jr-fister.eu/static/publications/44.pdf) in Bioinspired Optimization Methods and their Applications (BIOMA 2012), B. Filipic and J.Silc, Eds. 
-Jozef Stefan Institute, Ljubljana, Slovenia, 2012 
+I. Fister Jr.,  X.-S. Yang,  I. Fister, J. Brest. [Memetic firefly algorithm for combinatorial optimization](http://www.iztok-jr-fister.eu/static/publications/44.pdf) in Bioinspired Optimization Methods and their Applications (BIOMA 2012), B. Filipic and J.Silc, Eds.
+Jozef Stefan Institute, Ljubljana, Slovenia, 2012
 
 I. Fister, I. Fister Jr.,  X.-S. Yang, J. Brest. [A comprehensive review of firefly algorithms](http://www.iztok-jr-fister.eu/static/publications/23.pdf). Swarm and Evolutionary Computation 13 (2013): 34-46.

README.md

@@ -0,0 +1,12 @@
+import numpy as np
+from fireflyalgorithm import FireflyAlgorithm
+
+
+def sphere(x):
+    return np.sum(x ** 2)
+
+
+FA = FireflyAlgorithm()
+best = FA.run(function=sphere, dim=10, lb=-5, ub=5, max_evals=10000)
+
+print(best)

README.rst

@@ -0,0 +1,5 @@
+from fireflyalgorithm.fireflyalgorithm import FireflyAlgorithm
+
+__all__ = ['FireflyAlgorithm']
+
+__version__ = '0.2'

examples/run.py

@@ -0,0 +1,35 @@
+import numpy as np
+from numpy.random import default_rng
+
+
+class FireflyAlgorithm:
+    def __init__(self, pop_size=20, alpha=1.0, betamin=1.0, gamma=0.01, seed=None):
+        self.pop_size = pop_size
+        self.alpha = alpha
+        self.betamin = betamin
+        self.gamma = gamma
+        self.rng = default_rng(seed)
+
+    def run(self, function, dim, lb, ub, max_evals):
+        fireflies = self.rng.uniform(lb, ub, (self.pop_size, dim))
+        intensity = np.apply_along_axis(function, 1, fireflies)
+        best = np.min(intensity)
+
+        evaluations = self.pop_size
+        new_alpha = self.alpha
+        search_range = ub - lb
+
+        while evaluations <= max_evals:
+            new_alpha *= 0.97
+            for i in range(self.pop_size):
+                for j in range(self.pop_size):
+                    if intensity[i] >= intensity[j]:
+                        r = np.sum(np.square(fireflies[i] - fireflies[j]), axis=-1)
+                        beta = self.betamin * np.exp(-self.gamma * r)
+                        steps = new_alpha * (self.rng.random(dim) - 0.5) * search_range
+                        fireflies[i] += beta * (fireflies[j] - fireflies[i]) + steps
+                        fireflies[i] = np.clip(fireflies[i], lb, ub)
+                        intensity[i] = function(fireflies[i])
+                        evaluations += 1
+                        best = min(intensity[i], best)
+        return best

fireflyalgorithm/__init__.py

@@ -0,0 +1 @@
+ 

fireflyalgorithm/fireflyalgorithm.py

@@ -0,0 +1,6 @@
+import logging
+
+
+def pytest_configure(config):
+    r"""Disable verbose output when running tests."""
+    logging.basicConfig(level=logging.DEBUG)

fireflyalgorithm/tests/__init__.py

@@ -0,0 +1,14 @@
+from unittest import TestCase
+
+import numpy as np
+from fireflyalgorithm import FireflyAlgorithm
+import os
+
+def sphere(x):
+    return np.sum(x ** 2)
+
+class TestFA(TestCase):
+    def test_algorithm(self):
+        FA = FireflyAlgorithm()
+        best = FA.run(function=sphere, dim=10, lb=-5, ub=5, max_evals=10000)
+        self.assertLess(best, 5)

fireflyalgorithm/tests/conftest.py

@@ -6,17 +6,21 @@ authors = ["firefly-cpp"]
 license = "MIT"
 readme = "README.md"
 
-packages = [
-    {include = "FireflyAlgorithm.py"},
+include = [
+    { path="LICENSE", format="sdist" }
 ]
 
+
 [tool.poetry.dependencies]
 python = "^3.7"
 numpy = [
     { version = "^1.21.5", python = ">=3.7,<3.11" },
     { version = "^1.22.0", python = "^3.11" }
 ]
 
+[tool.poetry.dev-dependencies]
+pytest = "^7.0.1"
+
 [build-system]
 requires = ["poetry-core>=1.0.0"]
 build-backend = "poetry.core.masonry.api"

fireflyalgorithm/tests/test_firefly.py

@@ -0,0 +1 @@
+ 

pyproject.toml

@@ -0,0 +1,3 @@
+from fireflyalgorithm.tests.conftest import pytest_configure
+
+__all__ = ["pytest_configure"]