Skip to content

Commit 5e3cc9a

Browse files
actions-useractions-user
committed
documentation for ffb1573 
1 parent 79d5a7c commit 5e3cc9a

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

57 files changed

+11873
-0
lines changed

‎api-dox/html/.buildinfo‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Sphinx build info version 1
2+
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3+
config: db84b0eb75e88d72c5fd074f92afbbc6
4+
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎api-dox/html/_sources/index.rst.txt‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
.. OpEn documentation master file, created by
2+
sphinx-quickstart on Sat Nov 26 02:57:18 2022.
3+
You can adapt this file completely to your liking, but it should at least
4+
contain the root `toctree` directive.
5+
6+
Opengen API docs
7+
================================
8+
9+
This is the opengen API documentation. Check out the main `OpEn documentation page <https://alphaville.github.io/optimization-engine/>`_ to get started with OpEn.
10+
11+
You can get a list of all `modules <modules.html>`_ here.
12+
13+
14+
.. toctree::
15+
:maxdepth: 2
16+
:caption: Contents:
17+
18+
19+
20+
Contents
21+
==================
22+
23+
* `Modules <modules.html>`_
24+
* :ref:`genindex`
25+
* :ref:`modindex`
26+
* :ref:`search`
27+
28+
Last updated: Sun Oct 29 13:13:46 UTC 2023

‎api-dox/html/_sources/modules.rst.txt‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
opengen
2+
=======
3+
4+
.. toctree::
5+
:maxdepth: 4
6+
7+
opengen

‎api-dox/html/_sources/opengen.builder.rst.txt‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
opengen.builder package
2+
=======================
3+
4+
Submodules
5+
----------
6+
7+
opengen.builder.optimizer\_builder module
8+
-----------------------------------------
9+
10+
.. automodule:: opengen.builder.optimizer_builder
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
opengen.builder.problem module
16+
------------------------------
17+
18+
.. automodule:: opengen.builder.problem
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
opengen.builder.ros\_builder module
24+
-----------------------------------
25+
26+
.. automodule:: opengen.builder.ros_builder
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
30+
31+
opengen.builder.set\_y\_calculator module
32+
-----------------------------------------
33+
34+
.. automodule:: opengen.builder.set_y_calculator
35+
:members:
36+
:undoc-members:
37+
:show-inheritance:
38+
39+
Module contents
40+
---------------
41+
42+
.. automodule:: opengen.builder
43+
:members:
44+
:undoc-members:
45+
:show-inheritance:

‎api-dox/html/_sources/opengen.config.rst.txt‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
opengen.config package
2+
======================
3+
4+
Submodules
5+
----------
6+
7+
opengen.config.build\_config module
8+
-----------------------------------
9+
10+
.. automodule:: opengen.config.build_config
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
opengen.config.meta module
16+
--------------------------
17+
18+
.. automodule:: opengen.config.meta
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
opengen.config.ros\_config module
24+
---------------------------------
25+
26+
.. automodule:: opengen.config.ros_config
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
30+
31+
opengen.config.solver\_config module
32+
------------------------------------
33+
34+
.. automodule:: opengen.config.solver_config
35+
:members:
36+
:undoc-members:
37+
:show-inheritance:
38+
39+
opengen.config.tcp\_server\_config module
40+
-----------------------------------------
41+
42+
.. automodule:: opengen.config.tcp_server_config
43+
:members:
44+
:undoc-members:
45+
:show-inheritance:
46+
47+
Module contents
48+
---------------
49+
50+
.. automodule:: opengen.config
51+
:members:
52+
:undoc-members:
53+
:show-inheritance:

‎api-dox/html/_sources/opengen.constraints.rst.txt‎

Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
opengen.constraints package
2+
===========================
3+
4+
Submodules
5+
----------
6+
7+
opengen.constraints.ball1 module
8+
--------------------------------
9+
10+
.. automodule:: opengen.constraints.ball1
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
opengen.constraints.ball2 module
16+
--------------------------------
17+
18+
.. automodule:: opengen.constraints.ball2
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
opengen.constraints.ball\_inf module
24+
------------------------------------
25+
26+
.. automodule:: opengen.constraints.ball_inf
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
30+
31+
opengen.constraints.cartesian module
32+
------------------------------------
33+
34+
.. automodule:: opengen.constraints.cartesian
35+
:members:
36+
:undoc-members:
37+
:show-inheritance:
38+
39+
opengen.constraints.constraint module
40+
-------------------------------------
41+
42+
.. automodule:: opengen.constraints.constraint
43+
:members:
44+
:undoc-members:
45+
:show-inheritance:
46+
47+
opengen.constraints.finite\_set module
48+
--------------------------------------
49+
50+
.. automodule:: opengen.constraints.finite_set
51+
:members:
52+
:undoc-members:
53+
:show-inheritance:
54+
55+
opengen.constraints.halfspace module
56+
------------------------------------
57+
58+
.. automodule:: opengen.constraints.halfspace
59+
:members:
60+
:undoc-members:
61+
:show-inheritance:
62+
63+
opengen.constraints.no\_constraints module
64+
------------------------------------------
65+
66+
.. automodule:: opengen.constraints.no_constraints
67+
:members:
68+
:undoc-members:
69+
:show-inheritance:
70+
71+
opengen.constraints.rectangle module
72+
------------------------------------
73+
74+
.. automodule:: opengen.constraints.rectangle
75+
:members:
76+
:undoc-members:
77+
:show-inheritance:
78+
79+
opengen.constraints.simplex module
80+
----------------------------------
81+
82+
.. automodule:: opengen.constraints.simplex
83+
:members:
84+
:undoc-members:
85+
:show-inheritance:
86+
87+
opengen.constraints.soc module
88+
------------------------------
89+
90+
.. automodule:: opengen.constraints.soc
91+
:members:
92+
:undoc-members:
93+
:show-inheritance:
94+
95+
opengen.constraints.zero module
96+
-------------------------------
97+
98+
.. automodule:: opengen.constraints.zero
99+
:members:
100+
:undoc-members:
101+
:show-inheritance:
102+
103+
Module contents
104+
---------------
105+
106+
.. automodule:: opengen.constraints
107+
:members:
108+
:undoc-members:
109+
:show-inheritance:

‎api-dox/html/_sources/opengen.functions.rst.txt‎

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
opengen.functions package
2+
=========================
3+
4+
Submodules
5+
----------
6+
7+
opengen.functions.fabs module
8+
-----------------------------
9+
10+
.. automodule:: opengen.functions.fabs
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
opengen.functions.fmax module
16+
-----------------------------
17+
18+
.. automodule:: opengen.functions.fmax
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
opengen.functions.fmin module
24+
-----------------------------
25+
26+
.. automodule:: opengen.functions.fmin
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
30+
31+
opengen.functions.is\_numeric module
32+
------------------------------------
33+
34+
.. automodule:: opengen.functions.is_numeric
35+
:members:
36+
:undoc-members:
37+
:show-inheritance:
38+
39+
opengen.functions.is\_symbolic module
40+
-------------------------------------
41+
42+
.. automodule:: opengen.functions.is_symbolic
43+
:members:
44+
:undoc-members:
45+
:show-inheritance:
46+
47+
opengen.functions.norm2 module
48+
------------------------------
49+
50+
.. automodule:: opengen.functions.norm2
51+
:members:
52+
:undoc-members:
53+
:show-inheritance:
54+
55+
opengen.functions.norm2\_squared module
56+
---------------------------------------
57+
58+
.. automodule:: opengen.functions.norm2_squared
59+
:members:
60+
:undoc-members:
61+
:show-inheritance:
62+
63+
opengen.functions.rosenbrock module
64+
-----------------------------------
65+
66+
.. automodule:: opengen.functions.rosenbrock
67+
:members:
68+
:undoc-members:
69+
:show-inheritance:
70+
71+
opengen.functions.sign module
72+
-----------------------------
73+
74+
.. automodule:: opengen.functions.sign
75+
:members:
76+
:undoc-members:
77+
:show-inheritance:
78+
79+
Module contents
80+
---------------
81+
82+
.. automodule:: opengen.functions
83+
:members:
84+
:undoc-members:
85+
:show-inheritance:

‎api-dox/html/_sources/opengen.rst.txt‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
opengen package
2+
===============
3+
4+
Subpackages
5+
-----------
6+
7+
.. toctree::
8+
:maxdepth: 4
9+
10+
opengen.builder
11+
opengen.config
12+
opengen.constraints
13+
opengen.functions
14+
opengen.tcp
15+
16+
Submodules
17+
----------
18+
19+
opengen.definitions module
20+
--------------------------
21+
22+
.. automodule:: opengen.definitions
23+
:members:
24+
:undoc-members:
25+
:show-inheritance:
26+
27+
Module contents
28+
---------------
29+
30+
.. automodule:: opengen
31+
:members:
32+
:undoc-members:
33+
:show-inheritance:

0 commit comments

Comments
 (0)