├── .github ├── imgs │ └── firefly_logo.png ├── templates │ ├── FEATURE_REQUEST.md │ ├── ISSUE_TEMPLATE.md │ └── PULL_REQUEST.md └── workflows │ └── test.yml ├── .gitignore ├── CHANGELOG.md ├── CITATION.cff ├── CODE_OF_CONDUCT.md ├── CONTRIBUTING.md ├── LICENSE ├── Problems.md ├── README.md ├── examples └── run.py ├── fireflyalgorithm ├── __init__.py ├── __main__.py ├── cli.py ├── fireflyalgorithm.py └── problems.py ├── poetry.lock ├── pyproject.toml └── tests ├── __init__.py ├── test_firefly.py └── test_problems.py /.github/imgs/firefly_logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/firefly-cpp/FireflyAlgorithm/121b1852a5ae3951034aa49e119d0fd44f1525f9/.github/imgs/firefly_logo.png -------------------------------------------------------------------------------- /.github/templates/FEATURE_REQUEST.md: -------------------------------------------------------------------------------- 1 | ### Feature Request 2 | 3 | **About**: 4 | **Title**: 5 | 6 | **Is your feature request related to a problem? Please describe.** 7 | A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] 8 | 9 | **Describe the solution you'd like** 10 | A clear and concise description of what you want to happen. 11 | 12 | **Describe alternatives you've considered** 13 | A clear and concise description of any alternative solutions or features you've considered. 14 | 15 | **Additional context** 16 | Add any other context or screenshots about the feature request here. -------------------------------------------------------------------------------- /.github/templates/ISSUE_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | ### Bug Report 2 | 3 | **About**: 4 | **Title**: 5 | 6 | **Steps to reproduce** 7 | Tell us how to reproduce the bug. 8 | 9 | **Expected behavior** 10 | Tell us what should happen. 11 | 12 | **Actual behavior** 13 | Tell us what happens instead. 14 | 15 | **System configuration** 16 | 17 | - OS: 18 | - Python version: -------------------------------------------------------------------------------- /.github/templates/PULL_REQUEST.md: -------------------------------------------------------------------------------- 1 | ### Summary 2 | 3 | Provide a general description of the code changes in your pull 4 | request... were there any bugs you had fixed? If so, mention them. If 5 | these bugs have open GitHub issues, be sure to tag them here as well, 6 | to keep the conversation linked together. 7 | 8 | ### Other Information 9 | 10 | If there's anything else that's important and relevant to your pull 11 | request, mention that information here. This could include 12 | benchmarks, or other information. 13 | 14 | Thanks for contributing to Firefly Algorithm! -------------------------------------------------------------------------------- /.github/workflows/test.yml: -------------------------------------------------------------------------------- 1 | name: fireflyalgorithm 2 | 3 | on: 4 | push: 5 | branches: [ master ] 6 | pull_request: 7 | branches: [ master ] 8 | 9 | jobs: 10 | build: 11 | 12 | runs-on: ${{ matrix.os }} 13 | strategy: 14 | matrix: 15 | os: [ubuntu-latest, windows-latest, macos-latest] 16 | python-version: ['3.9', '3.10', '3.11', '3.12'] 17 | defaults: 18 | run: 19 | shell: bash 20 | 21 | steps: 22 | - uses: actions/checkout@v3 23 | - name: Set up Python ${{ matrix.python-version }} 24 | uses: actions/setup-python@v3 25 | with: 26 | python-version: ${{ matrix.python-version }} 27 | - name: Get full Python version 28 | id: full-python-version 29 | run: echo ::set-output name=version::$(python -c "import sys; print('-'.join(str(v) for v in sys.version_info))") 30 | - name: Install poetry 31 | run: | 32 | curl -sL https://install.python-poetry.org | python - -y 33 | - name: Update path 34 | if: ${{ matrix.os != 'windows-latest' }} 35 | run: echo "$HOME/.local/bin" >> $GITHUB_PATH 36 | - name: Update Windows path 37 | if: ${{ matrix.os == 'windows-latest' }} 38 | run: echo "$APPDATA\Python\Scripts" >> $GITHUB_PATH 39 | - name: Configure poetry 40 | run: poetry config virtualenvs.in-project true 41 | - name: Set up cache 42 | uses: actions/cache@v3 43 | id: cache 44 | with: 45 | path: .venv 46 | key: venv-${{ runner.os }}-${{ steps.full-python-version.outputs.version }}-${{ hashFiles('**/poetry.lock') }} 47 | - name: Ensure cache is healthy 48 | if: steps.cache.outputs.cache-hit == 'true' 49 | run: timeout 10s poetry run pip --version || rm -rf .venv 50 | - name: Install dependencies 51 | run: poetry install 52 | - name: Run tests 53 | run: poetry run pytest 54 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | wheels/ 23 | pip-wheel-metadata/ 24 | share/python-wheels/ 25 | *.egg-info/ 26 | .installed.cfg 27 | *.egg 28 | MANIFEST 29 | 30 | # PyInstaller 31 | # Usually these files are written by a python script from a template 32 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 33 | *.manifest 34 | *.spec 35 | 36 | # Installer logs 37 | pip-log.txt 38 | pip-delete-this-directory.txt 39 | 40 | # Unit test / coverage reports 41 | htmlcov/ 42 | .tox/ 43 | .nox/ 44 | .coverage 45 | .coverage.* 46 | .cache 47 | nosetests.xml 48 | coverage.xml 49 | *.cover 50 | *.py,cover 51 | .hypothesis/ 52 | .pytest_cache/ 53 | 54 | # Translations 55 | *.mo 56 | *.pot 57 | 58 | # Django stuff: 59 | *.log 60 | local_settings.py 61 | db.sqlite3 62 | db.sqlite3-journal 63 | 64 | # Flask stuff: 65 | instance/ 66 | .webassets-cache 67 | 68 | # Scrapy stuff: 69 | .scrapy 70 | 71 | # Sphinx documentation 72 | docs/_build/ 73 | 74 | # PyBuilder 75 | target/ 76 | 77 | # Jupyter Notebook 78 | .ipynb_checkpoints 79 | 80 | # IPython 81 | profile_default/ 82 | ipython_config.py 83 | 84 | # pyenv 85 | .python-version 86 | 87 | # pipenv 88 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 89 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 90 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 91 | # install all needed dependencies. 92 | #Pipfile.lock 93 | 94 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow 95 | __pypackages__/ 96 | 97 | # Celery stuff 98 | celerybeat-schedule 99 | celerybeat.pid 100 | 101 | # SageMath parsed files 102 | *.sage.py 103 | 104 | # Environments 105 | .env 106 | .venv 107 | env/ 108 | venv/ 109 | ENV/ 110 | env.bak/ 111 | venv.bak/ 112 | 113 | # Spyder project settings 114 | .spyderproject 115 | .spyproject 116 | 117 | # Rope project settings 118 | .ropeproject 119 | 120 | # mkdocs documentation 121 | /site 122 | 123 | # mypy 124 | .mypy_cache/ 125 | .dmypy.json 126 | dmypy.json 127 | 128 | # Pyre type checker 129 | .pyre/ 130 | 131 | .vscode 132 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # Changelog 2 | 3 | ## [0.4.2](https://github.com/firefly-cpp/FireflyAlgorithm/tree/0.4.2) (2023-12-04) 4 | 5 | [Full Changelog](https://github.com/firefly-cpp/FireflyAlgorithm/compare/0.4.1...0.4.2) 6 | 7 | **Merged pull requests:** 8 | 9 | - Contribution guide [\#20](https://github.com/firefly-cpp/FireflyAlgorithm/pull/20) ([lahovniktadej](https://github.com/lahovniktadej)) 10 | 11 | ## [0.4.1](https://github.com/firefly-cpp/FireflyAlgorithm/tree/0.4.1) (2023-11-10) 12 | 13 | [Full Changelog](https://github.com/firefly-cpp/FireflyAlgorithm/compare/0.4.0...0.4.1) 14 | 15 | **Closed issues:** 16 | 17 | - Create Problems.md [\#18](https://github.com/firefly-cpp/FireflyAlgorithm/issues/18) 18 | 19 | **Merged pull requests:** 20 | 21 | - Add Test Function definitions [\#19](https://github.com/firefly-cpp/FireflyAlgorithm/pull/19) ([zStupan](https://github.com/zStupan)) 22 | 23 | ## [0.4.0](https://github.com/firefly-cpp/FireflyAlgorithm/tree/0.4.0) (2023-11-06) 24 | 25 | [Full Changelog](https://github.com/firefly-cpp/FireflyAlgorithm/compare/0.3.4...0.4.0) 26 | 27 | **Closed issues:** 28 | 29 | - Enhance tests [\#16](https://github.com/firefly-cpp/FireflyAlgorithm/issues/16) 30 | - Provide Command Line Interface \(CLI\) [\#13](https://github.com/firefly-cpp/FireflyAlgorithm/issues/13) 31 | - Add installation instructions for Arch Linux [\#11](https://github.com/firefly-cpp/FireflyAlgorithm/issues/11) 32 | 33 | **Merged pull requests:** 34 | 35 | - Add tests [\#17](https://github.com/firefly-cpp/FireflyAlgorithm/pull/17) ([zStupan](https://github.com/zStupan)) 36 | - Added a Command Line Interface [\#15](https://github.com/firefly-cpp/FireflyAlgorithm/pull/15) ([zStupan](https://github.com/zStupan)) 37 | - Improve workflows [\#14](https://github.com/firefly-cpp/FireflyAlgorithm/pull/14) ([firefly-cpp](https://github.com/firefly-cpp)) 38 | - Add instructions for install FireflyAlgorithm in Arch Linux [\#12](https://github.com/firefly-cpp/FireflyAlgorithm/pull/12) ([carlosal1015](https://github.com/carlosal1015)) 39 | 40 | ## [0.3.4](https://github.com/firefly-cpp/FireflyAlgorithm/tree/0.3.4) (2022-12-13) 41 | 42 | [Full Changelog](https://github.com/firefly-cpp/FireflyAlgorithm/compare/0.3.3...0.3.4) 43 | 44 | **Merged pull requests:** 45 | 46 | - logo add [\#10](https://github.com/firefly-cpp/FireflyAlgorithm/pull/10) ([rhododendrom](https://github.com/rhododendrom)) 47 | 48 | ## [0.3.3](https://github.com/firefly-cpp/FireflyAlgorithm/tree/0.3.3) (2022-10-31) 49 | 50 | [Full Changelog](https://github.com/firefly-cpp/FireflyAlgorithm/compare/0.3.2...0.3.3) 51 | 52 | ## [0.3.2](https://github.com/firefly-cpp/FireflyAlgorithm/tree/0.3.2) (2022-07-12) 53 | 54 | [Full Changelog](https://github.com/firefly-cpp/FireflyAlgorithm/compare/0.3.1...0.3.2) 55 | 56 | **Merged pull requests:** 57 | 58 | - Rename project name in pyproject.toml [\#9](https://github.com/firefly-cpp/FireflyAlgorithm/pull/9) ([firefly-cpp](https://github.com/firefly-cpp)) 59 | 60 | ## [0.3.1](https://github.com/firefly-cpp/FireflyAlgorithm/tree/0.3.1) (2022-06-05) 61 | 62 | [Full Changelog](https://github.com/firefly-cpp/FireflyAlgorithm/compare/0.3...0.3.1) 63 | 64 | ## [0.3](https://github.com/firefly-cpp/FireflyAlgorithm/tree/0.3) (2022-03-12) 65 | 66 | [Full Changelog](https://github.com/firefly-cpp/FireflyAlgorithm/compare/0.2...0.3) 67 | 68 | **Closed issues:** 69 | 70 | - python-fireflyalgorithm fails to build with Python 3.11.0a2. [\#6](https://github.com/firefly-cpp/FireflyAlgorithm/issues/6) 71 | - fireflyalgorithm fails to build with Python 3.11 [\#4](https://github.com/firefly-cpp/FireflyAlgorithm/issues/4) 72 | 73 | **Merged pull requests:** 74 | 75 | - Add test [\#8](https://github.com/firefly-cpp/FireflyAlgorithm/pull/8) ([firefly-cpp](https://github.com/firefly-cpp)) 76 | - Fix build error for python 3.11 [\#7](https://github.com/firefly-cpp/FireflyAlgorithm/pull/7) ([zStupan](https://github.com/zStupan)) 77 | - Enabled python3.11 support. [\#5](https://github.com/firefly-cpp/FireflyAlgorithm/pull/5) ([zStupan](https://github.com/zStupan)) 78 | - Update README [\#3](https://github.com/firefly-cpp/FireflyAlgorithm/pull/3) ([zStupan](https://github.com/zStupan)) 79 | 80 | ## [0.2](https://github.com/firefly-cpp/FireflyAlgorithm/tree/0.2) (2021-09-10) 81 | 82 | [Full Changelog](https://github.com/firefly-cpp/FireflyAlgorithm/compare/0.0.5...0.2) 83 | 84 | ## [0.0.5](https://github.com/firefly-cpp/FireflyAlgorithm/tree/0.0.5) (2021-09-10) 85 | 86 | [Full Changelog](https://github.com/firefly-cpp/FireflyAlgorithm/compare/0.0.4...0.0.5) 87 | 88 | **Merged pull requests:** 89 | 90 | - Update FA and switch to poetry [\#2](https://github.com/firefly-cpp/FireflyAlgorithm/pull/2) ([zStupan](https://github.com/zStupan)) 91 | 92 | ## [0.0.4](https://github.com/firefly-cpp/FireflyAlgorithm/tree/0.0.4) (2021-02-03) 93 | 94 | [Full Changelog](https://github.com/firefly-cpp/FireflyAlgorithm/compare/0.0.3...0.0.4) 95 | 96 | ## [0.0.3](https://github.com/firefly-cpp/FireflyAlgorithm/tree/0.0.3) (2021-02-03) 97 | 98 | [Full Changelog](https://github.com/firefly-cpp/FireflyAlgorithm/compare/0.0.2...0.0.3) 99 | 100 | ## [0.0.2](https://github.com/firefly-cpp/FireflyAlgorithm/tree/0.0.2) (2021-01-19) 101 | 102 | [Full Changelog](https://github.com/firefly-cpp/FireflyAlgorithm/compare/0.0.1...0.0.2) 103 | 104 | **Merged pull requests:** 105 | 106 | - Sort optimization [\#1](https://github.com/firefly-cpp/FireflyAlgorithm/pull/1) ([lukapecnik](https://github.com/lukapecnik)) 107 | 108 | ## [0.0.1](https://github.com/firefly-cpp/FireflyAlgorithm/tree/0.0.1) (2020-11-18) 109 | 110 | [Full Changelog](https://github.com/firefly-cpp/FireflyAlgorithm/compare/0.1...0.0.1) 111 | 112 | ## [0.1](https://github.com/firefly-cpp/FireflyAlgorithm/tree/0.1) (2020-11-18) 113 | 114 | [Full Changelog](https://github.com/firefly-cpp/FireflyAlgorithm/compare/170394dc2648db570d75873af470157dd2c18c25...0.1) 115 | 116 | 117 | 118 | \* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)* 119 | -------------------------------------------------------------------------------- /CITATION.cff: -------------------------------------------------------------------------------- 1 | abstract: Implementation of Firefly Algorithm in Python 2 | authors: 3 | - family-names: Fister Jr. 4 | given-names: Iztok 5 | orcid: 0000-0002-6418-1272 6 | - affiliation: '@poviolabs' 7 | family-names: "Pe\u010Dnik" 8 | given-names: Luka 9 | orcid: 0000-0002-3897-9774 10 | - family-names: Stupan 11 | given-names: "\u017Diga" 12 | orcid: 0000-0001-9847-7306 13 | cff-version: 1.2.0 14 | date-released: '2023-12-25' 15 | doi: 10.5281/zenodo.10430919 16 | license: 17 | - MIT 18 | repository-code: https://github.com/firefly-cpp/FireflyAlgorithm/tree/0.4.4 19 | title: 'firefly-cpp/FireflyAlgorithm: 0.4.4' 20 | type: software 21 | version: 0.4.4 22 | -------------------------------------------------------------------------------- /CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | # Contributor Covenant Code of Conduct 2 | 3 | ## Our Pledge 4 | 5 | In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. 6 | 7 | ## Our Standards 8 | 9 | Examples of behavior that contributes to creating a positive environment include: 10 | 11 | * Using welcoming and inclusive language 12 | * Being respectful of differing viewpoints and experiences 13 | * Gracefully accepting constructive criticism 14 | * Focusing on what is best for the community 15 | * Showing empathy towards other community members 16 | 17 | Examples of unacceptable behavior by participants include: 18 | 19 | * The use of sexualized language or imagery and unwelcome sexual attention or advances 20 | * Trolling, insulting/derogatory comments, and personal or political attacks 21 | * Public or private harassment 22 | * Publishing others' private information, such as a physical or electronic address, without explicit permission 23 | * Other conduct which could reasonably be considered inappropriate in a professional setting 24 | 25 | ## Our Responsibilities 26 | 27 | Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior. 28 | 29 | Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. 30 | 31 | ## Scope 32 | 33 | This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. 34 | 35 | ## Enforcement 36 | 37 | Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. 38 | 39 | Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. 40 | 41 | ## Attribution 42 | 43 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version] 44 | 45 | [homepage]: http://contributor-covenant.org 46 | [version]: http://contributor-covenant.org/version/1/4/ 47 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contributing to Firefly Algorithm 2 | :+1::tada: First off, thanks for taking the time to contribute! :tada::+1: 3 | 4 | ## Code of Conduct 5 | This project and everyone participating in it is governed by the [Firefly Algorithm Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [iztok.fister1@um.si](mailto:iztok.fister1@um.si). 6 | 7 | ## How Can I Contribute? 8 | 9 | ### Reporting Bugs 10 | Before creating bug reports, please check existing issues list as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible in the [issue template](.github/templates/ISSUE_TEMPLATE.md). 11 | 12 | ### Suggesting Enhancements 13 | 14 | Open new issue using the [feature request template](.github/templates/FEATURE_REQUEST.md). 15 | 16 | ### Pull requests 17 | 18 | Fill in the [pull request template](.github/templates/PULL_REQUEST.md) and make sure your code is documented. 19 | 20 | ## Setup development environment 21 | 22 | ### Requirements 23 | 24 | * Poetry: [https://python-poetry.org/docs](https://python-poetry.org/docs) 25 | 26 | After installing Poetry and cloning the project from GitHub, you should run the following command from the root of the cloned project: 27 | 28 | ```sh 29 | poetry install 30 | ``` 31 | 32 | All of the project's dependencies should be installed and the project ready for further development. **Note that Poetry creates a separate virtual environment for your project.** 33 | 34 | ### Dependencies 35 | 36 | | Package | Version | Platform | 37 | |----------|:-------:|:--------:| 38 | | numpy | ^1.26.1 | All | 39 | 40 | #### Development dependencies 41 | 42 | | Package | Version | Platform | 43 | |---------|:--------:|:--------:| 44 | | pytest | ^7.4.3 | Any | 45 | 46 | ## Development Tasks 47 | 48 | ### Testing 49 | 50 | Manually run the tests: 51 | 52 | ```sh 53 | poetry run pytest 54 | ``` -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2017-2023 firefly-cpp 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | 23 | -------------------------------------------------------------------------------- /Problems.md: -------------------------------------------------------------------------------- 1 | # Test Functions 2 | 3 | Bellow You'll find the definitions of all the test functions implemented in this package. 4 | 5 | ## Ackley 6 | ***Function name:*** `ackley` 7 | 8 | ```math 9 | f(x) = -20 e^{-0.2 \sqrt{D^{-1} \sum\nolimits_{i=1}^D x_i^2}} - e^{D^{-1} \sum\nolimits_{i=1}^D \cos(2 \pi x_i)} + 20 + e 10 | ``` 11 | 12 | **Dimensions:** $D$ 13 | 14 | **Global optimum:** $`f(x^*) = 0`$ for $`x_i^* = 0`$ 15 | 16 | ## Alpine 1 17 | ***Function name:*** `alpine1` 18 | 19 | ```math 20 | f(x) = \sum_{i=1}^{D} \lvert {x_i \sin \left( x_i \right) + 0.1 x_i} \rvert 21 | ``` 22 | 23 | **Dimensions:** $D$ 24 | 25 | **Global optimum:** $`f(x^*) = 0`$ for $`x_i^* = 0`$ 26 | 27 | ## Alpine 2 28 | ***Function name:*** `alpine2` 29 | 30 | ```math 31 | f(x) = \prod_{i=1}^{D} \sqrt{x_i} \sin(x_i) 32 | ``` 33 | 34 | **Dimensions:** $D$ 35 | 36 | **Global optimum:** $`f(x^*) = 2.808^D`$ for $`x_i^* = 7.917`$ 37 | 38 | ## Cigar 39 | ***Function name:*** `cigar` 40 | 41 | ```math 42 | f(x) = x_1^2 + 10^6\sum_{i=2}^{D} x_i^2 43 | ``` 44 | 45 | **Dimensions:** $D$ 46 | 47 | **Global optimum:** $`f(x^*) = 0`$ for $`x_i^* = 0`$ 48 | 49 | ## Cosine Mixture 50 | ***Function name:*** `cosine_mixture` 51 | 52 | ```math 53 | f(x) = -0.1 \sum_{i=1}^D \cos (5 \pi x_i) - \sum_{i=1}^D x_i^2 54 | ``` 55 | 56 | **Dimensions:** $D$ 57 | 58 | **Global optimum:** $`f(x^*) = -0.1 D`$ for $`x_i^* = 0`$ 59 | 60 | ## Csendes 61 | ***Function name:*** `csendes` 62 | 63 | ```math 64 | f(x) = \sum_{i=1}^D x_i^6 \left( 2 + \sin \frac{1}{x_i}\right) 65 | ``` 66 | 67 | **Dimensions:** $D$ 68 | 69 | **Global optimum:** $`f(x^*) = 0`$ for $`x_i^* = 0`$ 70 | 71 | ## Dixon-Price 72 | ***Function name:*** `dixon_price` 73 | 74 | ```math 75 | f(x) = (x_1 - 1)^2 + \sum_{i = 2}^D i (2x_i^2 - x_{i - 1})^2 76 | ``` 77 | 78 | **Dimensions:** $D$ 79 | 80 | **Global optimum:** $`f(x^*) = 0`$ for $`x_i^* = 2^{- \frac{(2^i - 2)}{2^i}}`$ 81 | 82 | ## Griewank 83 | ***Function name:*** `griewank` 84 | 85 | ```math 86 | f(x) = \sum_{i=1}^D \frac{x_i^2}{4000} - \prod_{i=1}^D \cos(\frac{x_i}{\sqrt{i}}) + 1 87 | ``` 88 | 89 | **Dimensions:** $D$ 90 | 91 | **Global optimum:** $`f(x^*) = 0`$ for $`x_i^* = 0`$ 92 | 93 | ## Katsuura 94 | ***Function name:*** `katsuura` 95 | 96 | ```math 97 | \prod_{i=1}^D \left(1 + i \sum_{j=1}^{32} \frac{\lvert 2^j x_i - round\left(2^j x_i \right) \rvert}{2^j} \right) 98 | ``` 99 | 100 | **Dimensions:** $D$ 101 | 102 | **Global optimum:** $`f(x^*) = 1`$ for $`x_i^* = 0`$ 103 | 104 | ## Levy 105 | ***Function name:*** `levy` 106 | 107 | ```math 108 | \begin{gather} 109 | \sin^2 (\pi w_1) + \sum_{i = 1}^{D - 1} (w_i - 1)^2 \left( 1 + 10 \sin^2 (\pi w_i + 1) \right) + (w_d - 1)^2 (1 + \sin^2 (2 \pi w_d)),\,\text{where}\\ 110 | w_i = 1 + \frac{x_i - 1}{4},\, \text{for all } i = 1, \ldots, D 111 | \end{gather} 112 | 113 | ``` 114 | 115 | **Dimensions:** $D$ 116 | 117 | **Global optimum:** $`f(x^*) = 0`$ for $`x_i^* = 1`$ 118 | 119 | ## Michalewicz 120 | ***Function name:*** `michalewicz` 121 | 122 | ```math 123 | f(x) = - \sum_{i = 1}^{D} \sin(x_i) \sin^{2m}\left( \frac{ix_i^2}{\pi} \right) 124 | ``` 125 | 126 | **Dimensions:** $D$ 127 | 128 | **Global optimum:** $`\text{at } D=2,\,f(x^*) = -1.8013`$ for $`x^* = (2.20, 1.57)`$ 129 | 130 | ## Perm 1 131 | ***Function name:*** `perm1` 132 | 133 | ```math 134 | f(x) = \sum_{i = 1}^D \left( \sum_{j = 1}^D (j^i + \beta) \left( \left(\frac{x_j}{j}\right)^i - 1 \right) \right)^2 135 | ``` 136 | 137 | **Dimensions:** $D$ 138 | 139 | **Global optimum:** $`f(x^*) = 0`$ for $`x_i^* = i`$ 140 | 141 | ## Perm 2 142 | ***Function name:*** `perm2` 143 | 144 | ```math 145 | f(x) = \sum_{i = 1}^D \left( \sum_{j = 1}^D (j - \beta) \left( x_j^i - \frac{1}{j^i} \right) \right)^2 146 | ``` 147 | 148 | **Dimensions:** $D$ 149 | 150 | **Global optimum:** $`f(x^*) = 0`$ for $`x_i^* = \frac{1}{i}`$ 151 | 152 | ## Pinter 153 | ***Function name:*** `pinter` 154 | 155 | ```math 156 | f(x) = \sum_{i=1}^D ix_i^2 + \sum_{i=1}^D 20i \sin^2 A + \sum_{i=1}^D i \log_{10} (1 + iB^2),\, \text{where} 157 | ``` 158 | ```math 159 | \begin{align} 160 | A &= (x_{i-1}\sin(x_i)+\sin(x_{i+1})) \\ 161 | B &= (x_{i-1}^2 - 2x_i + 3x_{i+1} - \cos(x_i) + 1) 162 | \end{align} 163 | ``` 164 | 165 | **Dimensions:** $D$ 166 | 167 | **Global optimum:** $`f(x^*) = 0`$ for $`x_i^* = 0`$ 168 | 169 | ## Powell 170 | ***Function name:*** `powell` 171 | 172 | ```math 173 | f(x) = \sum_{i = 1}^{D/4} \left[ (x_{4 i - 3} + 10 x_{4 i - 2})^2 + 5 (x_{4 i - 1} - x_{4 i})^2 + (x_{4 i - 2} - 2 x_{4 i - 1})^4 + 10 (x_{4 i - 3} - x_{4 i})^4 \right] 174 | ``` 175 | 176 | **Dimensions:** $D$ 177 | 178 | **Global optimum:** $`f(x^*) = 0`$ for $`x_i^* = 0`$ 179 | 180 | ## Qing 181 | ***Function name:*** `qing` 182 | 183 | ```math 184 | f(x) = \sum_{i=1}^D \left(x_i^2 - i\right)^2 185 | ``` 186 | 187 | **Dimensions:** $D$ 188 | 189 | **Global optimum:** $`f(x^*) = 0`$ for $`x_i^* = \pm \sqrt{i}`$ 190 | 191 | ## Quintic 192 | ***Function name:*** `quintic` 193 | 194 | ```math 195 | f(x) = \sum_{i=1}^D \left| x_i^5 - 3x_i^4 + 4x_i^3 + 2x_i^2 - 10x_i - 4\right| 196 | ``` 197 | 198 | **Dimensions:** $D$ 199 | 200 | **Global optimum:** $`f(x^*) = 0`$ for $`x_i^* = -1\quad \text{or} \quad x_i^* = 2`$ 201 | 202 | ## Rastrigin 203 | ***Function name:*** `rastrigin` 204 | 205 | ```math 206 | f(x) = 10D + \sum_{i=1}^D \left[x_i^2 -10\cos(2\pi x_i)\right] 207 | ``` 208 | 209 | **Dimensions:** $D$ 210 | 211 | **Global optimum:** $`f(x^*) = 0`$ for $`x_i^* = 0`$ 212 | 213 | ## Rosenbrock 214 | ***Function name:*** `rosenbrock` 215 | 216 | ```math 217 | f(x) = \sum_{i=1}^{D-1} \left[100 (x_{i+1} - x_i^2)^2 + (x_i - 1)^2 \right] 218 | ``` 219 | 220 | **Dimensions:** $D$ 221 | 222 | **Global optimum:** $`f(x^*) = 0`$ for $`x_i^* = 1`$ 223 | 224 | ## Salomon 225 | ***Function name:*** `salomon` 226 | 227 | ```math 228 | f(x) = 1 - \cos\left(2\pi\sqrt{\sum\nolimits_{i=1}^D x_i^2} \right)+ 0.1 \sqrt{\sum\nolimits_{i=1}^D x_i^2} 229 | ``` 230 | 231 | **Dimensions:** $D$ 232 | 233 | **Global optimum:** $`f(x^*) = 0`$ for $`x_i^* = 0`$ 234 | 235 | ## Schaffer 2 236 | ***Function name:*** `schaffer2` 237 | 238 | ```math 239 | f(x) = 0.5 + \frac{ \sin^2 \left( x_1^2 - x_2^2 \right) - 0.5 }{ \left[ 1 + 0.001 \left( x_1^2 + x_2^2 \right) \right]^2 } 240 | ``` 241 | 242 | **Dimensions:** 2 243 | 244 | **Global optimum:** $`f(x^*) = 0`$ for $`x^* = (0, 0)`$ 245 | 246 | ## Schaffer 4 247 | ***Function name:*** `schaffer4` 248 | 249 | ```math 250 | f(x) = 0.5 + \frac{ \cos^2 \left( \sin \left( \vert x_1^2 - x_2^2\vert \right) \right)- 0.5 }{ \left[ 1 + 0.001 \left( x_1^2 + x_2^2 \right) \right]^2 } 251 | ``` 252 | 253 | **Dimensions:** 2 254 | 255 | **Global optimum:** $`f(x^*) = 0.292579`$ for $`x^* = (0, \pm 1.25313) \text{or} (\pm 1.25313, 0)`$ 256 | 257 | ## Schwefel 258 | ***Function name:*** `schwefel` 259 | 260 | ```math 261 | f(x) = 418.9829D - \sum_{i=1}^{D} x_i \sin(\sqrt{\lvert x_i \rvert}) 262 | ``` 263 | 264 | **Dimensions:** $D$ 265 | 266 | **Global optimum:** $`f(x^*) = 0`$ for $`x_i^* = 420.9687`$ 267 | 268 | ## Schwefel 2.21 269 | ***Function name:*** `schwefel221` 270 | 271 | ```math 272 | f(x) = \max_{1 \leq i \leq D} \vert x_i\vert 273 | ``` 274 | 275 | **Dimensions:** $D$ 276 | 277 | **Global optimum:** $`f(x^*) = 0`$ for $`x_i^* = 0`$ 278 | 279 | ## Schwefel 2.22 280 | ***Function name:*** `schwefel222` 281 | 282 | ```math 283 | f(x) = \sum_{i=1}^{D} \lvert x_i \rvert +\prod_{i=1}^{D} \lvert x_i \rvert 284 | ``` 285 | 286 | **Dimensions:** $D$ 287 | 288 | **Global optimum:** $`f(x^*) = 0`$ for $`x_i^* = 0`$ 289 | 290 | ## Sphere 291 | ***Function name:*** `sphere` 292 | 293 | ```math 294 | f(x) = \sum_{i=1}^D x_i^2 295 | ``` 296 | 297 | **Dimensions:** $D$ 298 | 299 | **Global optimum:** $`f(x^*) = 0`$ for $`x_i^* = 0`$ 300 | 301 | ## Step 302 | ***Function name:*** `step` 303 | 304 | ```math 305 | f(x) = \sum_{i=1}^D \left( \lfloor \lvert x_i \rvert \rfloor \right) 306 | ``` 307 | 308 | **Dimensions:** $D$ 309 | 310 | **Global optimum:** $`f(x^*) = 0`$ for $`x_i^* = 0`$ 311 | 312 | ## Step 2 313 | ***Function name:*** `step2` 314 | 315 | ```math 316 | f(x) = \sum_{i=1}^D \left( \lfloor x_i + 0.5 \rfloor \right)^2 317 | ``` 318 | 319 | **Dimensions:** $D$ 320 | 321 | **Global optimum:** $`f(x^*) = 0`$ for $`x_i^* = -0.5`$ 322 | 323 | ## Styblinski-Tang 324 | ***Function name:*** `styblinski_tang` 325 | 326 | ```math 327 | 328 | ``` 329 | 330 | **Dimensions:** $D$ 331 | 332 | **Global optimum:** $`f(x^*) = -39.16599 D`$ for $`x_i^* = -2.903534`$ 333 | 334 | ## Trid 335 | ***Function name:*** `trid` 336 | 337 | ```math 338 | f(x) = \sum_{i = 1}^D \left( x_i - 1 \right)^2 - \sum_{i = 2}^D x_i x_{i - 1} 339 | ``` 340 | 341 | **Dimensions:** $D$ 342 | 343 | **Global optimum:** $`f(x^*) = \frac{-D (D + 4) (D - 1)}{6}`$ for $`x_i^* = i (d + 1 - i)`$ 344 | 345 | ## Weierstrass 346 | ***Function name:*** `weierstrass` 347 | 348 | ```math 349 | f(x) = \sum_{i=1}^D \left[ \sum_{k=0}^{k_{max}} a^k \cos\left( 2 \pi b^k ( x_i + 0.5) \right) \right] - D \sum_{k=0}^{k_{max}} a^k \cos \left(\pi b^k \right) 350 | ``` 351 | 352 | **Dimensions:** $D$ 353 | 354 | **Global optimum:** $`f(x^*) = 0`$ for $`x_i^* = 0`$ 355 | 356 | ## Whitley 357 | ***Function name:*** `whitley` 358 | 359 | ```math 360 | f(x) = \sum_{i=1}^D \sum_{j=1}^D \left[\frac{(100(x_i^2-x_j)^2 + (1-x_j)^2)^2}{4000} - \cos(100(x_i^2-x_j)^2 + (1-x_j)^2)+1\right] 361 | ``` 362 | 363 | **Dimensions:** $D$ 364 | 365 | **Global optimum:** $`f(x^*) = 0`$ for $`x_i^* = 1`$ 366 | 367 | ## Zakharov 368 | ***Function name:*** `zakharov` 369 | 370 | ```math 371 | f(x) = \sum_{i = 1}^D x_i^2 + \left( \sum_{i = 1}^D 0.5 i x_i \right)^2 + \left( \sum_{i = 1}^D 0.5 i x_i \right)^4 372 | ``` 373 | 374 | **Dimensions:** $D$ 375 | 376 | **Global optimum:** $`f(x^*) = 0`$ for $`x_i^* = 0`$ 377 | 378 | 379 | # References 380 | 381 | [1] P. Ernesto and U. Diliman, [“MVF–Multivariate Test Functions Library in C for Unconstrained Global Optimization,”](http://www.geocities.ws/eadorio/mvf.pdf) University of the Philippines Diliman, Quezon City, 2005. 382 | 383 | [2] M. Jamil and X.-S. Yang, [“A literature survey of benchmark functions for global optimisation problems,”](https://arxiv.org/abs/1308.4008) International Journal of Mathematical Modelling and Numerical Optimisation, vol. 4, no. 2, p. 150, Jan. 2013, doi: 10.1504/ijmmno.2013.055204. 384 | 385 | [3] J. J. Liang, B. Y. Qu, and P. N. Suganthan, [“Problem definitions and evaluation criteria for the CEC 2014 special session and competition on single objective real-parameter numerical optimization,”](http://bee22.com/manual/tf_images/Liang%20CEC2014.pdf) Computational Intelligence Laboratory, Zhengzhou University, Zhengzhou China and Technical Report, Nanyang Technological University, Singapore, vol. 635, no. 2, 2013. 386 | 387 | [4] S. Surjanovic and D. Bingham, Virtual Library of Simulation Experiments: Test Functions and Datasets. Retrieved November 7, 2023, from https://www.sfu.ca/~ssurjano/. 388 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 |

2 | 3 |

4 | 5 |

6 | Firefly Algorithm --- Implementation of Firefly algorithm in Python 7 |

8 | 9 |

10 | PyPI Version 11 | PyPI - Python Version 12 | Downloads 13 | GitHub repo size 14 | AUR package 15 | GitHub license 16 | build 17 |

18 | 19 |

20 | GitHub commit activity 21 | Average time to resolve an issue 22 | Percentage of issues still open 23 | GitHub contributors 24 | Packaging status 25 |

26 | 27 |

28 | DOI 29 |

30 | 31 |

32 | 📋 About • 33 | 📦 Installation • 34 | 🚀 Usage • 35 | 📚 Reference Papers • 36 | 📄 Cite us • 37 | 🔑 License 38 |

39 | 40 | ## 📋 About 41 | 42 | This package implements a nature-inspired algorithm for optimization called Firefly Algorithm (FA) in Python programming language. 🌿🔍💻 43 | 44 | ## 📦 Installation 45 | 46 | To install FireflyAlgorithm with pip, use: 47 | ```sh 48 | pip install fireflyalgorithm 49 | ``` 50 | To install FireflyAlgorithm on Fedora, use: 51 | ```sh 52 | dnf install python-fireflyalgorithm 53 | ``` 54 | To install FireflyAlgorithm on Arch Linux, please use an [AUR helper](https://wiki.archlinux.org/title/AUR_helpers): 55 | ```sh 56 | $ yay -Syyu python-fireflyalgorithm 57 | ``` 58 | To install FireflyAlgorithm on Alpine Linux, use: 59 | ```sh 60 | $ apk add py3-fireflyalgorithm 61 | ``` 62 | 63 | ## 🚀 Usage 64 | 65 | ```python 66 | from fireflyalgorithm import FireflyAlgorithm 67 | from fireflyalgorithm.problems import sphere 68 | 69 | FA = FireflyAlgorithm() 70 | best = FA.run(function=sphere, dim=10, lb=-5, ub=5, max_evals=10000) 71 | 72 | print(best) 73 | ``` 74 | 75 | ### Test functions 📈 76 | 77 | In the `fireflyalgorithm.problems` module, you can find the implementations of 33 popular optimization test problems. Additionally, the module provides a utility function, `get_problem`, that allows you to retrieve a specific optimization problem function by providing its name as a string: 78 | 79 | ```python 80 | from fireflyalgorithm.problems import get_problem 81 | 82 | # same as from fireflyalgorithm.problems import rosenbrock 83 | rosenbrock = get_problem('rosenbrock') 84 | ``` 85 | 86 | For more information about the implemented test functions, [click here](Problems.md). 87 | 88 | ### Command line interface 🖥️ 89 | 90 | The package also comes with a simple command line interface which allows you to evaluate the algorithm on several popular test functions. 🔬 91 | 92 | ```shell 93 | firefly-algorithm -h 94 | ``` 95 | 96 | ```text 97 | usage: firefly-algorithm [-h] --problem PROBLEM -d DIMENSION -l LOWER -u UPPER -nfes MAX_EVALS [-r RUNS] [--pop-size POP_SIZE] [--alpha ALPHA] [--beta-min BETA_MIN] [--gamma GAMMA] [--seed SEED] 98 | 99 | Evaluate the Firefly Algorithm on one or more test functions 100 | 101 | options: 102 | -h, --help show this help message and exit 103 | --problem PROBLEM Test problem to evaluate 104 | -d DIMENSION, --dimension DIMENSION 105 | Dimension of the problem 106 | -l LOWER, --lower LOWER 107 | Lower bounds of the problem 108 | -u UPPER, --upper UPPER 109 | Upper bounds of the problem 110 | -nfes MAX_EVALS, --max-evals MAX_EVALS 111 | Max number of fitness function evaluations 112 | -r RUNS, --runs RUNS Number of runs of the algorithm 113 | --pop-size POP_SIZE Population size 114 | --alpha ALPHA Randomness strength 115 | --beta-min BETA_MIN Attractiveness constant 116 | --gamma GAMMA Absorption coefficient 117 | --seed SEED Seed for the random number generator 118 | ``` 119 | 120 | **Note:** The CLI script can also run as a python module (python -m fireflyalgorithm ...). 121 | 122 | 123 | ## 📚 Reference Papers 124 | 125 | I. Fister Jr., X.-S. Yang, I. Fister, J. Brest, D. Fister. [A Brief Review of Nature-Inspired Algorithms for Optimization](http://www.iztok-jr-fister.eu/static/publications/21.pdf). Elektrotehniški vestnik, 80(3), 116-122, 2013. 126 | 127 | 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. 128 | Jozef Stefan Institute, Ljubljana, Slovenia, 2012 129 | 130 | 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. 131 | 132 | ## 📄 Cite us 133 | 134 | Fister Jr., I., Pečnik, L., & Stupan, Ž. (2023). firefly-cpp/FireflyAlgorithm: 0.4.3 (0.4.3). Zenodo. [https://doi.org/10.5281/zenodo.10430919](https://doi.org/10.5281/zenodo.10430919) 135 | 136 | ## 🔑 License 137 | 138 | This package is distributed under the MIT License. This license can be found online at . 139 | 140 | ## Disclaimer 141 | 142 | This framework is provided as-is, and there are no guarantees that it fits your purposes or that it is bug-free. Use it at your own risk! 143 | -------------------------------------------------------------------------------- /examples/run.py: -------------------------------------------------------------------------------- 1 | from fireflyalgorithm import FireflyAlgorithm 2 | from fireflyalgorithm.problems import sphere 3 | 4 | 5 | FA = FireflyAlgorithm() 6 | best = FA.run(function=sphere, dim=10, lb=-5, ub=5, max_evals=10000) 7 | 8 | print(best) 9 | -------------------------------------------------------------------------------- /fireflyalgorithm/__init__.py: -------------------------------------------------------------------------------- 1 | from fireflyalgorithm.fireflyalgorithm import FireflyAlgorithm 2 | 3 | __all__ = ["FireflyAlgorithm"] 4 | 5 | __version__ = "0.4.6" 6 | -------------------------------------------------------------------------------- /fireflyalgorithm/__main__.py: -------------------------------------------------------------------------------- 1 | import sys 2 | from fireflyalgorithm import cli 3 | 4 | 5 | if __name__ == "__main__": 6 | sys.exit(cli.main()) 7 | -------------------------------------------------------------------------------- /fireflyalgorithm/cli.py: -------------------------------------------------------------------------------- 1 | import argparse 2 | import numpy as np 3 | from fireflyalgorithm.problems import PROBLEMS, get_problem 4 | from fireflyalgorithm.fireflyalgorithm import FireflyAlgorithm 5 | 6 | 7 | def get_parser(): 8 | parser = argparse.ArgumentParser( 9 | prog="firefly-algorithm", 10 | description="Evaluate the Firefly Algorithm on one or more test functions", 11 | ) 12 | 13 | problem_functions = list(PROBLEMS.keys()) 14 | parser.add_argument( 15 | "--problem", 16 | type=str, 17 | required=True, 18 | choices=problem_functions, 19 | metavar="PROBLEM", 20 | help="Test problem to evaluate", 21 | ) 22 | parser.add_argument( 23 | "-d", "--dimension", type=int, required=True, help="Dimension of the problem" 24 | ) 25 | parser.add_argument( 26 | "-l", "--lower", type=float, required=True, help="Lower bounds of the problem" 27 | ) 28 | parser.add_argument( 29 | "-u", "--upper", type=float, required=True, help="Upper bounds of the problem" 30 | ) 31 | parser.add_argument( 32 | "-nfes", 33 | "--max-evals", 34 | type=int, 35 | required=True, 36 | help="Max number of fitness function evaluations", 37 | ) 38 | parser.add_argument( 39 | "-r", "--runs", type=int, default=1, help="Number of runs of the algorithm" 40 | ) 41 | parser.add_argument("--pop-size", type=int, default=20, help="Population size") 42 | parser.add_argument("--alpha", type=float, default=1.0, help="Randomness strength") 43 | parser.add_argument( 44 | "--beta-min", type=float, default=1.0, help="Attractiveness constant" 45 | ) 46 | parser.add_argument( 47 | "--gamma", type=float, default=0.01, help="Absorption coefficient" 48 | ) 49 | parser.add_argument("--seed", type=int, help="Seed for the random number generator") 50 | return parser 51 | 52 | 53 | def main(): 54 | parser = get_parser() 55 | args = parser.parse_args() 56 | 57 | algorithm = FireflyAlgorithm( 58 | args.pop_size, args.alpha, args.beta_min, args.gamma, args.seed 59 | ) 60 | problem = get_problem(args.problem) 61 | dim = args.dimension 62 | lb = args.lower 63 | ub = args.upper 64 | max_evals = args.max_evals 65 | runs = args.runs 66 | 67 | fitness = np.empty(runs) 68 | for i in range(runs): 69 | fitness[i] = algorithm.run(problem, dim, lb, ub, max_evals) 70 | 71 | if runs == 1: 72 | print(f"Best fitness: {fitness[0]}") 73 | else: 74 | print(f"Best: {fitness.min()}") 75 | print(f"Worst: {fitness.max()}") 76 | print(f"Mean: {fitness.mean()}") 77 | print(f"Std: {fitness.std()}") 78 | 79 | return 0 80 | -------------------------------------------------------------------------------- /fireflyalgorithm/fireflyalgorithm.py: -------------------------------------------------------------------------------- 1 | import numpy as np 2 | from numpy.random import default_rng 3 | 4 | 5 | class FireflyAlgorithm: 6 | def __init__(self, pop_size=20, alpha=1.0, betamin=1.0, gamma=0.01, seed=None): 7 | self.pop_size = pop_size 8 | self.alpha = alpha 9 | self.betamin = betamin 10 | self.gamma = gamma 11 | self.rng = default_rng(seed) 12 | 13 | def run(self, function, dim, lb, ub, max_evals): 14 | fireflies = self.rng.uniform(lb, ub, (self.pop_size, dim)) 15 | intensity = np.apply_along_axis(function, 1, fireflies) 16 | best = np.min(intensity) 17 | 18 | evaluations = self.pop_size 19 | new_alpha = self.alpha 20 | search_range = ub - lb 21 | 22 | while evaluations <= max_evals: 23 | new_alpha *= 0.97 24 | for i in range(self.pop_size): 25 | for j in range(self.pop_size): 26 | if intensity[i] >= intensity[j]: 27 | r = np.sum(np.square(fireflies[i] - fireflies[j]), axis=-1) 28 | beta = self.betamin * np.exp(-self.gamma * r) 29 | steps = new_alpha * (self.rng.random(dim) - 0.5) * search_range 30 | fireflies[i] += beta * (fireflies[j] - fireflies[i]) + steps 31 | fireflies[i] = np.clip(fireflies[i], lb, ub) 32 | intensity[i] = function(fireflies[i]) 33 | evaluations += 1 34 | best = min(intensity[i], best) 35 | return best 36 | -------------------------------------------------------------------------------- /fireflyalgorithm/problems.py: -------------------------------------------------------------------------------- 1 | import numpy as np 2 | 3 | 4 | def ackley(x): 5 | a = 20 6 | b = 0.2 7 | c = 2 * np.pi 8 | dim = len(x) 9 | 10 | val1 = np.sum(np.square(x)) 11 | val2 = np.sum(np.cos(c * x)) 12 | 13 | temp1 = -b * np.sqrt(val1 / dim) 14 | temp2 = val2 / dim 15 | 16 | return -a * np.exp(temp1) - np.exp(temp2) + a + np.exp(1) 17 | 18 | 19 | def alpine1(x): 20 | return np.sum(np.abs(np.sin(x) + 0.1 * x)) 21 | 22 | 23 | def alpine2(x): 24 | return np.prod(np.sqrt(x) * np.sin(x)) 25 | 26 | 27 | def cigar(x): 28 | return x[0] ** 2 + 1000000 * np.sum(x[1:] ** 2) 29 | 30 | 31 | def cosine_mixture(x): 32 | return -0.1 * np.sum(np.cos(5 * np.pi * x)) - np.sum(x**2) 33 | 34 | 35 | def csendes(x): 36 | mask = x != 0 37 | return np.sum(np.power(x[mask], 6) * (2 + np.sin(1 / x[mask]))) 38 | 39 | 40 | def dixon_price(x): 41 | dim = len(x) 42 | indices = np.arange(2, dim) 43 | val = np.sum(indices * (2 * x[2:] ** 2 - x[1 : dim - 1]) ** 2) 44 | return (x[0] - 1) ** 2 + val 45 | 46 | 47 | def griewank(x): 48 | dim = len(x) 49 | i = np.arange(1, dim + 1) 50 | val1 = np.sum(x**2 / 4000) 51 | val2 = np.prod(np.cos(x / np.sqrt(i))) 52 | return val1 - val2 + 1 53 | 54 | 55 | def katsuura(x): 56 | dim = len(x) 57 | k = np.atleast_2d(np.arange(1, 33)).T 58 | i = np.arange(1, dim + 1) 59 | inner = np.round(2**k * x) * (2.0 ** (-k)) 60 | return np.prod(np.sum(inner, axis=0) * i + 1) 61 | 62 | 63 | def levy(x): 64 | w = 1 + (x - 1) / 4 65 | wi = w[:-1] 66 | term1 = np.sin(np.pi * w[0]) ** 2 67 | term2 = np.sum((wi - 1) ** 2 * (1 + 10 * np.sin(np.pi * wi + 1))) 68 | term3 = (w[-1] - 1) ** 2 * (1 + np.sin(2 * np.pi * w[-1]) ** 2) 69 | return term1 + term2 + term3 70 | 71 | 72 | def michalewicz(x): 73 | dim = len(x) 74 | m = 10 75 | i = np.arange(1, dim + 1) 76 | return -np.sum(np.sin(x) * np.sin(i * x**2 / np.pi) ** (2 * m)) 77 | 78 | 79 | def perm1(x): 80 | dim = len(x) 81 | beta = 0.5 82 | k = np.atleast_2d(np.arange(dim) + 1).T 83 | j = np.atleast_2d(np.arange(dim) + 1) 84 | s = (j**k + beta) * ((x / j) ** k - 1) 85 | return np.sum(np.sum(s, axis=1) ** 2) 86 | 87 | 88 | def perm2(x): 89 | dim = len(x) 90 | beta = 10 91 | k = np.atleast_2d(np.arange(dim) + 1).T 92 | j = np.atleast_2d(np.arange(dim) + 1) 93 | s = (j + beta) * (x**k - (1 / j) ** k) 94 | return np.sum(np.sum(s, axis=1) ** 2) 95 | 96 | 97 | def pinter(x): 98 | dim = len(x) 99 | x = np.asarray(x) 100 | sub = np.roll(x, 1) 101 | add = np.roll(x, -1) 102 | indices = np.arange(1, dim + 1) 103 | 104 | a = sub * np.sin(x) + np.sin(add) 105 | b = (sub * sub) - 2 * x + 3 * add - np.cos(x) + 1 106 | 107 | val1 = np.sum(indices * x * x) 108 | val2 = np.sum(20 * indices * np.power(np.sin(a), 2)) 109 | val3 = np.sum(indices * np.log10(1 + indices * np.power(b, 2))) 110 | 111 | return val1 + val2 + val3 112 | 113 | 114 | def powell(x): 115 | x1 = x[0::4] 116 | x2 = x[1::4] 117 | x3 = x[2::4] 118 | x4 = x[3::4] 119 | 120 | term1 = (x1 + 10 * x2) ** 2 121 | term2 = 5 * (x3 - x4) ** 2 122 | term3 = (x2 - 2 * x3) ** 4 123 | term4 = 10 * (x1 - x4) ** 4 124 | return np.sum(term1 + term2 + term3 + term4) 125 | 126 | 127 | def qing(x): 128 | dim = len(x) 129 | return np.sum(np.power(x**2 - np.arange(1, dim + 1), 2)) 130 | 131 | 132 | def quintic(x): 133 | return np.sum(np.abs(x**5 - 3 * x**4 + 4 * x**3 + 2 * x**2 - 10 * x - 4)) 134 | 135 | 136 | def rastrigin(x): 137 | dim = len(x) 138 | return 10 * dim + np.sum(x**2 - 10 * np.cos(2 * np.pi * x)) 139 | 140 | 141 | def rosenbrock(x): 142 | return np.sum(100.0 * (x[1:] - x[:-1] ** 2) ** 2 + (1 - x[:-1]) ** 2, axis=0) 143 | 144 | 145 | def salomon(x): 146 | val = np.sqrt(np.sum(x**2)) 147 | return 1 - np.cos(2 * np.pi * val) + 0.1 * val 148 | 149 | 150 | def schaffer2(x): 151 | return ( 152 | 0.5 153 | + (np.sin(x[0] ** 2 - x[1] ** 2) ** 2 - 0.5) 154 | / (1 + 0.001 * (x[0] ** 2 + x[1] ** 2)) ** 2 155 | ) 156 | 157 | 158 | def schaffer4(x): 159 | return ( 160 | 0.5 161 | + (np.cos(np.sin(abs(x[0] ** 2 - x[1] ** 2))) ** 2 - 0.5) 162 | / (1 + 0.001 * (x[0] ** 2 + x[1] ** 2)) ** 2 163 | ) 164 | 165 | 166 | def schwefel(x): 167 | dim = len(x) 168 | return 418.982887272433799807913601398 * dim - np.sum( 169 | x * np.sin(np.sqrt(np.abs(x))) 170 | ) 171 | 172 | 173 | def schwefel221(x): 174 | return np.amax(np.abs(x)) 175 | 176 | 177 | def schwefel222(x): 178 | return np.sum(np.abs(x)) + np.prod(np.abs(x)) 179 | 180 | 181 | def sphere(x): 182 | return np.sum(x**2) 183 | 184 | 185 | def step(x): 186 | return np.sum(np.floor(np.abs(x))) 187 | 188 | 189 | def step2(x): 190 | return np.sum(np.floor(x + 0.5) ** 2) 191 | 192 | 193 | def styblinski_tang(x): 194 | return 0.5 * np.sum(x**4 - 16 * x**2 + 5 * x) 195 | 196 | 197 | def trid(x): 198 | sum1 = np.sum((x - 1) ** 2) 199 | sum2 = np.sum(x[1:] * x[:-1]) 200 | return sum1 - sum2 201 | 202 | 203 | def weierstrass(x): 204 | dim = len(x) 205 | kmax = 20 206 | a = 0.5 207 | b = 3 208 | 209 | k = np.atleast_2d(np.arange(kmax + 1)).T 210 | t1 = a**k * np.cos(2 * np.pi * b**k * (x + 0.5)) 211 | t2 = dim * np.sum(a**k.T * np.cos(np.pi * b**k.T)) 212 | 213 | return np.sum(np.sum(t1, axis=0)) - t2 214 | 215 | 216 | def whitley(x): 217 | xi = x 218 | xj = np.atleast_2d(x).T 219 | 220 | temp = 100 * ((xi**2) - xj) + (1 - xj) ** 2 221 | inner = (temp**2 / 4000) - np.cos(temp) + 1 222 | return np.sum(np.sum(inner, axis=0)) 223 | 224 | 225 | def zakharov(x): 226 | dim = len(x) 227 | sum1 = np.sum(x**2) 228 | sum2 = 0.5 * np.sum(np.arange(1, dim + 1) * x) 229 | return sum1 + sum2**2 + sum2**4 230 | 231 | 232 | PROBLEMS = { 233 | "ackley": ackley, 234 | "alpine1": alpine1, 235 | "alpine2": alpine2, 236 | "cigar": cigar, 237 | "cosine_mixture": cosine_mixture, 238 | "csendes": csendes, 239 | "dixon_price": dixon_price, 240 | "griewank": griewank, 241 | "katsuura": katsuura, 242 | "levy": levy, 243 | "michalewicz": michalewicz, 244 | "perm1": perm1, 245 | "perm2": perm2, 246 | "pinter": pinter, 247 | "powell": powell, 248 | "qing": qing, 249 | "quintic": quintic, 250 | "rastrigin": rastrigin, 251 | "rosenbrock": rosenbrock, 252 | "salomon": salomon, 253 | "schaffer2": schaffer2, 254 | "schaffer4": schaffer4, 255 | "schwefel": schwefel, 256 | "schwefel221": schwefel221, 257 | "schwefel222": schwefel222, 258 | "sphere": sphere, 259 | "step": step, 260 | "step2": step2, 261 | "styblinski_tang": styblinski_tang, 262 | "trid": trid, 263 | "weierstrass": weierstrass, 264 | "whitley": whitley, 265 | "zakharov": zakharov, 266 | } 267 | 268 | 269 | def get_problem(name): 270 | return PROBLEMS[name] 271 | -------------------------------------------------------------------------------- /poetry.lock: -------------------------------------------------------------------------------- 1 | # This file is automatically @generated by Poetry 1.8.3 and should not be changed by hand. 2 | 3 | [[package]] 4 | name = "colorama" 5 | version = "0.4.6" 6 | description = "Cross-platform colored terminal text." 7 | optional = false 8 | python-versions = "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,!=3.5.*,!=3.6.*,>=2.7" 9 | files = [ 10 | {file = "colorama-0.4.6-py2.py3-none-any.whl", hash = "sha256:4f1d9991f5acc0ca119f9d443620b77f9d6b33703e51011c16baf57afb285fc6"}, 11 | {file = "colorama-0.4.6.tar.gz", hash = "sha256:08695f5cb7ed6e0531a20572697297273c47b8cae5a63ffc6d6ed5c201be6e44"}, 12 | ] 13 | 14 | [[package]] 15 | name = "exceptiongroup" 16 | version = "1.2.2" 17 | description = "Backport of PEP 654 (exception groups)" 18 | optional = false 19 | python-versions = ">=3.7" 20 | files = [ 21 | {file = "exceptiongroup-1.2.2-py3-none-any.whl", hash = "sha256:3111b9d131c238bec2f8f516e123e14ba243563fb135d3fe885990585aa7795b"}, 22 | {file = "exceptiongroup-1.2.2.tar.gz", hash = "sha256:47c2edf7c6738fafb49fd34290706d1a1a2f4d1c6df275526b62cbb4aa5393cc"}, 23 | ] 24 | 25 | [package.extras] 26 | test = ["pytest (>=6)"] 27 | 28 | [[package]] 29 | name = "iniconfig" 30 | version = "2.0.0" 31 | description = "brain-dead simple config-ini parsing" 32 | optional = false 33 | python-versions = ">=3.7" 34 | files = [ 35 | {file = "iniconfig-2.0.0-py3-none-any.whl", hash = "sha256:b6a85871a79d2e3b22d2d1b94ac2824226a63c6b741c88f7ae975f18b6778374"}, 36 | {file = "iniconfig-2.0.0.tar.gz", hash = "sha256:2d91e135bf72d31a410b17c16da610a82cb55f6b0477d1a902134b24a455b8b3"}, 37 | ] 38 | 39 | [[package]] 40 | name = "numpy" 41 | version = "1.26.4" 42 | description = "Fundamental package for array computing in Python" 43 | optional = false 44 | python-versions = ">=3.9" 45 | files = [ 46 | {file = "numpy-1.26.4-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:9ff0f4f29c51e2803569d7a51c2304de5554655a60c5d776e35b4a41413830d0"}, 47 | {file = "numpy-1.26.4-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:2e4ee3380d6de9c9ec04745830fd9e2eccb3e6cf790d39d7b98ffd19b0dd754a"}, 48 | {file = "numpy-1.26.4-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:d209d8969599b27ad20994c8e41936ee0964e6da07478d6c35016bc386b66ad4"}, 49 | {file = "numpy-1.26.4-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:ffa75af20b44f8dba823498024771d5ac50620e6915abac414251bd971b4529f"}, 50 | {file = "numpy-1.26.4-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:62b8e4b1e28009ef2846b4c7852046736bab361f7aeadeb6a5b89ebec3c7055a"}, 51 | {file = "numpy-1.26.4-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:a4abb4f9001ad2858e7ac189089c42178fcce737e4169dc61321660f1a96c7d2"}, 52 | {file = "numpy-1.26.4-cp310-cp310-win32.whl", hash = "sha256:bfe25acf8b437eb2a8b2d49d443800a5f18508cd811fea3181723922a8a82b07"}, 53 | {file = "numpy-1.26.4-cp310-cp310-win_amd64.whl", hash = "sha256:b97fe8060236edf3662adfc2c633f56a08ae30560c56310562cb4f95500022d5"}, 54 | {file = "numpy-1.26.4-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:4c66707fabe114439db9068ee468c26bbdf909cac0fb58686a42a24de1760c71"}, 55 | {file = "numpy-1.26.4-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:edd8b5fe47dab091176d21bb6de568acdd906d1887a4584a15a9a96a1dca06ef"}, 56 | {file = "numpy-1.26.4-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:7ab55401287bfec946ced39700c053796e7cc0e3acbef09993a9ad2adba6ca6e"}, 57 | {file = "numpy-1.26.4-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:666dbfb6ec68962c033a450943ded891bed2d54e6755e35e5835d63f4f6931d5"}, 58 | {file = "numpy-1.26.4-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:96ff0b2ad353d8f990b63294c8986f1ec3cb19d749234014f4e7eb0112ceba5a"}, 59 | {file = "numpy-1.26.4-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:60dedbb91afcbfdc9bc0b1f3f402804070deed7392c23eb7a7f07fa857868e8a"}, 60 | {file = "numpy-1.26.4-cp311-cp311-win32.whl", hash = "sha256:1af303d6b2210eb850fcf03064d364652b7120803a0b872f5211f5234b399f20"}, 61 | {file = "numpy-1.26.4-cp311-cp311-win_amd64.whl", hash = "sha256:cd25bcecc4974d09257ffcd1f098ee778f7834c3ad767fe5db785be9a4aa9cb2"}, 62 | {file = "numpy-1.26.4-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:b3ce300f3644fb06443ee2222c2201dd3a89ea6040541412b8fa189341847218"}, 63 | {file = "numpy-1.26.4-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:03a8c78d01d9781b28a6989f6fa1bb2c4f2d51201cf99d3dd875df6fbd96b23b"}, 64 | {file = "numpy-1.26.4-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:9fad7dcb1aac3c7f0584a5a8133e3a43eeb2fe127f47e3632d43d677c66c102b"}, 65 | {file = "numpy-1.26.4-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:675d61ffbfa78604709862923189bad94014bef562cc35cf61d3a07bba02a7ed"}, 66 | {file = "numpy-1.26.4-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:ab47dbe5cc8210f55aa58e4805fe224dac469cde56b9f731a4c098b91917159a"}, 67 | {file = "numpy-1.26.4-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:1dda2e7b4ec9dd512f84935c5f126c8bd8b9f2fc001e9f54af255e8c5f16b0e0"}, 68 | {file = "numpy-1.26.4-cp312-cp312-win32.whl", hash = "sha256:50193e430acfc1346175fcbdaa28ffec49947a06918b7b92130744e81e640110"}, 69 | {file = "numpy-1.26.4-cp312-cp312-win_amd64.whl", hash = "sha256:08beddf13648eb95f8d867350f6a018a4be2e5ad54c8d8caed89ebca558b2818"}, 70 | {file = "numpy-1.26.4-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:7349ab0fa0c429c82442a27a9673fc802ffdb7c7775fad780226cb234965e53c"}, 71 | {file = "numpy-1.26.4-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:52b8b60467cd7dd1e9ed082188b4e6bb35aa5cdd01777621a1658910745b90be"}, 72 | {file = "numpy-1.26.4-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:d5241e0a80d808d70546c697135da2c613f30e28251ff8307eb72ba696945764"}, 73 | {file = "numpy-1.26.4-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:f870204a840a60da0b12273ef34f7051e98c3b5961b61b0c2c1be6dfd64fbcd3"}, 74 | {file = "numpy-1.26.4-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:679b0076f67ecc0138fd2ede3a8fd196dddc2ad3254069bcb9faf9a79b1cebcd"}, 75 | {file = "numpy-1.26.4-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:47711010ad8555514b434df65f7d7b076bb8261df1ca9bb78f53d3b2db02e95c"}, 76 | {file = "numpy-1.26.4-cp39-cp39-win32.whl", hash = "sha256:a354325ee03388678242a4d7ebcd08b5c727033fcff3b2f536aea978e15ee9e6"}, 77 | {file = "numpy-1.26.4-cp39-cp39-win_amd64.whl", hash = "sha256:3373d5d70a5fe74a2c1bb6d2cfd9609ecf686d47a2d7b1d37a8f3b6bf6003aea"}, 78 | {file = "numpy-1.26.4-pp39-pypy39_pp73-macosx_10_9_x86_64.whl", hash = "sha256:afedb719a9dcfc7eaf2287b839d8198e06dcd4cb5d276a3df279231138e83d30"}, 79 | {file = "numpy-1.26.4-pp39-pypy39_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:95a7476c59002f2f6c590b9b7b998306fba6a5aa646b1e22ddfeaf8f78c3a29c"}, 80 | {file = "numpy-1.26.4-pp39-pypy39_pp73-win_amd64.whl", hash = "sha256:7e50d0a0cc3189f9cb0aeb3a6a6af18c16f59f004b866cd2be1c14b36134a4a0"}, 81 | {file = "numpy-1.26.4.tar.gz", hash = "sha256:2a02aba9ed12e4ac4eb3ea9421c420301a0c6460d9830d74a9df87efa4912010"}, 82 | ] 83 | 84 | [[package]] 85 | name = "packaging" 86 | version = "24.2" 87 | description = "Core utilities for Python packages" 88 | optional = false 89 | python-versions = ">=3.8" 90 | files = [ 91 | {file = "packaging-24.2-py3-none-any.whl", hash = "sha256:09abb1bccd265c01f4a3aa3f7a7db064b36514d2cba19a2f694fe6150451a759"}, 92 | {file = "packaging-24.2.tar.gz", hash = "sha256:c228a6dc5e932d346bc5739379109d49e8853dd8223571c7c5b55260edc0b97f"}, 93 | ] 94 | 95 | [[package]] 96 | name = "pluggy" 97 | version = "1.5.0" 98 | description = "plugin and hook calling mechanisms for python" 99 | optional = false 100 | python-versions = ">=3.8" 101 | files = [ 102 | {file = "pluggy-1.5.0-py3-none-any.whl", hash = "sha256:44e1ad92c8ca002de6377e165f3e0f1be63266ab4d554740532335b9d75ea669"}, 103 | {file = "pluggy-1.5.0.tar.gz", hash = "sha256:2cffa88e94fdc978c4c574f15f9e59b7f4201d439195c3715ca9e2486f1d0cf1"}, 104 | ] 105 | 106 | [package.extras] 107 | dev = ["pre-commit", "tox"] 108 | testing = ["pytest", "pytest-benchmark"] 109 | 110 | [[package]] 111 | name = "pytest" 112 | version = "7.4.4" 113 | description = "pytest: simple powerful testing with Python" 114 | optional = false 115 | python-versions = ">=3.7" 116 | files = [ 117 | {file = "pytest-7.4.4-py3-none-any.whl", hash = "sha256:b090cdf5ed60bf4c45261be03239c2c1c22df034fbffe691abe93cd80cea01d8"}, 118 | {file = "pytest-7.4.4.tar.gz", hash = "sha256:2cf0005922c6ace4a3e2ec8b4080eb0d9753fdc93107415332f50ce9e7994280"}, 119 | ] 120 | 121 | [package.dependencies] 122 | colorama = {version = "*", markers = "sys_platform == \"win32\""} 123 | exceptiongroup = {version = ">=1.0.0rc8", markers = "python_version < \"3.11\""} 124 | iniconfig = "*" 125 | packaging = "*" 126 | pluggy = ">=0.12,<2.0" 127 | tomli = {version = ">=1.0.0", markers = "python_version < \"3.11\""} 128 | 129 | [package.extras] 130 | testing = ["argcomplete", "attrs (>=19.2.0)", "hypothesis (>=3.56)", "mock", "nose", "pygments (>=2.7.2)", "requests", "setuptools", "xmlschema"] 131 | 132 | [[package]] 133 | name = "tomli" 134 | version = "2.2.1" 135 | description = "A lil' TOML parser" 136 | optional = false 137 | python-versions = ">=3.8" 138 | files = [ 139 | {file = "tomli-2.2.1-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:678e4fa69e4575eb77d103de3df8a895e1591b48e740211bd1067378c69e8249"}, 140 | {file = "tomli-2.2.1-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:023aa114dd824ade0100497eb2318602af309e5a55595f76b626d6d9f3b7b0a6"}, 141 | {file = "tomli-2.2.1-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:ece47d672db52ac607a3d9599a9d48dcb2f2f735c6c2d1f34130085bb12b112a"}, 142 | {file = "tomli-2.2.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:6972ca9c9cc9f0acaa56a8ca1ff51e7af152a9f87fb64623e31d5c83700080ee"}, 143 | {file = "tomli-2.2.1-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:c954d2250168d28797dd4e3ac5cf812a406cd5a92674ee4c8f123c889786aa8e"}, 144 | {file = "tomli-2.2.1-cp311-cp311-musllinux_1_2_aarch64.whl", hash = "sha256:8dd28b3e155b80f4d54beb40a441d366adcfe740969820caf156c019fb5c7ec4"}, 145 | {file = "tomli-2.2.1-cp311-cp311-musllinux_1_2_i686.whl", hash = "sha256:e59e304978767a54663af13c07b3d1af22ddee3bb2fb0618ca1593e4f593a106"}, 146 | {file = "tomli-2.2.1-cp311-cp311-musllinux_1_2_x86_64.whl", hash = "sha256:33580bccab0338d00994d7f16f4c4ec25b776af3ffaac1ed74e0b3fc95e885a8"}, 147 | {file = "tomli-2.2.1-cp311-cp311-win32.whl", hash = "sha256:465af0e0875402f1d226519c9904f37254b3045fc5084697cefb9bdde1ff99ff"}, 148 | {file = "tomli-2.2.1-cp311-cp311-win_amd64.whl", hash = "sha256:2d0f2fdd22b02c6d81637a3c95f8cd77f995846af7414c5c4b8d0545afa1bc4b"}, 149 | {file = "tomli-2.2.1-cp312-cp312-macosx_10_13_x86_64.whl", hash = "sha256:4a8f6e44de52d5e6c657c9fe83b562f5f4256d8ebbfe4ff922c495620a7f6cea"}, 150 | {file = "tomli-2.2.1-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:8d57ca8095a641b8237d5b079147646153d22552f1c637fd3ba7f4b0b29167a8"}, 151 | {file = "tomli-2.2.1-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:4e340144ad7ae1533cb897d406382b4b6fede8890a03738ff1683af800d54192"}, 152 | {file = "tomli-2.2.1-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:db2b95f9de79181805df90bedc5a5ab4c165e6ec3fe99f970d0e302f384ad222"}, 153 | {file = "tomli-2.2.1-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:40741994320b232529c802f8bc86da4e1aa9f413db394617b9a256ae0f9a7f77"}, 154 | {file = "tomli-2.2.1-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:400e720fe168c0f8521520190686ef8ef033fb19fc493da09779e592861b78c6"}, 155 | {file = "tomli-2.2.1-cp312-cp312-musllinux_1_2_i686.whl", hash = "sha256:02abe224de6ae62c19f090f68da4e27b10af2b93213d36cf44e6e1c5abd19fdd"}, 156 | {file = "tomli-2.2.1-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:b82ebccc8c8a36f2094e969560a1b836758481f3dc360ce9a3277c65f374285e"}, 157 | {file = "tomli-2.2.1-cp312-cp312-win32.whl", hash = "sha256:889f80ef92701b9dbb224e49ec87c645ce5df3fa2cc548664eb8a25e03127a98"}, 158 | {file = "tomli-2.2.1-cp312-cp312-win_amd64.whl", hash = "sha256:7fc04e92e1d624a4a63c76474610238576942d6b8950a2d7f908a340494e67e4"}, 159 | {file = "tomli-2.2.1-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:f4039b9cbc3048b2416cc57ab3bda989a6fcf9b36cf8937f01a6e731b64f80d7"}, 160 | {file = "tomli-2.2.1-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:286f0ca2ffeeb5b9bd4fcc8d6c330534323ec51b2f52da063b11c502da16f30c"}, 161 | {file = "tomli-2.2.1-cp313-cp313-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:a92ef1a44547e894e2a17d24e7557a5e85a9e1d0048b0b5e7541f76c5032cb13"}, 162 | {file = "tomli-2.2.1-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:9316dc65bed1684c9a98ee68759ceaed29d229e985297003e494aa825ebb0281"}, 163 | {file = "tomli-2.2.1-cp313-cp313-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:e85e99945e688e32d5a35c1ff38ed0b3f41f43fad8df0bdf79f72b2ba7bc5272"}, 164 | {file = "tomli-2.2.1-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:ac065718db92ca818f8d6141b5f66369833d4a80a9d74435a268c52bdfa73140"}, 165 | {file = "tomli-2.2.1-cp313-cp313-musllinux_1_2_i686.whl", hash = "sha256:d920f33822747519673ee656a4b6ac33e382eca9d331c87770faa3eef562aeb2"}, 166 | {file = "tomli-2.2.1-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:a198f10c4d1b1375d7687bc25294306e551bf1abfa4eace6650070a5c1ae2744"}, 167 | {file = "tomli-2.2.1-cp313-cp313-win32.whl", hash = "sha256:d3f5614314d758649ab2ab3a62d4f2004c825922f9e370b29416484086b264ec"}, 168 | {file = "tomli-2.2.1-cp313-cp313-win_amd64.whl", hash = "sha256:a38aa0308e754b0e3c67e344754dff64999ff9b513e691d0e786265c93583c69"}, 169 | {file = "tomli-2.2.1-py3-none-any.whl", hash = "sha256:cb55c73c5f4408779d0cf3eef9f762b9c9f147a77de7b258bef0a5628adc85cc"}, 170 | {file = "tomli-2.2.1.tar.gz", hash = "sha256:cd45e1dc79c835ce60f7404ec8119f2eb06d38b1deba146f07ced3bbc44505ff"}, 171 | ] 172 | 173 | [metadata] 174 | lock-version = "2.0" 175 | python-versions = "^3.9,<3.14" 176 | content-hash = "3cd4e3325b88b677715a63c130cd79d70a3e3586c0df36c5d40aba429342caa7" 177 | -------------------------------------------------------------------------------- /pyproject.toml: -------------------------------------------------------------------------------- 1 | [tool.poetry] 2 | name = "fireflyalgorithm" 3 | version = "0.4.6" 4 | description = "Implementation of Firefly Algorithm in Python" 5 | authors = ["Iztok Fister Jr. ", "Luka Pečnik ", "Žiga Stupan "] 6 | keywords = ['computational intelligence', 'firefly algorithm', 'swarm intelligence', 'optimization'] 7 | license = "MIT" 8 | readme = "README.md" 9 | homepage = "https://github.com/firefly-cpp/FireflyAlgorithm" 10 | repository = "https://github.com/firefly-cpp/FireflyAlgorithm" 11 | 12 | include = [ 13 | { path="LICENSE", format="sdist" }, 14 | { path="Problems.md", format="sdist" } 15 | ] 16 | 17 | [tool.poetry.dependencies] 18 | python = "^3.9,<3.14" 19 | numpy = "^1.26.1" 20 | 21 | [tool.poetry.group.test.dependencies] 22 | pytest = "^7.4.3" 23 | 24 | [tool.poetry.scripts] 25 | firefly-algorithm = 'fireflyalgorithm.cli:main' 26 | 27 | [build-system] 28 | requires = ["poetry-core"] 29 | build-backend = "poetry.core.masonry.api" 30 | -------------------------------------------------------------------------------- /tests/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/firefly-cpp/FireflyAlgorithm/121b1852a5ae3951034aa49e119d0fd44f1525f9/tests/__init__.py -------------------------------------------------------------------------------- /tests/test_firefly.py: -------------------------------------------------------------------------------- 1 | from unittest import TestCase 2 | from fireflyalgorithm import FireflyAlgorithm 3 | from fireflyalgorithm.problems import sphere 4 | 5 | 6 | class TestFA(TestCase): 7 | def test_algorithm(self): 8 | algorithm = FireflyAlgorithm() 9 | best = algorithm.run(function=sphere, dim=10, lb=-5, ub=5, max_evals=10000) 10 | self.assertLess(best, 5) 11 | -------------------------------------------------------------------------------- /tests/test_problems.py: -------------------------------------------------------------------------------- 1 | from unittest import TestCase 2 | import numpy as np 3 | from fireflyalgorithm.problems import ( 4 | get_problem, 5 | ackley, 6 | alpine1, 7 | alpine2, 8 | cigar, 9 | cosine_mixture, 10 | csendes, 11 | dixon_price, 12 | griewank, 13 | katsuura, 14 | levy, 15 | michalewicz, 16 | perm1, 17 | perm2, 18 | pinter, 19 | powell, 20 | qing, 21 | quintic, 22 | rastrigin, 23 | rosenbrock, 24 | salomon, 25 | schaffer2, 26 | schaffer4, 27 | schwefel, 28 | schwefel221, 29 | schwefel222, 30 | sphere, 31 | step, 32 | step2, 33 | styblinski_tang, 34 | trid, 35 | weierstrass, 36 | whitley, 37 | zakharov, 38 | ) 39 | 40 | 41 | class TestProblems(TestCase): 42 | def test_problem_factory(self): 43 | self.assertRaises(KeyError, get_problem, "spherekjl2") 44 | self.assertEqual(get_problem("ackley"), ackley) 45 | self.assertEqual(get_problem("alpine1"), alpine1) 46 | self.assertEqual(get_problem("alpine2"), alpine2) 47 | self.assertEqual(get_problem("cigar"), cigar) 48 | self.assertEqual(get_problem("cosine_mixture"), cosine_mixture) 49 | self.assertEqual(get_problem("csendes"), csendes) 50 | self.assertEqual(get_problem("dixon_price"), dixon_price) 51 | self.assertEqual(get_problem("griewank"), griewank) 52 | self.assertEqual(get_problem("katsuura"), katsuura) 53 | self.assertEqual(get_problem("levy"), levy) 54 | self.assertEqual(get_problem("michalewicz"), michalewicz) 55 | self.assertEqual(get_problem("perm1"), perm1) 56 | self.assertEqual(get_problem("perm2"), perm2) 57 | self.assertEqual(get_problem("pinter"), pinter) 58 | self.assertEqual(get_problem("powell"), powell) 59 | self.assertEqual(get_problem("qing"), qing) 60 | self.assertEqual(get_problem("quintic"), quintic) 61 | self.assertEqual(get_problem("rastrigin"), rastrigin) 62 | self.assertEqual(get_problem("rosenbrock"), rosenbrock) 63 | self.assertEqual(get_problem("salomon"), salomon) 64 | self.assertEqual(get_problem("schaffer2"), schaffer2) 65 | self.assertEqual(get_problem("schaffer4"), schaffer4) 66 | self.assertEqual(get_problem("schwefel"), schwefel) 67 | self.assertEqual(get_problem("schwefel221"), schwefel221) 68 | self.assertEqual(get_problem("schwefel222"), schwefel222) 69 | self.assertEqual(get_problem("sphere"), sphere) 70 | self.assertEqual(get_problem("step"), step) 71 | self.assertEqual(get_problem("step2"), step2) 72 | self.assertEqual(get_problem("styblinski_tang"), styblinski_tang) 73 | self.assertEqual(get_problem("trid"), trid) 74 | self.assertEqual(get_problem("weierstrass"), weierstrass) 75 | self.assertEqual(get_problem("whitley"), whitley) 76 | self.assertEqual(get_problem("zakharov"), zakharov) 77 | 78 | def test_ackley(self): 79 | x = np.zeros(5) 80 | self.assertAlmostEqual(ackley(x), 0.0) 81 | 82 | def test_alpine1(self): 83 | x = np.zeros(5) 84 | self.assertAlmostEqual(alpine1(x), 0.0) 85 | 86 | def test_alpine2(self): 87 | x = np.full(5, 7.9170526982459462172) 88 | self.assertAlmostEqual(alpine2(x), 2.8081311800070053291**5) 89 | 90 | def test_cigar(self): 91 | x = np.zeros(5) 92 | self.assertAlmostEqual(cigar(x), 0.0) 93 | 94 | def test_cosine_mixture(self): 95 | x = np.zeros(5) 96 | self.assertAlmostEqual(cosine_mixture(x), -0.5) 97 | 98 | def test_csendes(self): 99 | x = np.zeros(5) 100 | self.assertAlmostEqual(csendes(x), 0.0) 101 | 102 | def test_dixon_price(self): 103 | x = np.array([2 ** -((2**i - 2) / 2**i) for i in range(1, 6)]) 104 | self.assertAlmostEqual(dixon_price(x), 0.0) 105 | 106 | def test_griewank(self): 107 | x = np.zeros(5) 108 | self.assertAlmostEqual(griewank(x), 0.0) 109 | 110 | def test_katsuura(self): 111 | x = np.zeros(5) 112 | self.assertAlmostEqual(katsuura(x), 1.0) 113 | 114 | def test_levy(self): 115 | x = np.full(5, 1) 116 | self.assertAlmostEqual(levy(x), 0.0) 117 | 118 | def test_michalewicz(self): 119 | x = np.array([2.20290552014618, 1.57079632677565]) 120 | self.assertAlmostEqual(michalewicz(x), -1.80130341009855321) 121 | 122 | def test_perm1(self): 123 | x = np.arange(1, 6) 124 | self.assertAlmostEqual(perm1(x), 0.0) 125 | 126 | def test_perm2(self): 127 | x = 1 / np.arange(1, 6) 128 | self.assertAlmostEqual(perm2(x), 0.0) 129 | 130 | def test_pinter(self): 131 | x = np.zeros(5) 132 | self.assertAlmostEqual(pinter(x), 0.0) 133 | 134 | def test_powell(self): 135 | x = np.zeros(5) 136 | self.assertAlmostEqual(powell(x), 0.0) 137 | 138 | def test_qing(self): 139 | x = np.sqrt(np.arange(1, 6)) 140 | self.assertAlmostEqual(qing(x), 0.0) 141 | 142 | def test_quintic(self): 143 | x = np.full(5, -1) 144 | self.assertAlmostEqual(quintic(x), 0.0) 145 | 146 | def test_rastrigin(self): 147 | x = np.zeros(5) 148 | self.assertAlmostEqual(rastrigin(x), 0.0) 149 | 150 | def test_rosenbrock(self): 151 | x = np.full(5, 1) 152 | self.assertAlmostEqual(rosenbrock(x), 0.0) 153 | 154 | def test_salomon(self): 155 | x = np.zeros(5) 156 | self.assertAlmostEqual(rastrigin(x), 0.0) 157 | 158 | def test_schaffer2(self): 159 | x = np.zeros(5) 160 | self.assertAlmostEqual(schaffer2(x), 0.0) 161 | 162 | def test_schaffer4(self): 163 | x1 = np.array([0, 1.253131828792882]) 164 | x2 = np.array([0, -1.253131828792882]) 165 | x3 = np.array([1.253131828792882, 0]) 166 | x4 = np.array([-1.253131828792882, 0]) 167 | self.assertAlmostEqual(schaffer4(x1), 0.292578632035980) 168 | self.assertAlmostEqual(schaffer4(x2), 0.292578632035980) 169 | self.assertAlmostEqual(schaffer4(x3), 0.292578632035980) 170 | self.assertAlmostEqual(schaffer4(x4), 0.292578632035980) 171 | 172 | def test_schwefel(self): 173 | x = np.full(5, 420.968746) 174 | self.assertAlmostEqual(schwefel(x), 0.0) 175 | 176 | def test_schwefel21(self): 177 | x = np.zeros(5) 178 | self.assertAlmostEqual(schwefel221(x), 0.0) 179 | 180 | def test_schwefel22(self): 181 | x = np.zeros(5) 182 | self.assertAlmostEqual(schwefel222(x), 0.0) 183 | 184 | def test_sphere(self): 185 | x = np.zeros(5) 186 | self.assertAlmostEqual(sphere(x), 0.0) 187 | 188 | def test_step(self): 189 | x = np.full(5, 0.5) 190 | self.assertAlmostEqual(step(x), 0.0) 191 | 192 | def test_step2(self): 193 | x = np.full(5, -0.5) 194 | self.assertAlmostEqual(step2(x), 0.0) 195 | 196 | def test_styblinski_tang(self): 197 | x = np.full(5, -2.903534018185960) 198 | self.assertAlmostEqual(styblinski_tang(x), -39.16616570377142 * 5) 199 | 200 | def test_trid(self): 201 | x = np.array([6, 10, 12, 12, 10, 6]) 202 | self.assertAlmostEqual(trid(x), -50) 203 | 204 | def test_weierstrass(self): 205 | x = np.zeros(5) 206 | self.assertAlmostEqual(weierstrass(x), 0.0) 207 | 208 | def test_whitley(self): 209 | x = np.full(5, 1) 210 | self.assertAlmostEqual(whitley(x), 0.0) 211 | 212 | def test_zakharov(self): 213 | x = np.zeros(5) 214 | self.assertAlmostEqual(zakharov(x), 0.0) 215 | --------------------------------------------------------------------------------