sip-python 0.0.1__cp310-cp310-win_amd64.whl

sip_python/__init__.py

@@ -0,0 +1,13 @@
+"""""" # start delvewheel patch
+def _delvewheel_patch_1_10_1():
+    import os
+    if os.path.isdir(libs_dir := os.path.abspath(os.path.join(os.path.dirname(__file__), os.pardir, 'sip_python.libs'))):
+        os.add_dll_directory(libs_dir)
+
+
+_delvewheel_patch_1_10_1()
+del _delvewheel_patch_1_10_1
+# end delvewheel patch
+
+from .sip_python_ext import *
+from .helpers import get_kkt_perm_inv, get_kkt_and_L_nnzs

sip_python/helpers.py

@@ -0,0 +1,89 @@
+import warnings
+
+import numpy as np
+from scipy import sparse as spa
+
+from .sip_python_ext import getLnnz
+
+
+_cvxopt_available = False
+try:
+    from cvxopt import amd, spmatrix
+
+    _cvxopt_available = True
+except ImportError:
+    from scipy.sparse.csgraph import reverse_cuthill_mckee
+
+
+def _get_K(P, A, G):
+    # K = [ P + r1 I_x      A.T        G.T   ]
+    #     [     A        -r2 * I_y      0    ]
+    #     [     G            0       -r3 I_z ]
+
+    if isinstance(P, np.ndarray):
+        P = spa.csc_matrix(P)
+
+    if isinstance(A, np.ndarray):
+        A = spa.csr_matrix(A)
+
+    if isinstance(G, np.ndarray):
+        G = spa.csr_matrix(G)
+
+    x_dim = P.shape[0]
+    s_dim = G.shape[0]
+    y_dim = A.shape[0]
+
+    mod_P = spa.csc_matrix.copy(P)
+    mod_P.data[:] = 1.0
+
+    Z = spa.csc_matrix((y_dim, s_dim))
+
+    K = spa.block_array(
+        blocks=[
+            [mod_P + spa.eye(x_dim), A.T, G.T],
+            [A, -spa.eye(y_dim), Z],
+            [G, Z.T, -spa.eye(s_dim)],
+        ],
+        format="coo",
+    )
+
+    return K
+
+
+def _get_kkt_perm(P, A, G, verbose):
+    K = _get_K(P=P, A=A, G=G)
+
+    if _cvxopt_available:
+        K_cvxopt = spmatrix(
+            I=K.row,
+            J=K.col,
+            V=K.data,
+        )
+        return np.array(list(amd.order(K_cvxopt)))
+    if verbose:
+        warnings.warn(
+            "cvxopt not installed; using reverse Cuthill-McKee (RCM) "
+            "instead of approximate minimum degree (AMD)."
+        )
+    return reverse_cuthill_mckee(spa.csc_matrix(K))
+
+
+def get_kkt_perm_inv(P, A, G, verbose=True):
+    perm = _get_kkt_perm(P=P, A=A, G=G, verbose=verbose)
+
+    perm_inv = np.empty_like(perm)
+    perm_inv[perm] = np.arange(perm_inv.shape[0])
+
+    return perm_inv
+
+
+def get_kkt_and_L_nnzs(P, A, G, perm_inv):
+    K = _get_K(P=P, A=A, G=G)
+
+    permuted_K = spa.coo_matrix.copy(K)
+    permuted_K.row = perm_inv[permuted_K.row]
+    permuted_K.col = perm_inv[permuted_K.col]
+
+    kkt_L_nnz = getLnnz(spa.triu(permuted_K))
+
+    return K.nnz, kkt_L_nnz

sip_python/sip_python_ext.pyi

@@ -0,0 +1,400 @@
+from collections.abc import Callable
+import enum
+from typing import Annotated
+
+from numpy.typing import ArrayLike
+import scipy.sparse
+
+
+FAILED_CHECK: Status = Status.FAILED_CHECK
+
+ITERATION_LIMIT: Status = Status.ITERATION_LIMIT
+
+LINE_SEARCH_FAILURE: Status = Status.LINE_SEARCH_FAILURE
+
+LINE_SEARCH_ITERATION_LIMIT: Status = Status.LINE_SEARCH_ITERATION_LIMIT
+
+class ModelCallbackInput:
+    def __init__(self, problem_dimensions: ProblemDimensions) -> None: ...
+
+    @property
+    def x(self) -> Annotated[ArrayLike, dict(dtype='float64', shape=(None))]: ...
+
+    @property
+    def y(self) -> Annotated[ArrayLike, dict(dtype='float64', shape=(None))]: ...
+
+    @property
+    def z(self) -> Annotated[ArrayLike, dict(dtype='float64', shape=(None))]: ...
+
+class ModelCallbackOutput:
+    def __init__(self) -> None: ...
+
+    @property
+    def f(self) -> float: ...
+
+    @f.setter
+    def f(self, arg: float, /) -> None: ...
+
+    @property
+    def gradient_f(self) -> Annotated[ArrayLike, dict(dtype='float64', shape=(None))]: ...
+
+    @gradient_f.setter
+    def gradient_f(self, arg: Annotated[ArrayLike, dict(dtype='float64', shape=(None))], /) -> None: ...
+
+    @property
+    def upper_hessian_lagrangian(self) -> scipy.sparse.csc_matrix[float]: ...
+
+    @upper_hessian_lagrangian.setter
+    def upper_hessian_lagrangian(self, arg: scipy.sparse.csc_matrix[float], /) -> None: ...
+
+    @property
+    def c(self) -> Annotated[ArrayLike, dict(dtype='float64', shape=(None))]: ...
+
+    @c.setter
+    def c(self, arg: Annotated[ArrayLike, dict(dtype='float64', shape=(None))], /) -> None: ...
+
+    @property
+    def jacobian_c(self) -> scipy.sparse.csr_matrix[float]: ...
+
+    @jacobian_c.setter
+    def jacobian_c(self, arg: scipy.sparse.csr_matrix[float], /) -> None: ...
+
+    @property
+    def g(self) -> Annotated[ArrayLike, dict(dtype='float64', shape=(None))]: ...
+
+    @g.setter
+    def g(self, arg: Annotated[ArrayLike, dict(dtype='float64', shape=(None))], /) -> None: ...
+
+    @property
+    def jacobian_g(self) -> scipy.sparse.csr_matrix[float]: ...
+
+    @jacobian_g.setter
+    def jacobian_g(self, arg: scipy.sparse.csr_matrix[float], /) -> None: ...
+
+class OutputStatus:
+    def __init__(self) -> None: ...
+
+    @property
+    def exit_status(self) -> Status: ...
+
+    @property
+    def num_iterations(self) -> int: ...
+
+    @property
+    def max_primal_violation(self) -> float: ...
+
+    @property
+    def max_dual_violation(self) -> float: ...
+
+class ProblemDimensions:
+    def __init__(self) -> None: ...
+
+    @property
+    def x_dim(self) -> int: ...
+
+    @x_dim.setter
+    def x_dim(self, arg: int, /) -> None: ...
+
+    @property
+    def s_dim(self) -> int: ...
+
+    @s_dim.setter
+    def s_dim(self, arg: int, /) -> None: ...
+
+    @property
+    def y_dim(self) -> int: ...
+
+    @y_dim.setter
+    def y_dim(self, arg: int, /) -> None: ...
+
+    @property
+    def upper_hessian_lagrangian_nnz(self) -> int: ...
+
+    @upper_hessian_lagrangian_nnz.setter
+    def upper_hessian_lagrangian_nnz(self, arg: int, /) -> None: ...
+
+    @property
+    def jacobian_c_nnz(self) -> int: ...
+
+    @jacobian_c_nnz.setter
+    def jacobian_c_nnz(self, arg: int, /) -> None: ...
+
+    @property
+    def jacobian_g_nnz(self) -> int: ...
+
+    @jacobian_g_nnz.setter
+    def jacobian_g_nnz(self, arg: int, /) -> None: ...
+
+    @property
+    def kkt_nnz(self) -> int: ...
+
+    @kkt_nnz.setter
+    def kkt_nnz(self, arg: int, /) -> None: ...
+
+    @property
+    def kkt_L_nnz(self) -> int: ...
+
+    @kkt_L_nnz.setter
+    def kkt_L_nnz(self, arg: int, /) -> None: ...
+
+    @property
+    def is_jacobian_c_transposed(self) -> bool: ...
+
+    @is_jacobian_c_transposed.setter
+    def is_jacobian_c_transposed(self, arg: bool, /) -> None: ...
+
+    @property
+    def is_jacobian_g_transposed(self) -> bool: ...
+
+    @is_jacobian_g_transposed.setter
+    def is_jacobian_g_transposed(self, arg: bool, /) -> None: ...
+
+class QDLDLSettings:
+    def __init__(self) -> None: ...
+
+    @property
+    def permute_kkt_system(self) -> bool: ...
+
+    @permute_kkt_system.setter
+    def permute_kkt_system(self, arg: bool, /) -> None: ...
+
+    @property
+    def kkt_pinv(self) -> Annotated[ArrayLike, dict(dtype='int32', shape=(None))]: ...
+
+    @kkt_pinv.setter
+    def kkt_pinv(self, arg: Annotated[ArrayLike, dict(dtype='int32', shape=(None))], /) -> None: ...
+
+SOLVED: Status = Status.SOLVED
+
+class Settings:
+    def __init__(self) -> None: ...
+
+    @property
+    def max_iterations(self) -> int: ...
+
+    @max_iterations.setter
+    def max_iterations(self, arg: int, /) -> None: ...
+
+    @property
+    def max_ls_iterations(self) -> int: ...
+
+    @max_ls_iterations.setter
+    def max_ls_iterations(self, arg: int, /) -> None: ...
+
+    @property
+    def min_iterations_for_convergence(self) -> int: ...
+
+    @min_iterations_for_convergence.setter
+    def min_iterations_for_convergence(self, arg: int, /) -> None: ...
+
+    @property
+    def num_iterative_refinement_steps(self) -> int: ...
+
+    @num_iterative_refinement_steps.setter
+    def num_iterative_refinement_steps(self, arg: int, /) -> None: ...
+
+    @property
+    def max_aug_kkt_violation(self) -> float: ...
+
+    @max_aug_kkt_violation.setter
+    def max_aug_kkt_violation(self, arg: float, /) -> None: ...
+
+    @property
+    def max_merit_slope(self) -> float: ...
+
+    @max_merit_slope.setter
+    def max_merit_slope(self, arg: float, /) -> None: ...
+
+    @property
+    def tau(self) -> float: ...
+
+    @tau.setter
+    def tau(self, arg: float, /) -> None: ...
+
+    @property
+    def start_ls_with_alpha_s_max(self) -> bool: ...
+
+    @start_ls_with_alpha_s_max.setter
+    def start_ls_with_alpha_s_max(self, arg: bool, /) -> None: ...
+
+    @property
+    def initial_mu(self) -> float: ...
+
+    @initial_mu.setter
+    def initial_mu(self, arg: float, /) -> None: ...
+
+    @property
+    def mu_update_factor(self) -> float: ...
+
+    @mu_update_factor.setter
+    def mu_update_factor(self, arg: float, /) -> None: ...
+
+    @property
+    def mu_min(self) -> float: ...
+
+    @mu_min.setter
+    def mu_min(self, arg: float, /) -> None: ...
+
+    @property
+    def initial_penalty_parameter(self) -> float: ...
+
+    @initial_penalty_parameter.setter
+    def initial_penalty_parameter(self, arg: float, /) -> None: ...
+
+    @property
+    def min_acceptable_constraint_violation_ratio(self) -> float: ...
+
+    @min_acceptable_constraint_violation_ratio.setter
+    def min_acceptable_constraint_violation_ratio(self, arg: float, /) -> None: ...
+
+    @property
+    def penalty_parameter_increase_factor(self) -> float: ...
+
+    @penalty_parameter_increase_factor.setter
+    def penalty_parameter_increase_factor(self, arg: float, /) -> None: ...
+
+    @property
+    def penalty_parameter_decrease_factor(self) -> float: ...
+
+    @penalty_parameter_decrease_factor.setter
+    def penalty_parameter_decrease_factor(self, arg: float, /) -> None: ...
+
+    @property
+    def max_penalty_parameter(self) -> float: ...
+
+    @max_penalty_parameter.setter
+    def max_penalty_parameter(self, arg: float, /) -> None: ...
+
+    @property
+    def armijo_factor(self) -> float: ...
+
+    @armijo_factor.setter
+    def armijo_factor(self, arg: float, /) -> None: ...
+
+    @property
+    def line_search_factor(self) -> float: ...
+
+    @line_search_factor.setter
+    def line_search_factor(self, arg: float, /) -> None: ...
+
+    @property
+    def line_search_min_step_size(self) -> float: ...
+
+    @line_search_min_step_size.setter
+    def line_search_min_step_size(self, arg: float, /) -> None: ...
+
+    @property
+    def min_merit_slope_to_skip_line_search(self) -> float: ...
+
+    @min_merit_slope_to_skip_line_search.setter
+    def min_merit_slope_to_skip_line_search(self, arg: float, /) -> None: ...
+
+    @property
+    def enable_elastics(self) -> bool: ...
+
+    @enable_elastics.setter
+    def enable_elastics(self, arg: bool, /) -> None: ...
+
+    @property
+    def elastic_var_cost_coeff(self) -> float: ...
+
+    @elastic_var_cost_coeff.setter
+    def elastic_var_cost_coeff(self, arg: float, /) -> None: ...
+
+    @property
+    def enable_line_search_failures(self) -> bool: ...
+
+    @enable_line_search_failures.setter
+    def enable_line_search_failures(self, arg: bool, /) -> None: ...
+
+    @property
+    def print_logs(self) -> bool: ...
+
+    @print_logs.setter
+    def print_logs(self, arg: bool, /) -> None: ...
+
+    @property
+    def print_line_search_logs(self) -> bool: ...
+
+    @print_line_search_logs.setter
+    def print_line_search_logs(self, arg: bool, /) -> None: ...
+
+    @property
+    def print_search_direction_logs(self) -> bool: ...
+
+    @print_search_direction_logs.setter
+    def print_search_direction_logs(self, arg: bool, /) -> None: ...
+
+    @property
+    def print_derivative_check_logs(self) -> bool: ...
+
+    @print_derivative_check_logs.setter
+    def print_derivative_check_logs(self, arg: bool, /) -> None: ...
+
+    @property
+    def only_check_search_direction_slope(self) -> bool: ...
+
+    @only_check_search_direction_slope.setter
+    def only_check_search_direction_slope(self, arg: bool, /) -> None: ...
+
+    @property
+    def assert_checks_pass(self) -> bool: ...
+
+    @assert_checks_pass.setter
+    def assert_checks_pass(self, arg: bool, /) -> None: ...
+
+class Solver:
+    def __init__(self, sip_settings: Settings, qdldl_settings: QDLDLSettings, problem_dimension: ProblemDimensions, model_callback: Callable[[ModelCallbackInput], ModelCallbackOutput]) -> None: ...
+
+    def solve(self, arg: Variables, /) -> OutputStatus: ...
+
+class Status(enum.Enum):
+    SOLVED = 0
+
+    ITERATION_LIMIT = 1
+
+    LINE_SEARCH_ITERATION_LIMIT = 2
+
+    LINE_SEARCH_FAILURE = 3
+
+    TIMEOUT = 4
+
+    FAILED_CHECK = 5
+
+TIMEOUT: Status = Status.TIMEOUT
+
+class Variables:
+    def __init__(self, problem_dimensions: ProblemDimensions) -> None: ...
+
+    @property
+    def x(self) -> Annotated[ArrayLike, dict(dtype='float64', shape=(None))]: ...
+
+    @x.setter
+    def x(self, arg: Annotated[ArrayLike, dict(dtype='float64', shape=(None))], /) -> None: ...
+
+    @property
+    def s(self) -> Annotated[ArrayLike, dict(dtype='float64', shape=(None))]: ...
+
+    @s.setter
+    def s(self, arg: Annotated[ArrayLike, dict(dtype='float64', shape=(None))], /) -> None: ...
+
+    @property
+    def e(self) -> Annotated[ArrayLike, dict(dtype='float64', shape=(None))]: ...
+
+    @e.setter
+    def e(self, arg: Annotated[ArrayLike, dict(dtype='float64', shape=(None))], /) -> None: ...
+
+    @property
+    def y(self) -> Annotated[ArrayLike, dict(dtype='float64', shape=(None))]: ...
+
+    @y.setter
+    def y(self, arg: Annotated[ArrayLike, dict(dtype='float64', shape=(None))], /) -> None: ...
+
+    @property
+    def z(self) -> Annotated[ArrayLike, dict(dtype='float64', shape=(None))]: ...
+
+    @z.setter
+    def z(self, arg: Annotated[ArrayLike, dict(dtype='float64', shape=(None))], /) -> None: ...
+
+def getLnnz(arg: scipy.sparse.csc_matrix[float], /) -> int:
+    """Computes L's nnz for an L D L^T decomposition."""

sip_python-0.0.1.dist-info/DELVEWHEEL

@@ -0,0 +1,2 @@
+Version: 1.10.1
+Arguments: ['C:\\hostedtoolcache\\windows\\Python\\3.13.3\\x64\\Scripts\\delvewheel', 'repair', '-w', 'C:\\Users\\runneradmin\\AppData\\Local\\Temp\\cibw-run-b55lr07d\\cp310-win_amd64\\repaired_wheel', 'C:\\Users\\runneradmin\\AppData\\Local\\Temp\\cibw-run-b55lr07d\\cp310-win_amd64\\built_wheel\\sip_python-0.0.1-cp310-cp310-win_amd64.whl']

sip_python-0.0.1.dist-info/METADATA

@@ -0,0 +1,21 @@
+Metadata-Version: 2.4
+Name: sip_python
+Version: 0.0.1
+Summary: Python bindings for the SIP solver.
+Author-email: João Sousa-Pinto <joaospinto@gmail.com>
+Project-URL: Homepage, https://github.com/joaospinto/sip_python
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Scientific/Engineering :: Mathematics
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy
+Requires-Dist: scipy
+Dynamic: license-file
+
+# sip_python
+[![pip](https://github.com/joaospinto/sip_python/actions/workflows/pip.yml/badge.svg)](https://github.com/joaospinto/sip_python/actions?query=workflow%3Apip)
+[![wheels](https://github.com/joaospinto/sip_python/actions/workflows/wheels.yml/badge.svg)](https://github.com/joaospinto/sip_python/actions?query=workflow%3Awheels)
+
+Python bindings for the [SIP](https://github.com/joaospinto/sip) solver.

sip_python-0.0.1.dist-info/RECORD

@@ -0,0 +1,12 @@
+sip_python/helpers.py,sha256=44t4P3BhlxAEIr0Lmw-Zt4YkYssHA-jCuyA6Q445zd4,2098
+sip_python/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+sip_python/sip_python_ext.pyd,sha256=CHrPTX5muPpO7TANaw9OJo4L0pfGIm_9HAQOOIYERn8,305664
+sip_python/sip_python_ext.pyi,sha256=hYmztEDaaPINBGa7REg5QOnwrQLWY9uskXdx1kjgugw,11336
+sip_python/__init__.py,sha256=gokroSC0YGqyBN8dqZL2ni488eipzH_Yg7_sOJz8LhE,422
+sip_python-0.0.1.dist-info/DELVEWHEEL,sha256=lzDj30VBORigyz0aE4BRqAUOB4uOTfZ_8E9vmibF4pQ,359
+sip_python-0.0.1.dist-info/METADATA,sha256=J68kGdF84fbOctIci3t4QcodGwoJLsLmXHKGVTVJbug,956
+sip_python-0.0.1.dist-info/RECORD,,
+sip_python-0.0.1.dist-info/top_level.txt,sha256=5QmJfOhrh7J2oFyurVi_u8iADQdBrS2anrclo5fn0Bg,11
+sip_python-0.0.1.dist-info/WHEEL,sha256=AVu1DavlWPCypqX8sBQ58NLvImUaO9Rw16t7hIak0pw,101
+sip_python-0.0.1.dist-info/licenses/LICENSE,sha256=jPWDEHod2x7776vWNSNBO1hb1it373Jo5LQWtASxXTw,1095
+sip_python.libs/msvcp140-2f8cc3346207715d602d6abb85136fdb.dll,sha256=pMIim9wqKmMKzcCVtNhgCOXD47x3cxdDVPPaT1vrnN4,575056

sip_python-0.0.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.1.0)
+Root-Is-Purelib: false
+Tag: cp310-cp310-win_amd64
+

sip_python-0.0.1.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 João Sousa Pinto
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

sip_python-0.0.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+sip_python