iwopy 0.1.9__py3-none-any.whl → 0.2.3__py3-none-any.whl

iwopy/core/function_list.py

@@ -13,27 +13,33 @@ class OptFunctionList(OptFunction):
     Add functions to the list via the `append` function,
     and don't forget to initialize.
 
-    Parameters
-    ----------
-    problem: iwopy.Problem
-        The underlying optimization problem
-    name: str
-        The function name
-
     Attributes
     ----------
-    func_vars_int : list of lists of int
+    func_vars_int: list of lists of int
         For each added function, the subset of
         integer variables
-    func_vars_float : list of lists of int
+    func_vars_float: list of lists of int
         For each added function, the subset of
         float variables
-    sizes : list of int
+    sizes: list of int
         The components of each added function
 
+    :group: core
+
     """
 
     def __init__(self, problem, name):
+        """
+        Constructor
+
+        Parameters
+        ----------
+        problem: iwopy.Problem
+            The underlying optimization problem
+        name: str
+            The function name
+
+        """
         super().__init__(problem, name)
 
         self._functions = []
@@ -48,7 +54,7 @@ class OptFunctionList(OptFunction):
 
         Parameters
         ----------
-        function : iwopy.core.OptFunction
+        function: iwopy.core.OptFunction
             The function
 
         """
@@ -71,7 +77,7 @@ class OptFunctionList(OptFunction):
 
         Returns
         -------
-        funcs : list of iwopy.core.OptFunction
+        funcs: list of iwopy.core.OptFunction
             The list of added functions
 
         """
@@ -84,7 +90,7 @@ class OptFunctionList(OptFunction):
 
         Returns
         -------
-        n : int
+        n: int
             The total number of added functions
 
         """
@@ -96,7 +102,7 @@ class OptFunctionList(OptFunction):
 
         Parameters
         ----------
-        verbosity : int
+        verbosity: int
             The verbosity level, 0 = silent
 
         """
@@ -134,7 +140,7 @@ class OptFunctionList(OptFunction):
 
         Returns
         -------
-        deps : numpy.ndarray of bool
+        deps: numpy.ndarray of bool
             The dependencies of components on function
             variables, shape: (n_components, n_vars_int)
 
@@ -156,7 +162,7 @@ class OptFunctionList(OptFunction):
 
         Returns
         -------
-        deps : numpy.ndarray of bool
+        deps: numpy.ndarray of bool
             The dependencies of components on function
             variables, shape: (n_components, n_vars_float)
 
@@ -191,12 +197,12 @@ class OptFunctionList(OptFunction):
 
         Parameters
         ----------
-        data : numpy.ndarray
+        data: numpy.ndarray
             The data, shape: (n_components,)
 
         Returns
         -------
-        fdata : list of numpy.ndarray
+        fdata: list of numpy.ndarray
             The data for each function, list entry
             shapes: (n_func_components,)
 
@@ -216,12 +222,12 @@ class OptFunctionList(OptFunction):
 
         Parameters
         ----------
-        data : numpy.ndarray
+        data: numpy.ndarray
             The data, shape: (n_pop, n_components)
 
         Returns
         -------
-        fdata : list of numpy.ndarray
+        fdata: list of numpy.ndarray
             The data for each function, list entry
             shapes: (n_pop, n_func_components)
 
@@ -241,19 +247,19 @@ class OptFunctionList(OptFunction):
 
         Parameters
         ----------
-        vars_int : np.array
+        vars_int: np.array
             The integer variable values, shape: (n_vars_int,)
-        vars_float : np.array
+        vars_float: np.array
             The float variable values, shape: (n_vars_float,)
-        problem_results : Any
+        problem_results: Any
             The results of the variable application
             to the problem
-        components : list of int, optional
+        components: list of int, optional
             The selected components or None for all
 
         Returns
         -------
-        values : np.array
+        values: np.array
             The component values, shape: (n_sel_components,)
 
         """
@@ -285,19 +291,19 @@ class OptFunctionList(OptFunction):
 
         Parameters
         ----------
-        vars_int : np.array
+        vars_int: np.array
             The integer variable values, shape: (n_pop, n_vars_int)
-        vars_float : np.array
+        vars_float: np.array
             The float variable values, shape: (n_pop, n_vars_float)
-        problem_results : Any
+        problem_results: Any
             The results of the variable application
             to the problem
-        components : list of int, optional
+        components: list of int, optional
             The selected components or None for all
 
         Returns
         -------
-        values : np.array
+        values: np.array
             The component values, shape: (n_pop, n_sel_components,)
 
         """
@@ -330,19 +336,19 @@ class OptFunctionList(OptFunction):
 
         Parameters
         ----------
-        vars_int : np.array
+        vars_int: np.array
             The optimal integer variable values, shape: (n_vars_int,)
-        vars_float : np.array
+        vars_float: np.array
             The optimal float variable values, shape: (n_vars_float,)
-        problem_results : Any
+        problem_results: Any
             The results of the variable application
             to the problem
-        verbosity : int
+        verbosity: int
             The verbosity level, 0 = silent
 
         Returns
         -------
-        values : np.array
+        values: np.array
             The component values, shape: (n_components,)
 
         """
@@ -366,21 +372,21 @@ class OptFunctionList(OptFunction):
 
         Parameters
         ----------
-        vars_int : np.array
+        vars_int: np.array
             The integer variable values of the final
             generation, shape: (n_pop, n_vars_int)
-        vars_float : np.array
+        vars_float: np.array
             The float variable values of the final
             generation, shape: (n_pop, n_vars_float)
-        problem_results : Any
+        problem_results: Any
             The results of the variable application
             to the problem
-        verbosity : int
+        verbosity: int
             The verbosity level, 0 = silent
 
         Returns
         -------
-        values : np.array
+        values: np.array
             The component values, shape: (n_pop, n_components)
 
         """
@@ -407,18 +413,18 @@ class OptFunctionList(OptFunction):
 
         Parameters
         ----------
-        vars_int : np.array
+        vars_int: np.array
             The integer variable values, shape: (n_vars_int,)
-        vars_float : np.array
+        vars_float: np.array
             The float variable values, shape: (n_vars_float,)
-        var : int
+        var: int
             The index of the differentiation float variable
-        components : list of int
+        components: list of int
             The selected components, or None for all
 
         Returns
         -------
-        deriv : numpy.ndarray
+        deriv: numpy.ndarray
             The derivative values, shape: (n_sel_components,)
 
         """

iwopy/core/function_subset.py

@@ -8,26 +8,31 @@ class OptFunctionSubset(OptFunction):
     A function composed of a subset of a function's
     components.
 
-    Parameters
-    ----------
-    function: iwopy.OptFunction
-        The original function
-    subset : list of int
-        The component choice
-    name: str, optional
-        The function name
-
     Attributes
     ----------
     func_org: iwopy.OptFunction
         The original function
-    subset : list of int
+    subset: list of int
         The component choice
 
+    :group: core
+
     """
 
     def __init__(self, function, subset, name=None):
+        """
+        Constructor
 
+        Parameters
+        ----------
+        function: iwopy.OptFunction
+            The original function
+        subset: list of int
+            The component choice
+        name: str, optional
+            The function name
+
+        """
         if name is None:
             name = f"{function.name}[" + ",".join([str(i) for i in subset]) + "]"
         super().__init__(function.problem, name)
@@ -41,7 +46,7 @@ class OptFunctionSubset(OptFunction):
 
         Parameters
         ----------
-        verbosity : int
+        verbosity: int
             The verbosity level, 0 = silent
 
         """
@@ -64,7 +69,7 @@ class OptFunctionSubset(OptFunction):
 
         Returns
         -------
-        deps : numpy.ndarray of bool
+        deps: numpy.ndarray of bool
             The dependencies of components on function
             variables, shape: (n_components, n_vars_int)
 
@@ -78,7 +83,7 @@ class OptFunctionSubset(OptFunction):
 
         Returns
         -------
-        deps : numpy.ndarray of bool
+        deps: numpy.ndarray of bool
             The dependencies of components on function
             variables, shape: (n_components, n_vars_float)
 
@@ -105,19 +110,19 @@ class OptFunctionSubset(OptFunction):
 
         Parameters
         ----------
-        vars_int : np.array
+        vars_int: np.array
             The integer variable values, shape: (n_vars_int,)
-        vars_float : np.array
+        vars_float: np.array
             The float variable values, shape: (n_vars_float,)
-        problem_results : Any
+        problem_results: Any
             The results of the variable application
             to the problem
-        components : list of int, optional
+        components: list of int, optional
             The selected components or None for all
 
         Returns
         -------
-        values : np.array
+        values: np.array
             The component values, shape: (n_sel_components,)
 
         """
@@ -134,19 +139,19 @@ class OptFunctionSubset(OptFunction):
 
         Parameters
         ----------
-        vars_int : np.array
+        vars_int: np.array
             The integer variable values, shape: (n_pop, n_vars_int)
-        vars_float : np.array
+        vars_float: np.array
             The float variable values, shape: (n_pop, n_vars_float)
-        problem_results : Any
+        problem_results: Any
             The results of the variable application
             to the problem
-        components : list of int, optional
+        components: list of int, optional
             The selected components or None for all
 
         Returns
         -------
-        values : np.array
+        values: np.array
             The component values, shape: (n_pop, n_sel_components,)
 
         """
@@ -165,18 +170,18 @@ class OptFunctionSubset(OptFunction):
 
         Parameters
         ----------
-        vars_int : np.array
+        vars_int: np.array
             The integer variable values, shape: (n_vars_int,)
-        vars_float : np.array
+        vars_float: np.array
             The float variable values, shape: (n_vars_float,)
-        var : int
+        var: int
             The index of the differentiation float variable
-        components : list of int
+        components: list of int
             The selected components, or None for all
 
         Returns
         -------
-        deriv : numpy.ndarray
+        deriv: numpy.ndarray
             The derivative values, shape: (n_sel_components,)
 
         """

iwopy/core/memory.py

@@ -7,7 +7,7 @@ def get_default_keyf(digits=12):
 
     Parameters
     ----------
-    digits : int
+    digits: int
         The number of digits for floats
 
     Returns
@@ -15,6 +15,8 @@ def get_default_keyf(digits=12):
     Function :
         The default key function
 
+    :group: core
+
     """
 
     def default_key(vars_int, vars_float):
@@ -23,9 +25,9 @@ def get_default_keyf(digits=12):
 
         Parameters
         ----------
-        vars_int : np.array
+        vars_int: np.array
             The integer variable values, shape: (n_vars_int,)
-        vars_float : np.array
+        vars_float: np.array
             The float variable values, shape: (n_vars_float,)
 
         Returns
@@ -45,28 +47,34 @@ class Memory:
     """
     Storage for function results.
 
-    Parameters
-    ----------
-    size : int
-        The number of maximally stored results
-    keyf : Function, optional
-        The memory key function. Parameters:
-        (vars_int, vars_float), returns key Object
-
     Attributes
     ----------
-    max_size : int
+    max_size: int
         The number of maximally stored results
-    data : dict
+    data: dict
         The stored data. Key: keyf return type,
         Values: tuples (objs, cons)
-    keyf : Function
+    keyf: Function
         The memory key function. Parameters:
         (vars_int, vars_float), returns key Object
 
+    :group: core
+
     """
 
     def __init__(self, size, keyf=None):
+        """
+        Constructor
+
+        Parameters
+        ----------
+        size: int
+            The number of maximally stored results
+        keyf: Function, optional
+            The memory key function. Parameters:
+            (vars_int, vars_float), returns key Object
+
+        """
         self.max_size = size
         self.keyf = keyf if keyf is not None else get_default_keyf()
         self.data = {}
@@ -98,14 +106,14 @@ class Memory:
 
         Parameters
         ----------
-        vars_int : np.array
+        vars_int: np.array
             The integer variable values, shape: (n_vars_int,)
-        vars_float : np.array
+        vars_float: np.array
             The float variable values, shape: (n_vars_float,)
 
         Returns
         -------
-        found : bool
+        found: bool
             True if data is available
 
         """
@@ -118,14 +126,14 @@ class Memory:
 
         Parameters
         ----------
-        vars_int : np.array
+        vars_int: np.array
             The integer variable values, shape: (n_pop, n_vars_int)
-        vars_float : np.array
+        vars_float: np.array
             The float variable values, shape: (n_pop, n_vars_float)
 
         Returns
         -------
-        found : numpy.ndarray of bool
+        found: numpy.ndarray of bool
             True if data is available, shape: (n_pop,)
 
         """
@@ -141,13 +149,13 @@ class Memory:
 
         Parameters
         ----------
-        vars_int : np.array
+        vars_int: np.array
             The integer variable values, shape: (n_vars_int,)
-        vars_float : np.array
+        vars_float: np.array
             The float variable values, shape: (n_vars_float,)
-        objs : np.array
+        objs: np.array
             The objective function values, shape: (n_objectives,)
-        con : np.array
+        con: np.array
             The constraints values, shape: (n_constraints,)
 
         """
@@ -163,13 +171,13 @@ class Memory:
 
         Parameters
         ----------
-        vars_int : np.array
+        vars_int: np.array
             The integer variable values, shape: (n_pop, n_vars_int)
-        vars_float : np.array
+        vars_float: np.array
             The float variable values, shape: (n_pop, n_vars_float)
-        objs : np.array
+        objs: np.array
             The objective function values, shape: (n_pop, n_objectives)
-        con : np.array
+        con: np.array
             The constraints values, shape: (n_pop, n_constraints)
 
         """
@@ -182,14 +190,14 @@ class Memory:
 
         Parameters
         ----------
-        vars_int : np.array
+        vars_int: np.array
             The integer variable values, shape: (n_vars_int,)
-        vars_float : np.array
+        vars_float: np.array
             The float variable values, shape: (n_vars_float,)
 
         Returns
         -------
-        results : tuple or None
+        results: tuple or None
             The results (objs, cons) if found, None otherwise
 
         """
@@ -205,17 +213,17 @@ class Memory:
 
         Parameters
         ----------
-        vars_int : np.array
+        vars_int: np.array
             The integer variable values, shape: (n_pop, n_vars_int)
-        vars_float : np.array
+        vars_float: np.array
             The float variable values, shape: (n_pop, n_vars_float)
-        target : numpy.ndarray, optional
+        target: numpy.ndarray, optional
             The results array to write to, shape:
             (n_pop, n_objs_cmpnts + n_cons_cmpnts)
 
         Returns
         -------
-        results : numpy.ndarray or None
+        results: numpy.ndarray or None
             None if no results at all found, otherwise array
             with shape: (n_pop, n_objs_cmpnts + n_cons_cmpnts)
 

iwopy/core/objective.py

@@ -6,6 +6,9 @@ from .function import OptFunction
 class Objective(OptFunction):
     """
     Abstract base class for objective functions.
+
+    :group: core
+
     """
 
     @abstractmethod
@@ -15,7 +18,7 @@ class Objective(OptFunction):
 
         Returns
         -------
-        flags : np.array
+        flags: np.array
             Bool array for component maximization,
             shape: (n_components,)