From 99cca4b02abe0df884e696476706d8cf6b95430d Mon Sep 17 00:00:00 2001
From: Krzysztof Rudnicki <krzysztofrudnicki0@gmail.com>
Date: Wed, 12 Apr 2023 18:16:46 +0200
Subject: [PATCH] feat: add user input

---
 lab3/main.py | 97 ++++++++++++++++++++++++++++++++++++++++++++--------
 1 file changed, 82 insertions(+), 15 deletions(-)

diff --git a/lab3/main.py b/lab3/main.py
index d4cf97b6..039062f6 100644
--- a/lab3/main.py
+++ b/lab3/main.py
@@ -1,8 +1,9 @@
 """
-Program that optimizes Rastrigin function: f (x, y) = 
+Program that optimizes Rastrigin function: f (x, y) =
 20 + (x^2 - 10cos(2πx)) + (y^2 - 10 cos(2πy)).
 Using Evolutionary Strategy (μ, λ).
 """
+import sys
 import numpy as np
 
 
@@ -12,25 +13,35 @@ def rastrigin(x_argument, y_argument):
         y_argument**2 - 10 * np.cos(2 * np.pi * y_argument)
 
 
-def evolution_strategy(top_individuals, lambda_, sigma, iterations):
+def evolution_strategy(
+        number_of_parents=5,
+        size_of_population=20,
+        mutation_strength=0.1,
+        iterations=100,
+        min_max=(-5.12, 5.12)
+):
     """ Define the Evolutionary Strategy (μ, λ) algorithm """
     # Initialize the population
-    population = np.random.uniform(low=-5.12, high=5.12, size=(lambda_, 2))
+    population = np.random.uniform(
+        low=min_max[0], high=min_max[1], size=(
+            size_of_population, 2))
 
     # Iterate for a fixed number of iterations
     for i in range(iterations):
         # Evaluate the fitness of each individual
         fitness = np.array([rastrigin(x, y) for x, y in population])
 
-        # Select the top top_individuals individuals
-        parents = population[np.argsort(fitness)[:top_individuals]]
+        # Select the top number_of_parents individuals
+        parents = population[np.argsort(fitness)[:number_of_parents]]
 
         # Generate the next generation of lambda individuals by recombination
-        children = np.concatenate(
-            [np.random.permutation(parents) for i in range(lambda_ // top_individuals)])
+        children = np.concatenate([np.random.permutation(
+            parents) for i in range(size_of_population // number_of_parents)])
 
         # Add mutation to the children
-        mutation = np.random.normal(loc=0, scale=sigma, size=(lambda_, 2))
+        mutation = np.random.normal(
+            loc=0, scale=mutation_strength, size=(
+                size_of_population, 2))
         population = children + mutation
 
     # Evaluate the fitness of the final population
@@ -41,17 +52,73 @@ def evolution_strategy(top_individuals, lambda_, sigma, iterations):
     return population[best_idx], fitness[best_idx]
 
 
+def print_help():
+    """ Print program functionality and how to access it """
+    print("""
+    python main.py - Default functionality optimizing Rastrigin function f (x, y) =
+    20 + (x^2 - 10cos(2πx)) + (y^2 - 10 cos(2πy))
+    using Evolutionary Strategy (μ, λ), using only default values
+    Default values:
+    number_of_parents=5,
+    size_of_population=20,
+    stadard_deviation=0.1,
+    iterations=100,
+    min_value=-5.12,
+    max_value=5.12
+
+    python main.py -h --help print this prompt
+    Any of the default values an be changed using arguments:
+    -nop --number_of_parents [number]
+    -sop --size_of_population [number]
+    -ms --mutation_strength [number]
+    -i --iterations [number]
+    -min --min_value [number]
+    -max --max_value [number]
+    Those arguments can be given in any order and any argument which was not entered will be replaced with default value,
+    exemplary use:
+    python main.py -nop 5 -sop 20 -s 0.1 -i 100 -min -5.12 -max 5.12
+    """)
+
+
+def user_input():
+    """ Handle user terminal arguments"""
+    arguments = {
+        "number_of_parents": 5,
+        "size_of_population": 20,
+        "standard_deviation": 0.1,
+        "iterations": 100,
+        "min": -5.12,
+        "max": 5.12}
+    for argument in enumerate(sys.argv):
+        if argument in ('-h', '--help'):
+            print_help()
+            sys.exit()
+        if argument in ('-nop', '--number_of_parents'):
+            arguments["number_of_parents"] = float(argument)
+        if argument in ('-sop', '--size_of_population'):
+            arguments["size_of_population"] = float(argument)
+        if argument in ('-ms', '--mutation_strength'):
+            arguments["standard_deviation"] = float(argument)
+        if argument in ('-i', '--iterations'):
+            arguments["iterations"] = float(argument)
+        if argument in ('-min', '--min_value'):
+            arguments["min"] = float(argument)
+        if argument in ('-max', '--max_value'):
+            arguments["max"] = float(argument)
+
+    return arguments
+
+
 # Ran first in the code
 if __name__ == "__main__":
-    # Set the parameters
-    MU = 5
-    LAMBDA = 20
-    SIGMA = 0.1
-    ITERATIONS = 100
-
     # Run the Evolutionary Strategy algorithm
+    ARGUMENTS = user_input()
     best_individual, best_fitness = evolution_strategy(
-        MU, LAMBDA, SIGMA, ITERATIONS)
+        ARGUMENTS["number_of_parents"],
+        ARGUMENTS["size_of_population"],
+        ARGUMENTS["mutation_strength"],
+        ARGUMENTS["iterations"],
+        (ARGUMENTS["min"], ARGUMENTS["max"]))
 
     print("Best individual found:", best_individual)
     print("Best fitness found:", best_fitness)