Gitiles
Code Review Sign In
realtimeroboticsgroup.org / RealtimeRoboticsGroup / test / c1ded373f365b8ed2238f70d6885fabf39e9cd88 / . / third_party / osqp / docs / interfaces / index.rst
blob: 800d422c0fc9a7a9972fc72a9459140d98968917 [file] [log] [blame]
Austin Schuh9049e202022-02-20 17:34:16 -0800[diff] [blame]1Interfaces
2============
3
4OSQP has several interfaces. The information about settings, status values and how to assign different linear system solvers appear in the following links
5
6* :ref:`Solver settings <solver_settings>`
7* :ref:`Linear system solvers <linear_system_solvers_setting>`
8* :ref:`Status values <status_values>`
9
10
11
12.. toctree::
13 :maxdepth: 1
14 :glob:
15 :hidden:
16
17 solver_settings.rst
18 linear_systems_solvers.rst
19 status_values.rst
20
21
22Official
23----------
24
25+------------------------------------+----------------------------------------------------------+------------------------------------------------------------------------------------------+
26| Language | Maintainers | Repository |
27+====================================+==========================================================+==========================================================================================+
28| :ref:`C <c_interface>` | | `Bartolomeo Stellato <bartolomeo.stellato@gmail.com>`_ | `github.com/osqp/osqp <https://github.com/osqp/osqp>`_ |
29| | | `Goran Banjac <gbanjac@control.ee.ethz.ch>`_ | |
30| | | `Paul Goulart <paul.goulart@eng.ox.ac.uk>`_ | |
31+------------------------------------+----------------------------------------------------------+------------------------------------------------------------------------------------------+
32| :ref:`Python <python_interface>` | | `Bartolomeo Stellato <bartolomeo.stellato@gmail.com>`_ | `github.com/osqp/osqp-python <https://github.com/osqp/osqp-python>`_ |
33| | | `Goran Banjac <gbanjac@control.ee.ethz.ch>`_ | |
34+------------------------------------+----------------------------------------------------------+------------------------------------------------------------------------------------------+
35| :ref:`Matlab <matlab_interface>` | | `Bartolomeo Stellato <bartolomeo.stellato@gmail.com>`_ | `github.com/osqp/osqp-matlab <https://github.com/osqp/osqp-matlab>`_ |
36| | | `Goran Banjac <gbanjac@control.ee.ethz.ch>`_ | |
37| | | `Paul Goulart <paul.goulart@eng.ox.ac.uk>`_ | |
38+------------------------------------+----------------------------------------------------------+------------------------------------------------------------------------------------------+
39| :ref:`Julia <julia_interface>` | | `Twan Koolen <tkoolen@mit.edu>`_ | `github.com/osqp/OSQP.jl <https://github.com/osqp/OSQP.jl>`_ |
40| | | `Benoît Legat <benoit.legat@uclouvain.be>`_ | |
41| | | `Bartolomeo Stellato <bartolomeo.stellato@gmail.com>`_ | |
42+------------------------------------+----------------------------------------------------------+------------------------------------------------------------------------------------------+
43| :ref:`R <rlang_interface>` | | `Bartolomeo Stellato <bartolomeo.stellato@gmail.com>`_ | `github.com/osqp/osqp-r <https://github.com/osqp/osqp-r>`_ |
44| | | `Paul Goulart <paul.goulart@eng.ox.ac.uk>`_ | |
45+------------------------------------+----------------------------------------------------------+------------------------------------------------------------------------------------------+
46
47
48
49.. toctree::
50 :maxdepth: 1
51 :glob:
52 :hidden:
53
54 C.rst
55 python.rst
56 matlab.rst
57 julia.rst
58 rlang.rst
59
60
61
62
63
64
65
66
67
68Community Maintained
69--------------------
70
71
72+------------------------------------------------+----------------------------------------------------------+------------------------------------------------------------------------------------------+
73| Language | Maintainers | Repository |
74+================================================+==========================================================+==========================================================================================+
75| :ref:`C++/Eigen Google <eigen_google>` | | `Miles Lubin <miles.lubin@gmail.com>`_ | `github.com/google/osqp-cpp <https://github.com/google/osqp-cpp>`_ |
76+------------------------------------------------+----------------------------------------------------------+------------------------------------------------------------------------------------------+
77| :ref:`C++/Eigen Robotology <eigen_robotology>` | | `Giulio Romualdi <giulio.romualdi@gmail.com>`_ | `github.com/robotology/osqp-eigen <https://github.com/robotology/osqp-eigen>`_ |
78+------------------------------------------------+----------------------------------------------------------+------------------------------------------------------------------------------------------+
79| :ref:`Rust <rust_interface>` | | `Ed Barnard <eabarnard@gmail.com>`_ | `github.com/osqp/osqp.rs <https://github.com/osqp/osqp.rs>`_ |
80+------------------------------------------------+----------------------------------------------------------+------------------------------------------------------------------------------------------+
81| :ref:`Ruby <ruby_interface>` | | `Andrew Kane <andrew@chartkick.com>`_ | `https://github.com/ankane/osqp <https://github.com/ankane/osqp>`_ |
82+------------------------------------------------+----------------------------------------------------------+------------------------------------------------------------------------------------------+
83| :ref:`Fortran <fortran_interface>` | | `Nick Gould <nick.gould@stfc.ac.uk>`_ | `github.com/osqp/osqp-fortran <https://github.com/osqp/osqp-fortran>`_ |
84| | | `Bartolomeo Stellato <bartolomeo.stellato@gmail.com>`_ | |
85| | | `Paul Goulart <paul.goulart@eng.ox.ac.uk>`_ | |
86+------------------------------------------------+----------------------------------------------------------+------------------------------------------------------------------------------------------+
87| :ref:`Cutest <cutest_interface>` | | `Nick Gould <nick.gould@stfc.ac.uk>`_ | `github.com/ralna/CUTEst <https://github.com/ralna/CUTEst/tree/master/src/osqp>`_ |
88+------------------------------------------------+----------------------------------------------------------+------------------------------------------------------------------------------------------+
89
90
91
92.. toctree::
93 :maxdepth: 1
94 :glob:
95 :hidden:
96
97 eigen_google.rst
98 eigen_robotology.rst
99 rust.rst
100 ruby.rst
101 fortran.rst
102 cutest.rst
103
104