Added a decorator that can be used to automatically increase the counter variable, in objects that inherit GeneticOperator.

Author: vrettasm

pygenalgo/operators/genetic_operator.py

@@ -2,7 +2,7 @@
 from numpy.random import default_rng, Generator
 
 # Public interface.
-__all__ = ["GeneticOperator"]
+__all__ = ["GeneticOperator", "increase_counter"]
 
 # Author.
 __author__ = "Michalis Vrettas, PhD"
@@ -11,6 +11,27 @@
 __email__ = "[email protected]"
 
 
+def increase_counter(method):
+    """
+    Decorator function that is used in the derived
+    classes main operation to increase the counter
+    by one.
+
+    :param method: that we wrapp its functionality.
+
+    :return: the wrapper function.
+    """
+    def wrapper(self, *args, **kwargs):
+        # Increase the counter.
+        self.inc_counter()
+
+        # Return the output of the wrapped method.
+        return method(self, *args, **kwargs)
+    # _end_def_
+    return wrapper
+# _end_def_
+
+
 class GeneticOperator(object):
     """
     Description: