iwopy 0.1.8__py3-none-any.whl → 0.2__py3-none-any.whl

iwopy/wrappers/discretize_reg_grid.py

@@ -11,42 +11,19 @@ class DiscretizeRegGrid(LocalFD):
     differentiation on a regular grid for
     selected or all problem float variables.
 
-    Parameters
-    ----------
-    base_problem : iwopy.Problem
-        The underlying concrete problem
-    deltas : dict
-        The step sizes. Key: variable name str,
-        Value: step size. Will be adjusted to the
-        variable bounds if necessary.
-    fd_order : dict or int
-        Finite difference order. Either a dict with
-        key: variable name str, value: order int, or
-        a global integer order for all variables.
-        1 = forward, -1 = backward, 2 = centre
-    fd_bounds_order : dict or int
-        Finite difference order of boundary points.
-        Either a dict with key: variable name str,
-        value: order int, or a global integer order
-        for all variables. Default is same as fd_order
-    mem_size : int, optional
-        The memory size, default no memory
-    name : str, optional
-        The problem name
-    dpars : dict, optional
-        Additional parameters for `RegularDiscretizationGrid`
-
     Attributes
     ----------
-    grid : iwopy.tools.RegularDiscretizationGrid
+    grid: iwopy.tools.RegularDiscretizationGrid
         The discretization grid
-    order : dict
+    order: dict
         Finite difference order. Key: variable name
         str, value: 1 = forward, -1 = backward, 2 = centre
-    orderb : dict or int
+    orderb: dict or int
         Finite difference order of boundary points.
         Key: variable name str, value: order int
 
+    :group: wrappers
+
     """
 
     def __init__(
@@ -59,6 +36,35 @@ class DiscretizeRegGrid(LocalFD):
         name=None,
         **dpars,
     ):
+        """
+        Constructor
+
+        Parameters
+        ----------
+        base_problem: iwopy.Problem
+            The underlying concrete problem
+        deltas: dict
+            The step sizes. Key: variable name str,
+            Value: step size. Will be adjusted to the
+            variable bounds if necessary.
+        fd_order: dict or int
+            Finite difference order. Either a dict with
+            key: variable name str, value: order int, or
+            a global integer order for all variables.
+            1 = forward, -1 = backward, 2 = centre
+        fd_bounds_order: dict or int
+            Finite difference order of boundary points.
+            Either a dict with key: variable name str,
+            value: order int, or a global integer order
+            for all variables. Default is same as fd_order
+        mem_size: int, optional
+            The memory size, default no memory
+        name: str, optional
+            The problem name
+        dpars: dict, optional
+            Additional parameters for `RegularDiscretizationGrid`
+
+        """
         name = base_problem.name + "_grid" if name is None else name
         super().__init__(base_problem, deltas, fd_order, fd_bounds_order, name)
 
@@ -72,7 +78,7 @@ class DiscretizeRegGrid(LocalFD):
 
         Parameters
         ----------
-        verbosity : int
+        verbosity: int
             The verbosity level, 0 = silent
 
         """
@@ -141,14 +147,14 @@ class DiscretizeRegGrid(LocalFD):
 
         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
         -------
-        problem_results : Any
+        problem_results: Any
             The results of the variable application
             to the problem
 
@@ -167,14 +173,14 @@ class DiscretizeRegGrid(LocalFD):
 
         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
         -------
-        problem_results : Any
+        problem_results: Any
             The results of the variable application
             to the problem
 
@@ -192,20 +198,20 @@ class DiscretizeRegGrid(LocalFD):
 
         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,)
-        ret_prob_res : bool
+        ret_prob_res: bool
             Flag for additionally returning of problem results
 
         Returns
         -------
-        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,)
-        prob_res : object, optional
+        prob_res: object, optional
             The problem results
 
         """
@@ -251,20 +257,20 @@ class DiscretizeRegGrid(LocalFD):
 
         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)
-        ret_prob_res : bool
+        ret_prob_res: bool
             Flag for additionally returning of problem results
 
         Returns
         -------
-        objs : np.array
+        objs: np.array
             The objective function values, shape: (n_pop, n_objectives)
-        cons : np.array
+        cons: np.array
             The constraints values, shape: (n_pop, n_constraints)
-        prob_res : object, optional
+        prob_res: object, optional
             The problem results
 
         """
@@ -367,21 +373,21 @@ class DiscretizeRegGrid(LocalFD):
 
         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,)
-        verbosity : int
+        verbosity: int
             The verbosity level, 0 = silent
 
         Returns
         -------
-        problem_results : Any
+        problem_results: Any
             The results of the variable application
             to the problem
-        objs : np.array
+        objs: np.array
             The objective function values, shape: (n_objectives,)
-        cons : np.array
+        cons: np.array
             The constraints values, shape: (n_constraints,)
 
         """
@@ -395,23 +401,23 @@ class DiscretizeRegGrid(LocalFD):
 
         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)
-        verbosity : int
+        verbosity: int
             The verbosity level, 0 = silent
 
         Returns
         -------
-        problem_results : Any
+        problem_results: Any
             The results of the variable application
             to the problem
-        objs : np.array
+        objs: np.array
             The final objective function values, shape: (n_pop, n_components)
-        cons : np.array
+        cons: np.array
             The final constraint values, shape: (n_pop, n_constraints)
 
         """

iwopy/wrappers/local_fd.py

@@ -9,36 +9,17 @@ class LocalFD(ProblemWrapper):
     A wrapper that provides finite distance
     differentiation by local stepwise evaluation.
 
-    Parameters
-    ----------
-    base_problem : iwopy.Problem
-        The underlying concrete problem
-    deltas : dict
-        The step sizes. Key: variable name str,
-        Value: step size. Will be adjusted to the
-        variable bounds if necessary.
-    fd_order : dict or int
-        Finite difference order. Either a dict with
-        key: variable name str, value: order int, or
-        a global integer order for all variables.
-        1 = forward, -1 = backward, 2 = centre
-    fd_bounds_order : dict or int
-        Finite difference order of boundary points.
-        Either a dict with key: variable name str,
-        value: order int, or a global integer order
-        for all variables. Default is same as fd_order
-    name : str, optional
-        The problem name
-
     Attributes
     ----------
-    order : dict
+    order: dict
         Finite difference order. Key: variable name
         str, value: 1 = forward, -1 = backward, 2 = centre
-    orderb : dict or int
+    orderb: dict or int
         Finite difference order of boundary points.
         Key: variable name str, value: order int
 
+    :group: wrappers
+
     """
 
     def __init__(
@@ -49,6 +30,31 @@ class LocalFD(ProblemWrapper):
         fd_bounds_order=None,
         name=None,
     ):
+        """
+        Constructor
+
+        Parameters
+        ----------
+        base_problem: iwopy.Problem
+            The underlying concrete problem
+        deltas: dict
+            The step sizes. Key: variable name str,
+            Value: step size. Will be adjusted to the
+            variable bounds if necessary.
+        fd_order: dict or int
+            Finite difference order. Either a dict with
+            key: variable name str, value: order int, or
+            a global integer order for all variables.
+            1 = forward, -1 = backward, 2 = centre
+        fd_bounds_order: dict or int
+            Finite difference order of boundary points.
+            Either a dict with key: variable name str,
+            value: order int, or a global integer order
+            for all variables. Default is same as fd_order
+        name: str, optional
+            The problem name
+
+        """
         name = base_problem.name + "_fd" if name is None else name
         super().__init__(base_problem, name)
 
@@ -84,7 +90,7 @@ class LocalFD(ProblemWrapper):
 
         Parameters
         ----------
-        verbosity : int
+        verbosity: int
             The verbosity level, 0 = silent
 
         """
@@ -244,31 +250,31 @@ class LocalFD(ProblemWrapper):
 
         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,)
-        func : iwopy.core.OptFunctionList, optional
+        func: iwopy.core.OptFunctionList, optional
             The functions to be differentiated, or None
             for a list of all objectives and all constraints
             (in that order)
-        components : list of int, optional
+        components: list of int, optional
             The function's component selection, or None for all
-        ivars : list of int
+        ivars: list of int
             The indices of the function int variables in the problem
-        fvars : list of int
+        fvars: list of int
             The indices of the function float variables in the problem
-        vrs : list of int
+        vrs: list of int
             The function float variable indices wrt which the
             derivatives are to be calculated
-        pop : bool
+        pop: bool
             Flag for vectorizing calculations via population
-        verbosity : int
+        verbosity: int
             The verbosity level, 0 = silent
 
         Returns
         -------
-        gradients : numpy.ndarray
+        gradients: numpy.ndarray
             The gradients of the functions, shape:
             (n_components, n_vrs)
 

iwopy/wrappers/problem_wrapper.py

@@ -5,23 +5,29 @@ class ProblemWrapper(Problem):
     """
     Generic abstract problem wrapper class.
 
-    Parameters
-    ----------
-    base_problem : iwopy.Problem
-        The underlying concrete problem
-    name : str
-        The problem name
-    kwargs : dict, optional
-        Additional parameters for the Problem class
-
     Attributes
     ----------
-    base_problem : iwopy.Problem
+    base_problem: iwopy.Problem
         The underlying concrete problem
 
+    :group: wrappers
+
     """
 
     def __init__(self, base_problem, name, **kwargs):
+        """
+        Constructor
+
+        Parameters
+        ----------
+        base_problem: iwopy.Problem
+            The underlying concrete problem
+        name: str
+            The problem name
+        kwargs: dict, optional
+            Additional parameters for the Problem class
+
+        """
         super().__init__(name, **kwargs)
         self.base_problem = base_problem
 
@@ -34,7 +40,7 @@ class ProblemWrapper(Problem):
 
         Returns
         -------
-        names : list of str
+        names: list of str
             The names of the integer variables
 
         """
@@ -46,7 +52,7 @@ class ProblemWrapper(Problem):
 
         Returns
         -------
-        values : numpy.ndarray
+        values: numpy.ndarray
             Initial int values, shape: (n_vars_int,)
 
         """
@@ -60,7 +66,7 @@ class ProblemWrapper(Problem):
 
         Returns
         -------
-        values : numpy.ndarray
+        values: numpy.ndarray
             Minimal int values, shape: (n_vars_int,)
 
         """
@@ -74,7 +80,7 @@ class ProblemWrapper(Problem):
 
         Returns
         -------
-        values : numpy.ndarray
+        values: numpy.ndarray
             Maximal int values, shape: (n_vars_int,)
 
         """
@@ -86,7 +92,7 @@ class ProblemWrapper(Problem):
 
         Returns
         -------
-        names : list of str
+        names: list of str
             The names of the float variables
 
         """
@@ -98,7 +104,7 @@ class ProblemWrapper(Problem):
 
         Returns
         -------
-        values : numpy.ndarray
+        values: numpy.ndarray
             Initial float values, shape: (n_vars_float,)
 
         """
@@ -112,7 +118,7 @@ class ProblemWrapper(Problem):
 
         Returns
         -------
-        values : numpy.ndarray
+        values: numpy.ndarray
             Minimal float values, shape: (n_vars_float,)
 
         """
@@ -126,7 +132,7 @@ class ProblemWrapper(Problem):
 
         Returns
         -------
-        values : numpy.ndarray
+        values: numpy.ndarray
             Maximal float values, shape: (n_vars_float,)
 
         """
@@ -138,7 +144,7 @@ class ProblemWrapper(Problem):
 
         Parameters
         ----------
-        verbosity : int
+        verbosity: int
             The verbosity level, 0 = silent
 
         """
@@ -164,14 +170,14 @@ class ProblemWrapper(Problem):
 
         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
         -------
-        problem_results : Any
+        problem_results: Any
             The results of the variable application
             to the problem
 
@@ -185,14 +191,14 @@ class ProblemWrapper(Problem):
 
         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
         -------
-        problem_results : Any
+        problem_results: Any
             The results of the variable application
             to the problem
 
@@ -205,21 +211,21 @@ class ProblemWrapper(Problem):
 
         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,)
-        verbosity : int
+        verbosity: int
             The verbosity level, 0 = silent
 
         Returns
         -------
-        problem_results : Any
+        problem_results: Any
             The results of the variable application
             to the problem
-        objs : np.array
+        objs: np.array
             The objective function values, shape: (n_objectives,)
-        cons : np.array
+        cons: np.array
             The constraints values, shape: (n_constraints,)
 
         """
@@ -231,23 +237,23 @@ class ProblemWrapper(Problem):
 
         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)
-        verbosity : int
+        verbosity: int
             The verbosity level, 0 = silent
 
         Returns
         -------
-        problem_results : Any
+        problem_results: Any
             The results of the variable application
             to the problem
-        objs : np.array
+        objs: np.array
             The final objective function values, shape: (n_pop, n_components)
-        cons : np.array
+        cons: np.array
             The final constraint values, shape: (n_pop, n_constraints)
 
         """