Add wraps decorator to preserve the functions' signatures

Adjust docu

Author: HaaLeo

CHANGELOG.md

@@ -3,9 +3,10 @@ All notable changes to the "swarmlib" pypi package will be documented in this fi
 This project follows [semantic versioning](https://semver.org/).
 
 ## Unreleased
+* **Added** [landscapes](https://github.com/nathanrooy/landscapes#readme) as a dependency to enable more benchmark functions ([#15](https://github.com/HaaLeo/swarmlib/issues/15)). Contributed by Alex F ([@alxfmpl](https://github.com/alxfmpl)). Thanks a lot 🚀.
 
 ## 2020-07-21 - v0.9.0
-* Added _grey wolf optimizer_ ([#12](https://github.com/HaaLeo/swarmlib/issues/12)). Perform the grey wolf optimization algorithm on one of the selected 2D-functions. Contributed by Nimish Verma ([@NimishVerma](https://github.com/NimishVerma)) and greatly appreciated 🚀.
+* **Added** _grey wolf optimizer_ ([#12](https://github.com/HaaLeo/swarmlib/issues/12)). Perform the grey wolf optimization algorithm on one of the selected 2D-functions. Contributed by Nimish Verma ([@NimishVerma](https://github.com/NimishVerma)) and greatly appreciated 🚀.
 
 ## 2020-04-13 - v0.8.1
 * **Fixed** a bug that caused the ACO algorithm to fail. Due to other third party packages swarmlib now requires `matplotlib<3.2.0`.

CONTRIBUTING.md

@@ -9,6 +9,7 @@ The following is a set of guidelines for contributing to the [`swarmlib`](https:
   * [Reporting Bugs](#reporting-bugs)
   * [Suggesting Enhancements](#suggesting-enhancements)
   * [Code Contribution](#code-contribution)
+  * [Functions](#functions)
   * [Pull Requests](#pull-requests)
 
 ## How Can I Contribute?
@@ -88,6 +89,12 @@ swarmlib
 
 To get started, I recommend you to take a look at the implementation of the CS, PSO, ABC algorithms.
 
+### Functions
+
+As of release _v0.10.0_ swarmlib uses the functions supplied by [landscapes](https://github.com/nathanrooy/landscapes#readme).
+If you are missing a benchmark function please open an issue in the landscapes repository. 
+Once the function is implemented there we are happy to update swarmlib's landscapes dependency.
+
 ### Pull Requests
 
 Please follow these steps to have your contribution considered:

README.md

@@ -64,11 +64,9 @@ The implementation was part of the course [Natural computing for learning and op
 
 #### Features
 
-Enables to apply the firefly algorithm to one of the provided 2D functions. The algorithm tries to find the global minimum of the selected function.  
-
-Currently two functions can be selected:
-* [ackley](https://www.sfu.ca/~ssurjano/ackley.html)
-* [michalewicz](https://www.sfu.ca/~ssurjano/michal.html)
+Enables to apply the firefly algorithm to a 2D function.
+The algorithm tries to find the global minimum of the selected function.
+Any of [landscapes'](https://github.com/nathanrooy/landscapes#readme) 2D or nD functions can be selected.
 
 ![firefly algorithm](https://raw.githubusercontent.com/HaaLeo/swarmlib/master/doc/fireflies.gif)
 
@@ -96,11 +94,9 @@ This repository also implements the _cuckoo search_ that was introduced by Xin-S
 
 #### Features
 
-Enables to apply cuckoo search to one of the provided 2D functions. The algorithm tries to find the global minimum of the selected function.  
-
-Currently two functions can be selected:
-* [ackley](https://www.sfu.ca/~ssurjano/ackley.html)
-* [michalewicz](https://www.sfu.ca/~ssurjano/michal.html)
+Enables to apply cuckoo search to one of the provided 2D functions.
+The algorithm tries to find the global minimum of the selected function.
+Any of [landscapes'](https://github.com/nathanrooy/landscapes#readme) 2D or nD functions can be selected.
 
 ![cukoo search](https://raw.githubusercontent.com/HaaLeo/swarmlib/master/doc/cuckoos.gif)
 
@@ -129,11 +125,9 @@ This repository also implements modified _particle swarm optimization_ that was
 
 #### Features
 
-Enables particle swarm optimization to one of the provided 2D functions. The algorithm tries to find the global minimum of the selected function.  
-
-Currently two functions can be selected:
-* [ackley](https://www.sfu.ca/~ssurjano/ackley.html)
-* [michalewicz](https://www.sfu.ca/~ssurjano/michal.html)
+Enables particle swarm optimization to one of the provided 2D functions.
+The algorithm tries to find the global minimum of the selected function.
+Any of [landscapes'](https://github.com/nathanrooy/landscapes#readme) 2D or nD functions can be selected.
 
 ![particle swarm optimization](https://raw.githubusercontent.com/HaaLeo/swarmlib/master/doc/particles.gif)
 
@@ -198,11 +192,10 @@ Research has shown that the flight behavior of birds, fruit flies and other inse
 
 #### Features
 
-Enables the ABC algorithm to one of the provided 2D functions. The algorithm tries to find the global minimum of the selected function.
+Enables the ABC algorithm to one of the provided 2D functions.
+The algorithm tries to find the global minimum of the selected function.
+Any of [landscapes'](https://github.com/nathanrooy/landscapes#readme) 2D or nD functions can be selected.
 
-Currently two functions can be selected:
-* [ackley](https://www.sfu.ca/~ssurjano/ackley.html)
-* [michalewicz](https://www.sfu.ca/~ssurjano/michal.html)
 
 ![ABC Sample](https://raw.githubusercontent.com/HaaLeo/swarmlib/master/doc/bees.gif)
 
@@ -234,11 +227,9 @@ The paper proposed a novel algorithm based on the hunting and the hierarchy stru
 
 #### Features
 
-Enables the GWO algorithm to one of the provided 2D functions. The algorithm tries to find the global minimum of the selected function.
-
-Currently two functions can be selected:
-* [ackley](https://www.sfu.ca/~ssurjano/ackley.html)
-* [michalewicz](https://www.sfu.ca/~ssurjano/michal.html)
+Enables the GWO algorithm to one of the provided 2D functions.
+The algorithm tries to find the global minimum of the selected function.
+Any of [landscapes'](https://github.com/nathanrooy/landscapes#readme) 2D or nD functions can be selected.
 
 ![GWO Sample](https://raw.githubusercontent.com/HaaLeo/swarmlib/master/doc/gwo.gif)
 

swarmlib/util/functions.py

@@ -6,13 +6,15 @@
 #pylint: disable=invalid-name
 
 import inspect
+from functools import wraps
 
 import landscapes.single_objective
 import numpy as np
 
 
 # Wrapper for landscapes.single_objective functions for inputs > 1d
 def wrap_landscapes_func(landscapes_func):
+    @wraps(landscapes_func)
     def wrapper(x):
         return np.apply_along_axis(func1d=landscapes_func, axis=0, arr=x)
     return wrapper
@@ -24,5 +26,5 @@ def wrapper(x):
     for (name, func) in inspect.getmembers(
         landscapes.single_objective, inspect.isfunction
     )
-    if name not in ['colville', 'wolfe'] # Don't include 3D and 4D functions
+    if name not in ['colville', 'wolfe']  # Don't include 3D and 4D functions
 }