rename geneticalgorithm2 class to GeneticAlgorithm2

PasaOpasen · Apr 13, 2024 · fafad81 · fafad81
1 parent 8d21c4a
commit fafad81
Show file tree

Hide file tree

Showing 36 changed files with 218 additions and 204 deletions.
diff --git a/README.md b/README.md
diff --git a/geneticalgorithm2/__init__.py b/geneticalgorithm2/__init__.py
@@ -1,7 +1,12 @@
 
+from typing_extensions import TypeAlias
+
 from .classes import Generation, AlgorithmParams
 
-from .geneticalgorithm2 import geneticalgorithm2
+from .geneticalgorithm2 import GeneticAlgorithm2
+
+# to keep backward compatibility
+geneticalgorithm2: TypeAlias = GeneticAlgorithm2
 
 from .mutations import Mutations
 from .crossovers import Crossover

diff --git a/geneticalgorithm2/geneticalgorithm2.py b/geneticalgorithm2/geneticalgorithm2.py
@@ -36,7 +36,7 @@
 #endregion
 
 
-class geneticalgorithm2:
+class GeneticAlgorithm2:
 
     """
     Genetic Algorithm (Elitist version) for Python3.8+
@@ -363,9 +363,9 @@ def _progress(self, count: int, total: int, status: str = ''):
 
         part = count / total
 
-        filled_len = round(geneticalgorithm2.PROGRESS_BAR_LEN * part)
+        filled_len = round(GeneticAlgorithm2.PROGRESS_BAR_LEN * part)
         percents = round(100.0 * part, 1)
-        bar = '|' * filled_len + '_' * (geneticalgorithm2.PROGRESS_BAR_LEN - filled_len)
+        bar = '|' * filled_len + '_' * (GeneticAlgorithm2.PROGRESS_BAR_LEN - filled_len)
 
         self.progress_stream.write('\r%s %s%s %s' % (bar, percents, '%', status))
         self.progress_stream.flush()
@@ -665,7 +665,7 @@ def total_middle_callback():
 
         ############################################################# 
         # Initial Population
-        self.set_function = set_function or geneticalgorithm2.default_set_function(self.f)
+        self.set_function = set_function or GeneticAlgorithm2.default_set_function(self.f)
 
         pop_coef, initializer_func = population_initializer
 

diff --git a/tests/AlgorithmParameters.py b/tests/AlgorithmParameters.py
@@ -11,7 +11,7 @@
 
 import numpy as np
 from geneticalgorithm2 import AlgorithmParams
-from geneticalgorithm2 import geneticalgorithm2 as ga
+from geneticalgorithm2 import GeneticAlgorithm2 as ga
 
 def function(X):
     return np.sum(X)

diff --git a/tests/Standard GA vs. Elitist GA.py b/tests/Standard GA vs. Elitist GA.py
@@ -10,7 +10,7 @@
 
 
 import numpy as np
-from geneticalgorithm2 import geneticalgorithm2 as ga
+from geneticalgorithm2 import GeneticAlgorithm2 as ga
 from geneticalgorithm2 import AlgorithmParams
 import matplotlib.pyplot as plt
 

diff --git a/tests/_sense_of_prob_cross.py b/tests/_sense_of_prob_cross.py
@@ -7,7 +7,7 @@
 import numpy as np
 
 from OppOpPopInit import set_seed
-from geneticalgorithm2 import geneticalgorithm2 as ga, AlgorithmParams, plot_several_lines
+from geneticalgorithm2 import GeneticAlgorithm2 as ga, AlgorithmParams, plot_several_lines
 
 set_seed(1)
 

diff --git a/tests/best_of_N.py b/tests/best_of_N.py
@@ -12,7 +12,7 @@
 import numpy as np
 import matplotlib.pyplot as plt
 
-from geneticalgorithm2 import geneticalgorithm2 as ga
+from geneticalgorithm2 import GeneticAlgorithm2 as ga
 from geneticalgorithm2 import Population_initializer
 
 

diff --git a/tests/best_of_N_with_opp.py b/tests/best_of_N_with_opp.py
@@ -15,7 +15,7 @@
 from OppOpPopInit import OppositionOperators
 from OptimizationTestFunctions import Ackley
 
-from geneticalgorithm2 import geneticalgorithm2 as ga
+from geneticalgorithm2 import GeneticAlgorithm2 as ga
 from geneticalgorithm2 import Population_initializer
 
 

diff --git a/tests/best_subset.py b/tests/best_subset.py
@@ -10,7 +10,7 @@
 
 
 import numpy as np
-from geneticalgorithm2 import geneticalgorithm2 as ga
+from geneticalgorithm2 import GeneticAlgorithm2 as ga
 
 
 subset_size = 20 # how many objects we can choose

diff --git a/tests/callbacks.py b/tests/callbacks.py
@@ -8,7 +8,7 @@
 sys.path.append('..')
 
 import numpy as np
-from geneticalgorithm2 import geneticalgorithm2 as ga
+from geneticalgorithm2 import GeneticAlgorithm2 as ga
 from geneticalgorithm2 import Callbacks, MiddleCallbacks, ActionConditions
 
 

diff --git a/tests/check_new_types_of_cross_and_mut.py b/tests/check_new_types_of_cross_and_mut.py
@@ -10,7 +10,7 @@
 
 
 import numpy as np
-from geneticalgorithm2 import geneticalgorithm2 as ga
+from geneticalgorithm2 import GeneticAlgorithm2 as ga
 from geneticalgorithm2 import Crossover, Mutations
 
 def f(X):

diff --git a/tests/constraints.py b/tests/constraints.py
@@ -6,7 +6,7 @@
 """
 
 import numpy as np
-from geneticalgorithm2 import geneticalgorithm2 as ga
+from geneticalgorithm2 import GeneticAlgorithm2 as ga
 
 def f(X):
     pen=0

diff --git a/tests/disable_messages_and_printing.py b/tests/disable_messages_and_printing.py
@@ -10,7 +10,7 @@
 
 
 import numpy as np
-from geneticalgorithm2 import geneticalgorithm2 as ga
+from geneticalgorithm2 import GeneticAlgorithm2 as ga
 
 def f(X):
     return np.sum(X)

diff --git a/tests/init_local_opt.py b/tests/init_local_opt.py
@@ -14,7 +14,7 @@
 
 from DiscreteHillClimbing import Hill_Climbing_descent
 
-from geneticalgorithm2 import geneticalgorithm2 as ga
+from geneticalgorithm2 import GeneticAlgorithm2 as ga
 from geneticalgorithm2 import Population_initializer
 
 

diff --git a/tests/min of sum int.py b/tests/min of sum int.py
@@ -9,7 +9,7 @@
 sys.path.append('..')
 
 import numpy as np
-from geneticalgorithm2 import geneticalgorithm2 as ga
+from geneticalgorithm2 import GeneticAlgorithm2 as ga
 
 def f(X):
     return np.sum(X)

diff --git a/tests/min of sum mixed.py b/tests/min of sum mixed.py
@@ -9,7 +9,7 @@
 sys.path.append('..')
 
 import numpy as np
-from geneticalgorithm2 import geneticalgorithm2 as ga
+from geneticalgorithm2 import GeneticAlgorithm2 as ga
 
 def f(X):
     return np.sum(X)

diff --git a/tests/min of sum.py b/tests/min of sum.py
@@ -9,7 +9,7 @@
 
 
 import numpy as np
-from geneticalgorithm2 import geneticalgorithm2 as ga
+from geneticalgorithm2 import GeneticAlgorithm2 as ga
 
 def f(X):
     return np.sum(X)

diff --git a/tests/multiprocess.py b/tests/multiprocess.py
@@ -10,7 +10,7 @@
 
 
 import numpy as np
-from geneticalgorithm2 import geneticalgorithm2 as ga
+from geneticalgorithm2 import GeneticAlgorithm2 as ga
 
 def f(X):
     import math

diff --git a/tests/mut_indexes.py b/tests/mut_indexes.py
@@ -10,7 +10,7 @@
 
 
 import numpy as np
-from geneticalgorithm2 import geneticalgorithm2 as ga
+from geneticalgorithm2 import GeneticAlgorithm2 as ga
 from geneticalgorithm2 import AlgorithmParams
 
 def f(X):

diff --git a/tests/optimization_test_functions.py b/tests/optimization_test_functions.py
@@ -9,7 +9,7 @@
 
 
 import numpy as np
-from geneticalgorithm2 import geneticalgorithm2 as ga
+from geneticalgorithm2 import GeneticAlgorithm2 as ga
 
 from OptimizationTestFunctions import Sphere, Ackley, AckleyTest, Rosenbrock, Fletcher, Griewank, Penalty2, Quartic, Rastrigin, SchwefelDouble, SchwefelMax, SchwefelAbs, SchwefelSin, Stairs, Abs, Michalewicz, Scheffer, Eggholder, Weierstrass
 

diff --git a/tests/plot_diversities.py b/tests/plot_diversities.py
@@ -10,7 +10,7 @@
 
 
 import numpy as np
-from geneticalgorithm2 import geneticalgorithm2 as ga
+from geneticalgorithm2 import GeneticAlgorithm2 as ga
 
 from geneticalgorithm2 import MiddleCallbacks
 

diff --git a/tests/plot_each_gen_scores.py b/tests/plot_each_gen_scores.py
@@ -9,7 +9,7 @@
 sys.path.append('..')
 
 import numpy as np
-from geneticalgorithm2 import geneticalgorithm2 as ga
+from geneticalgorithm2 import GeneticAlgorithm2 as ga
 
 from geneticalgorithm2 import Actions, ActionConditions, MiddleCallbacks
 

diff --git a/tests/plot_scores.py b/tests/plot_scores.py
@@ -10,7 +10,7 @@
 
 import numpy as np
 
-from geneticalgorithm2 import geneticalgorithm2 as ga
+from geneticalgorithm2 import GeneticAlgorithm2 as ga
 
 from geneticalgorithm2 import plot_pop_scores  # for plotting scores without ga object
 

diff --git a/tests/progress_bar_streams.py b/tests/progress_bar_streams.py
@@ -3,7 +3,7 @@
 sys.path.append('..')
 
 import numpy as np
-from geneticalgorithm2 import geneticalgorithm2 as ga
+from geneticalgorithm2 import GeneticAlgorithm2 as ga
 
 def f(X):
     return np.sum(X)

diff --git a/tests/remove_dups.py b/tests/remove_dups.py
@@ -14,7 +14,7 @@
 
 from OppOpPopInit import OppositionOperators
 
-from geneticalgorithm2 import geneticalgorithm2 as ga
+from geneticalgorithm2 import GeneticAlgorithm2 as ga
 
 
 

diff --git a/tests/remove_dups_by_callback.py b/tests/remove_dups_by_callback.py
@@ -10,7 +10,7 @@
 
 
 import numpy as np
-from geneticalgorithm2 import geneticalgorithm2 as ga
+from geneticalgorithm2 import GeneticAlgorithm2 as ga
 
 from geneticalgorithm2 import ActionConditions, Actions, MiddleCallbacks
 

diff --git a/tests/report.py b/tests/report.py
@@ -1,7 +1,7 @@
 
 import numpy as np
 
-from geneticalgorithm2 import geneticalgorithm2 as ga
+from geneticalgorithm2 import GeneticAlgorithm2 as ga
 from geneticalgorithm2 import plot_several_lines
 
 def f(X):

diff --git a/tests/revolution.py b/tests/revolution.py
@@ -16,7 +16,7 @@
 from OppOpPopInit import OppositionOperators
 from OptimizationTestFunctions import Eggholder
 
-from geneticalgorithm2 import geneticalgorithm2 as ga
+from geneticalgorithm2 import GeneticAlgorithm2 as ga
 
 
 

diff --git a/tests/save and load generation.py b/tests/save and load generation.py
@@ -10,7 +10,7 @@
 
 
 import numpy as np
-from geneticalgorithm2 import geneticalgorithm2 as ga
+from geneticalgorithm2 import GeneticAlgorithm2 as ga
 
 
 from OptimizationTestFunctions import Eggholder

diff --git a/tests/selections.py b/tests/selections.py
@@ -12,7 +12,7 @@
 import numpy as np
 import matplotlib.pyplot as plt
 
-from geneticalgorithm2 import geneticalgorithm2 as ga
+from geneticalgorithm2 import GeneticAlgorithm2 as ga
 from geneticalgorithm2 import Selection
 
 def f(X):

diff --git a/tests/set_functions.py b/tests/set_functions.py
@@ -1,7 +1,7 @@
 
 import math
 import numpy as np
-from geneticalgorithm2 import geneticalgorithm2 as ga
+from geneticalgorithm2 import GeneticAlgorithm2 as ga
 
 
 def f_slow(X):

diff --git a/tests/small_middle_callbacks.py b/tests/small_middle_callbacks.py
@@ -12,7 +12,7 @@
 
 import numpy as np
 
-from geneticalgorithm2 import geneticalgorithm2 as ga
+from geneticalgorithm2 import GeneticAlgorithm2 as ga
 from geneticalgorithm2 import Actions, ActionConditions, MiddleCallbacks
 from geneticalgorithm2 import Crossover, Mutations
 

diff --git a/tests/start_gen.py b/tests/start_gen.py
@@ -10,7 +10,7 @@
 
 
 import numpy as np
-from geneticalgorithm2 import geneticalgorithm2 as ga
+from geneticalgorithm2 import GeneticAlgorithm2 as ga
 
 def f(X):
     return np.sum(X)

diff --git a/tests/str.py b/tests/str.py
@@ -10,7 +10,7 @@
 
 
 import numpy as np
-from geneticalgorithm2 import geneticalgorithm2 as ga
+from geneticalgorithm2 import GeneticAlgorithm2 as ga
 
 def f(X):
     return np.sum(X)

diff --git a/tests/studEA.py b/tests/studEA.py
@@ -10,7 +10,7 @@
 
 
 import numpy as np
-from geneticalgorithm2 import geneticalgorithm2 as ga
+from geneticalgorithm2 import GeneticAlgorithm2 as ga
 import matplotlib.pyplot as plt
 
 def f(X):

diff --git a/tests/time_limit.py b/tests/time_limit.py
@@ -10,7 +10,7 @@
 
 
 import numpy as np
-from geneticalgorithm2 import geneticalgorithm2 as ga
+from geneticalgorithm2 import GeneticAlgorithm2 as ga
 
 def f(X):
     return np.sum(X)
Original file line number	Diff line number	Diff line change
Expand Up		@@ -14,7 +14,7 @@

		from OppOpPopInit import OppositionOperators

		from geneticalgorithm2 import geneticalgorithm2 as ga
		from geneticalgorithm2 import GeneticAlgorithm2 as ga



Expand Down