deploy: 8a66873

.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: e600421525721846e8a21aa900ce7907
+tags: 645f666f9bcd5a90fca523b33c5a78b7

_sources/index.rst.txt

@@ -0,0 +1,31 @@
+:github_url: https://github.com/stephane-caron/lpsolvers/tree/main/doc/src/index.rst
+
+.. title:: Table of Contents
+
+#########
+lpsolvers
+#########
+
+Unified interface to Linear Programming (LP) solvers available in Python.
+
+The library provides a one-stop shop :func:`.solve_lp` function with a
+``solver`` keyword argument to select the backend solver. It solves
+:ref:`linear programs <Linear programming>` in standard form:
+
+.. math::
+
+    \begin{split}\begin{array}{ll}
+        \mbox{minimize} &
+            c^T x \\
+        \mbox{subject to}
+            & G x \leq h \\
+            & A x = b
+    \end{array}\end{split}
+
+.. toctree::
+    :maxdepth: 1
+
+    installation.rst
+    linear-programming.rst
+    supported-solvers.rst
+    references.rst

_sources/installation.rst.txt

@@ -0,0 +1,30 @@
+:github_url: https://github.com/stephane-caron/lpsolvers/tree/main/doc/src/installation.rst
+
+************
+Installation
+************
+
+Linux
+=====
+
+The simplest way to install the package on a recent Debian-based system with
+Python 3 is:
+
+.. code:: bash
+
+    sudo apt install libgmp-dev python3-dev
+    pip install lpsolvers
+
+You can add the ``--user`` parameter for a user-only installation.
+
+Python 2
+--------
+
+If you have an older system with Python 2, for instance Ubuntu 16.04, try:
+
+.. code:: bash
+
+    sudo apt install python-dev
+    pip lpsolvers==0.8.9
+
+Python 2 is not supported any more, but this may still work.

_sources/linear-programming.rst.txt

@@ -0,0 +1,36 @@
+:github_url: https://github.com/stephane-caron/lpsolvers/tree/main/doc/src/linear-programming.rst
+
+.. _Linear programming:
+
+******************
+Linear programming
+******************
+
+To solve a linear program, simply build the matrices that define it and call
+the :func:`.solve_lp` function:
+
+.. code:: python
+
+    from numpy import array
+    from lpsolvers import solve_lp
+
+    c = array([1., 2., 3.])
+    G = array([[1., 2., -1.], [2., 0., 1.], [1., 2., 1.], [-1., -1., -1.]])
+    h = array([4., 1., 3., 2.])
+
+    x = solve_lp(c, G, h)
+    print(f"LP solution: x = {x}")
+
+This example outputs the solution ``[0.30769231, -0.69230769,  1.38461538]``.
+The :func:`.solve_qp` function accepts a ``solver`` keyword argument to select
+the backend solver:
+
+.. autofunction:: lpsolvers.solve_lp
+
+Installed solvers are listed in:
+
+.. autodata:: lpsolvers.available_solvers
+
+See the ``examples/`` folder in the repository for other use cases. For more
+context you can also check out this post on `linear programming in Python
+<https://scaron.info/blog/linear-programming-in-python-with-cvxopt.html>`_.

_sources/references.rst.txt

@@ -0,0 +1,11 @@
+:github_url: https://github.com/stephane-caron/lpsolvers/tree/main/doc/src/references.rst
+
+**********
+References
+**********
+
+.. [tolerances] `Optimality conditions and numerical tolerances in QP solvers <https://scaron.info/blog/optimality-conditions-and-numerical-tolerances-in-qp-solvers.html>`_, S. Caron, 2022.
+
+.. [Bambade2022] `PROX-QP: Yet another Quadratic Programming Solver for Robotics and beyond <https://hal.inria.fr/hal-03683733/file/Yet_another_QP_solver_for_robotics_and_beyond.pdf/>`__, A. Bambade, S. El-Kazdadi, A. Taylor and J. Carpentier. Robotics: Science and Systems. 2022.
+
+.. [Applegate2021] `Practical large-scale linear programming using primal-dual hybrid gradient <https://proceedings.neurips.cc/paper/2021/file/a8fbbd3b11424ce032ba813493d95ad7-Paper.pdf>`_, D. Applegate, M. Díaz, O. Hinder, H. Lu, M. Lubin, B. O'Donoghue, W. Schudy. Advances in Neural Information Processing Systems, 2021, vol. 34, p. 20243-20257.

_sources/supported-solvers.rst.txt

@@ -0,0 +1,35 @@
+:github_url: https://github.com/stephane-caron/lpsolvers/tree/main/doc/src/supported-solvers.rst
+
+*****************
+Supported solvers
+*****************
+
+CVXOPT
+======
+
+.. automodule:: lpsolvers.cvxopt_
+    :members:
+
+CVXPY
+=====
+
+.. automodule:: lpsolvers.cvxpy_
+    :members:
+
+cdd
+===
+
+.. automodule:: lpsolvers.cdd_
+    :members:
+
+PDLP
+====
+
+.. automodule:: lpsolvers.pdlp_
+    :members:
+
+ProxQP
+======
+
+.. automodule:: lpsolvers.proxqp_
+    :members:

_static/_sphinx_javascript_frameworks_compat.js

@@ -0,0 +1,123 @@
+/* Compatability shim for jQuery and underscores.js.
+ *
+ * Copyright Sphinx contributors
+ * Released under the two clause BSD licence
+ */
+
+/**
+ * small helper function to urldecode strings
+ *
+ * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL
+ */
+jQuery.urldecode = function(x) {
+    if (!x) {
+        return x
+    }
+    return decodeURIComponent(x.replace(/\+/g, ' '));
+};
+
+/**
+ * small helper function to urlencode strings
+ */
+jQuery.urlencode = encodeURIComponent;
+
+/**
+ * This function returns the parsed url parameters of the
+ * current request. Multiple values per key are supported,
+ * it will always return arrays of strings for the value parts.
+ */
+jQuery.getQueryParameters = function(s) {
+    if (typeof s === 'undefined')
+        s = document.location.search;
+    var parts = s.substr(s.indexOf('?') + 1).split('&');
+    var result = {};
+    for (var i = 0; i < parts.length; i++) {
+        var tmp = parts[i].split('=', 2);
+        var key = jQuery.urldecode(tmp[0]);
+        var value = jQuery.urldecode(tmp[1]);
+        if (key in result)
+            result[key].push(value);
+        else
+            result[key] = [value];
+    }
+    return result;
+};
+
+/**
+ * highlight a given string on a jquery object by wrapping it in
+ * span elements with the given class name.
+ */
+jQuery.fn.highlightText = function(text, className) {
+    function highlight(node, addItems) {
+        if (node.nodeType === 3) {
+            var val = node.nodeValue;
+            var pos = val.toLowerCase().indexOf(text);
+            if (pos >= 0 &&
+                !jQuery(node.parentNode).hasClass(className) &&
+                !jQuery(node.parentNode).hasClass("nohighlight")) {
+                var span;
+                var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg");
+                if (isInSVG) {
+                    span = document.createElementNS("http://www.w3.org/2000/svg", "tspan");
+                } else {
+                    span = document.createElement("span");
+                    span.className = className;
+                }
+                span.appendChild(document.createTextNode(val.substr(pos, text.length)));
+                node.parentNode.insertBefore(span, node.parentNode.insertBefore(
+                    document.createTextNode(val.substr(pos + text.length)),
+                    node.nextSibling));
+                node.nodeValue = val.substr(0, pos);
+                if (isInSVG) {
+                    var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect");
+                    var bbox = node.parentElement.getBBox();
+                    rect.x.baseVal.value = bbox.x;
+                    rect.y.baseVal.value = bbox.y;
+                    rect.width.baseVal.value = bbox.width;
+                    rect.height.baseVal.value = bbox.height;
+                    rect.setAttribute('class', className);
+                    addItems.push({
+                        "parent": node.parentNode,
+                        "target": rect});
+                }
+            }
+        }
+        else if (!jQuery(node).is("button, select, textarea")) {
+            jQuery.each(node.childNodes, function() {
+                highlight(this, addItems);
+            });
+        }
+    }
+    var addItems = [];
+    var result = this.each(function() {
+        highlight(this, addItems);
+    });
+    for (var i = 0; i < addItems.length; ++i) {
+        jQuery(addItems[i].parent).before(addItems[i].target);
+    }
+    return result;
+};
+
+/*
+ * backward compatibility for jQuery.browser
+ * This will be supported until firefox bug is fixed.
+ */
+if (!jQuery.browser) {
+    jQuery.uaMatch = function(ua) {
+        ua = ua.toLowerCase();
+
+        var match = /(chrome)[ \/]([\w.]+)/.exec(ua) ||
+            /(webkit)[ \/]([\w.]+)/.exec(ua) ||
+            /(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) ||
+            /(msie) ([\w.]+)/.exec(ua) ||
+            ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) ||
+            [];
+
+        return {
+            browser: match[ 1 ] || "",
+            version: match[ 2 ] || "0"
+        };
+    };
+    jQuery.browser = {};
+    jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true;
+}