pydmoo 0.1.0__py3-none-any.whl → 0.1.2__py3-none-any.whl

pydmoo/algorithms/modern/moead_imkt_igp.py

@@ -16,7 +16,8 @@ class MOEADIMKTIGP(MOEADIMKT):
         self.sigma_n = 0.01
         self.sigma_n_2 = self.sigma_n ** 2
 
-    def _response_change(self):
+    def _response_mechanism(self):
+        """Response mechanism."""
         pop = self.pop
         X = pop.get("X")
 

pydmoo/algorithms/modern/moead_imkt_lstm.py

@@ -42,7 +42,8 @@ class MOEADIMLSTM(MOEADIMKT):
             incremental_learning=self._incremental_learning,
         )
 
-    def _response_change(self):
+    def _response_mechanism(self):
+        """Response mechanism."""
         pop = self.pop
         X = pop.get("X")
 

pydmoo/algorithms/modern/moead_imkt_n.py

@@ -19,7 +19,8 @@ class MOEADIMKTN(MOEADIMKT):
         self.size_pool = 10
         self.denominator = 0.5
 
-    def _response_change(self):
+    def _response_mechanism(self):
+        """Response mechanism."""
         pop = self.pop
         X = pop.get("X")
 

pydmoo/algorithms/modern/moead_imkt_n_igp.py

@@ -16,7 +16,8 @@ class MOEADIMKTNIGP(MOEADIMKTN):
         self.sigma_n = 0.01
         self.sigma_n_2 = self.sigma_n ** 2
 
-    def _response_change(self):
+    def _response_mechanism(self):
+        """Response mechanism."""
         pop = self.pop
         X = pop.get("X")
 

pydmoo/algorithms/modern/moead_imkt_n_lstm.py

@@ -43,7 +43,8 @@ class MOEADIMNLSTM(MOEADIMKTN):
             incremental_learning=self._incremental_learning,
         )
 
-    def _response_change(self):
+    def _response_mechanism(self):
+        """Response mechanism."""
         pop = self.pop
         X = pop.get("X")
 

pydmoo/algorithms/modern/moead_ktmm.py

@@ -22,7 +22,8 @@ class MOEADKTMM(DMOEAD):
         self.size_pool = 14  # the size of knowledge pool
         self.denominator = 0.5
 
-    def _response_change(self):
+    def _response_mechanism(self):
+        """Response mechanism."""
         pop = self.pop
         X = pop.get("X")
 

pydmoo/algorithms/modern/moeadde_imkt.py

@@ -19,7 +19,8 @@ class MOEADDEIMKT(MOEADDEKTMM):
         self.size_pool = 10
         self.denominator = 0.5
 
-    def _response_change(self):
+    def _response_mechanism(self):
+        """Response mechanism."""
         pop = self.pop
         X = pop.get("X")
 

pydmoo/algorithms/modern/moeadde_imkt_clstm.py

@@ -36,7 +36,8 @@ class MOEADDEIMcLSTM(MOEADDEIMKT):
             incremental_learning=self._incremental_learning,
         )
 
-    def _response_change(self):
+    def _response_mechanism(self):
+        """Response mechanism."""
         pop = self.pop
         X = pop.get("X")
 

pydmoo/algorithms/modern/moeadde_imkt_igp.py

@@ -16,7 +16,8 @@ class MOEADDEIMKTIGP(MOEADDEIMKT):
         self.sigma_n = 0.01
         self.sigma_n_2 = self.sigma_n ** 2
 
-    def _response_change(self):
+    def _response_mechanism(self):
+        """Response mechanism."""
         pop = self.pop
         X = pop.get("X")
 

pydmoo/algorithms/modern/moeadde_imkt_lstm.py

@@ -42,7 +42,8 @@ class MOEADDEIMLSTM(MOEADDEIMKT):
             incremental_learning=self._incremental_learning,
         )
 
-    def _response_change(self):
+    def _response_mechanism(self):
+        """Response mechanism."""
         pop = self.pop
         X = pop.get("X")
 

pydmoo/algorithms/modern/moeadde_imkt_n.py

@@ -19,7 +19,8 @@ class MOEADDEIMKTN(MOEADDEIMKT):
         self.size_pool = 10
         self.denominator = 0.5
 
-    def _response_change(self):
+    def _response_mechanism(self):
+        """Response mechanism."""
         pop = self.pop
         X = pop.get("X")
 

pydmoo/algorithms/modern/moeadde_imkt_n_clstm.py

@@ -37,7 +37,8 @@ class MOEADDEIMNcLSTM(MOEADDEIMKTN):
             incremental_learning=self._incremental_learning,
         )
 
-    def _response_change(self):
+    def _response_mechanism(self):
+        """Response mechanism."""
         pop = self.pop
         X = pop.get("X")
 

pydmoo/algorithms/modern/moeadde_imkt_n_igp.py

@@ -16,7 +16,8 @@ class MOEADDEIMKTNIGP(MOEADDEIMKTN):
         self.sigma_n = 0.01
         self.sigma_n_2 = self.sigma_n ** 2
 
-    def _response_change(self):
+    def _response_mechanism(self):
+        """Response mechanism."""
         pop = self.pop
         X = pop.get("X")
 

pydmoo/algorithms/modern/moeadde_imkt_n_lstm.py

@@ -43,7 +43,8 @@ class MOEADDEIMNLSTM(MOEADDEIMKTN):
             incremental_learning=self._incremental_learning,
         )
 
-    def _response_change(self):
+    def _response_mechanism(self):
+        """Response mechanism."""
         pop = self.pop
         X = pop.get("X")
 

pydmoo/algorithms/modern/moeadde_ktmm.py

@@ -22,7 +22,8 @@ class MOEADDEKTMM(DMOEADDE):
         self.size_pool = 14  # the size of knowledge pool
         self.denominator = 0.5
 
-    def _response_change(self):
+    def _response_mechanism(self):
+        """Response mechanism."""
         pop = self.pop
         X = pop.get("X")
 

pydmoo/algorithms/modern/nsga2_imkt.py

@@ -19,7 +19,8 @@ class NSGA2IMKT(NSGA2KTMM):
         self.size_pool = 10
         self.denominator = 0.5
 
-    def _response_change(self):
+    def _response_mechanism(self):
+        """Response mechanism."""
         """Inverse Modeling with Knowledge Transfer."""
         pop = self.pop
         X = pop.get("X")

pydmoo/algorithms/modern/nsga2_imkt_clstm.py

@@ -36,7 +36,8 @@ class NSGA2IMcLSTM(NSGA2IMKT):
             incremental_learning=self._incremental_learning,
         )
 
-    def _response_change(self):
+    def _response_mechanism(self):
+        """Response mechanism."""
         pop = self.pop
         X = pop.get("X")
 

pydmoo/algorithms/modern/nsga2_imkt_igp.py

@@ -16,7 +16,8 @@ class NSGA2IMKTIGP(NSGA2IMKT):
         self.sigma_n = 0.01
         self.sigma_n_2 = self.sigma_n ** 2
 
-    def _response_change(self):
+    def _response_mechanism(self):
+        """Response mechanism."""
         pop = self.pop
         X = pop.get("X")
 

pydmoo/algorithms/modern/nsga2_imkt_lstm.py

@@ -41,7 +41,8 @@ class NSGA2IMLSTM(NSGA2IMKT):
             incremental_learning=self._incremental_learning,
         )
 
-    def _response_change(self):
+    def _response_mechanism(self):
+        """Response mechanism."""
         pop = self.pop
         X = pop.get("X")
 

pydmoo/algorithms/modern/nsga2_imkt_n.py

@@ -19,7 +19,8 @@ class NSGA2IMKTN(NSGA2IMKT):
         self.size_pool = 10
         self.denominator = 0.5
 
-    def _response_change(self):
+    def _response_mechanism(self):
+        """Response mechanism."""
         pop = self.pop
         X = pop.get("X")
 

pydmoo/algorithms/modern/nsga2_imkt_n_clstm.py

@@ -37,7 +37,8 @@ class NSGA2IMNcLSTM(NSGA2IMKTN):
             incremental_learning=self._incremental_learning,
         )
 
-    def _response_change(self):
+    def _response_mechanism(self):
+        """Response mechanism."""
         pop = self.pop
         X = pop.get("X")
 

pydmoo/algorithms/modern/nsga2_imkt_n_igp.py

@@ -16,7 +16,8 @@ class NSGA2IMKTNIGP(NSGA2IMKTN):
         self.sigma_n = 0.01
         self.sigma_n_2 = self.sigma_n ** 2
 
-    def _response_change(self):
+    def _response_mechanism(self):
+        """Response mechanism."""
         pop = self.pop
         X = pop.get("X")
 

pydmoo/algorithms/modern/nsga2_imkt_n_lstm.py

@@ -42,7 +42,8 @@ class NSGA2IMNLSTM(NSGA2IMKTN):
             incremental_learning=self._incremental_learning,
         )
 
-    def _response_change(self):
+    def _response_mechanism(self):
+        """Response mechanism."""
         pop = self.pop
         X = pop.get("X")
 

pydmoo/algorithms/modern/nsga2_ktmm.py

@@ -22,7 +22,8 @@ class NSGA2KTMM(DNSGA2):
         self.size_pool = 14  # the size of knowledge pool
         self.denominator = 0.5
 
-    def _response_change(self):
+    def _response_mechanism(self):
+        """Response mechanism."""
         pop = self.pop
         X = pop.get("X")
 

pydmoo/problems/dyn.py

@@ -1,10 +1,11 @@
 """
 Includes modified code from [pymoo](https://github.com/anyoptimization/pymoo).
 
-Sources:
-    - [dyn.py](https://github.com/anyoptimization/pymoo/blob/main/pymoo/problems/dyn.py)
-
-Licensed under the Apache License, Version 2.0. Original copyright and license terms are preserved.
+> Sources:
+>
+> - [dyn.py](https://github.com/anyoptimization/pymoo/blob/main/pymoo/problems/dyn.py)
+>
+> Licensed under the Apache License, Version 2.0. Original copyright and license terms are preserved.
 """
 
 from abc import ABC
@@ -16,20 +17,66 @@ from pymoo.core.problem import Problem
 
 
 class DynamicProblem(Problem, ABC):
+    """Abstract base class for dynamic optimization problems."""
     pass
 
 
 class DynamicApplProblem(DynamicProblem):
+    """Dynamic optimization problem for real-world applications.
+
+    This class defines dynamic optimization problems that model practical, real-world scenarios where the problem
+    characteristics change systematically over time.
+
+    Parameters
+    ----------
+    nt : int
+        Severity of change. Controls how significantly the problem changes
+        at each change point. Higher values indicate more substantial changes
+        in problem characteristics.
+    taut : int
+        Frequency of change. Specifies how often (in generations) the problem
+        undergoes changes. Lower values mean more frequent changes.
+    t0 : int, optional
+        The first change occurs after t0 generations, by default 50.
+        That is, the generation at which a change occurs is (t0+1), (t0+taut+1), etc.
+        This allows for an initial stabilization period before the first change.
+    tau : int, optional
+        Current simulation time counter (in generations), by default 1.
+    time : float, optional
+        Explicit simulation time value (overrides calculated time), by default None.
+        Used for manual time control in specific scenarios.
+    **kwargs : dict
+        Additional keyword arguments passed to the parent Problem class.
+
+    Attributes
+    ----------
+    tau : int
+        Current simulation time counter in generations.
+    nt : int
+        Severity of change at each change point.
+    taut : int
+        Frequency of change between consecutive changes.
+    t0 : int
+        Initial stabilization period before first change occurs.
+
+    Notes
+    -----
+    This class models real-world dynamic scenarios where:
+
+    - Changes occur at predictable intervals (every `taut` generations)
+    - Change severity is controlled by `nt` parameter
+    - Initial period `t0` allows for system stabilization
+    """
 
-    def __init__(self, nt, taut, t0=50, tau=1, time=None, **kwargs):
+    def __init__(self, nt: int, taut: int, t0: int = 50, tau: int = 1, time: float | None = None, **kwargs):
         super().__init__(**kwargs)
-        self.tau = tau
-        self.nt = nt
-        self.taut = taut
-        self.t0 = t0
+        self.tau = tau  # time counter
+        self.nt = nt  # severity of change
+        self.taut = taut  # frequency of change
+        self.t0 = t0  # Initial time offset
         self._time = time
 
-    def tic(self, elapsed=1):
+    def tic(self, elapsed: int = 1) -> None:
 
         # increase the time counter by one
         self.tau += elapsed
@@ -38,7 +85,7 @@ class DynamicApplProblem(DynamicProblem):
         self.__dict__["cache"] = {}
 
     @property
-    def time(self):
+    def time(self) -> float:
         if self._time is not None:
             return self._time
         else:
@@ -54,7 +101,7 @@ class DynamicApplProblem(DynamicProblem):
             return delta_time * count
 
     @time.setter
-    def time(self, value):
+    def time(self, value: float) -> None:
         self._time = value
 
     def update_to_next_time(self):
@@ -77,12 +124,60 @@ class DynamicApplProblem(DynamicProblem):
 
 
 class DynamicTestProblem(DynamicProblem):
+    """Dynamic optimization problem for testing and benchmarking.
+
+    Parameters
+    ----------
+    nt : int
+        Severity of change. Controls how significantly the problem changes
+        at each change point. Higher values indicate more substantial changes
+        in problem characteristics.
+    taut : int
+        Frequency of change. Specifies how often (in generations) the problem
+        undergoes changes. Lower values mean more frequent changes.
+    t0 : int, optional
+        The first change occurs after t0 generations, by default 50.
+        That is, the generation at which a change occurs is (t0+1), (t0+taut+1), etc.
+        This allows for an initial stabilization period before the first change.
+    tau : int, optional
+        Current simulation time counter (in generations), by default 1.
+    time : float, optional
+        Explicit simulation time value (overrides calculated time), by default None.
+        Used for manual time control in specific scenarios.
+    add_time_perturbation : bool, optional
+        If True, adds perturbations to the time calculation, by default False.
+    **kwargs : dict
+        Additional keyword arguments passed to the parent Problem class.
+
+    Attributes
+    ----------
+    tau : int
+        Current simulation time counter in generations.
+    nt : int
+        Severity of change at each change point.
+    taut : int
+        Frequency of change between consecutive changes.
+    t0 : int
+        Initial stabilization period before first change occurs.
+    add_time_perturbation : bool
+        Flag indicating whether to add stochastic perturbations.
+
+    Notes
+    -----
+    This class is designed for testing scenarios where:
+
+    - Changes occur at predictable intervals (every `taut` generations)
+    - Change severity is controlled by `nt` parameter
+    - Initial period `t0` allows for system stabilization
+    - Stochastic perturbations can be added for more complex testing
+    - Reproducibility is important for benchmarking
+    """
 
     def __init__(self, nt, taut, t0=50, tau=1, time=None, add_time_perturbation=False, **kwargs):
         super().__init__(**kwargs)
-        self.tau = tau
-        self.nt = nt
-        self.taut = taut
+        self.tau = tau  # time counter
+        self.nt = nt  # severity of change
+        self.taut = taut  # frequency of change
         self.t0 = t0  # Initial time offset - added by DynOpt Team
         self._time = time
 

pydmoo/problems/dynamic/cec2015.py

@@ -2,7 +2,8 @@
 Includes modified code from [pymoo](https://github.com/anyoptimization/pymoo).
 
 Sources:
-    - [cec2015.py](https://github.com/anyoptimization/pymoo/blob/main/pymoo/problems/dynamic/cec2015.py)
+
+- [cec2015.py](https://github.com/anyoptimization/pymoo/blob/main/pymoo/problems/dynamic/cec2015.py)
 
 Licensed under the Apache License, Version 2.0. Original copyright and license terms are preserved.
 

pydmoo/problems/dynamic/df.py

@@ -2,7 +2,8 @@
 Includes modified code from [pymoo](https://github.com/anyoptimization/pymoo).
 
 Sources:
-    - [df.py](https://github.com/anyoptimization/pymoo/blob/main/pymoo/problems/dynamic/df.py)
+
+- [df.py](https://github.com/anyoptimization/pymoo/blob/main/pymoo/problems/dynamic/df.py)
 
 Licensed under the Apache License, Version 2.0. Original copyright and license terms are preserved.
 """