documentation for ffb1573

api-dox/html/.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: db84b0eb75e88d72c5fd074f92afbbc6
+tags: 645f666f9bcd5a90fca523b33c5a78b7

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

@@ -0,0 +1,28 @@
+.. OpEn documentation master file, created by
+   sphinx-quickstart on Sat Nov 26 02:57:18 2022.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Opengen API docs
+================================
+
+This is the opengen API documentation. Check out the main `OpEn documentation page <https://alphaville.github.io/optimization-engine/>`_ to get started with OpEn.
+
+You can get a list of all `modules <modules.html>`_ here.
+
+
+.. toctree::
+   :maxdepth: 2   
+   :caption: Contents:
+
+
+
+Contents
+==================
+
+* `Modules <modules.html>`_
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
+Last updated: Sun Oct 29 13:13:46 UTC 2023

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

@@ -0,0 +1,7 @@
+opengen
+=======
+
+.. toctree::
+   :maxdepth: 4
+
+   opengen

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

@@ -0,0 +1,45 @@
+opengen.builder package
+=======================
+
+Submodules
+----------
+
+opengen.builder.optimizer\_builder module
+-----------------------------------------
+
+.. automodule:: opengen.builder.optimizer_builder
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+opengen.builder.problem module
+------------------------------
+
+.. automodule:: opengen.builder.problem
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+opengen.builder.ros\_builder module
+-----------------------------------
+
+.. automodule:: opengen.builder.ros_builder
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+opengen.builder.set\_y\_calculator module
+-----------------------------------------
+
+.. automodule:: opengen.builder.set_y_calculator
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: opengen.builder
+   :members:
+   :undoc-members:
+   :show-inheritance:

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

@@ -0,0 +1,53 @@
+opengen.config package
+======================
+
+Submodules
+----------
+
+opengen.config.build\_config module
+-----------------------------------
+
+.. automodule:: opengen.config.build_config
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+opengen.config.meta module
+--------------------------
+
+.. automodule:: opengen.config.meta
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+opengen.config.ros\_config module
+---------------------------------
+
+.. automodule:: opengen.config.ros_config
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+opengen.config.solver\_config module
+------------------------------------
+
+.. automodule:: opengen.config.solver_config
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+opengen.config.tcp\_server\_config module
+-----------------------------------------
+
+.. automodule:: opengen.config.tcp_server_config
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: opengen.config
+   :members:
+   :undoc-members:
+   :show-inheritance:

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

@@ -0,0 +1,109 @@
+opengen.constraints package
+===========================
+
+Submodules
+----------
+
+opengen.constraints.ball1 module
+--------------------------------
+
+.. automodule:: opengen.constraints.ball1
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+opengen.constraints.ball2 module
+--------------------------------
+
+.. automodule:: opengen.constraints.ball2
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+opengen.constraints.ball\_inf module
+------------------------------------
+
+.. automodule:: opengen.constraints.ball_inf
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+opengen.constraints.cartesian module
+------------------------------------
+
+.. automodule:: opengen.constraints.cartesian
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+opengen.constraints.constraint module
+-------------------------------------
+
+.. automodule:: opengen.constraints.constraint
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+opengen.constraints.finite\_set module
+--------------------------------------
+
+.. automodule:: opengen.constraints.finite_set
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+opengen.constraints.halfspace module
+------------------------------------
+
+.. automodule:: opengen.constraints.halfspace
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+opengen.constraints.no\_constraints module
+------------------------------------------
+
+.. automodule:: opengen.constraints.no_constraints
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+opengen.constraints.rectangle module
+------------------------------------
+
+.. automodule:: opengen.constraints.rectangle
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+opengen.constraints.simplex module
+----------------------------------
+
+.. automodule:: opengen.constraints.simplex
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+opengen.constraints.soc module
+------------------------------
+
+.. automodule:: opengen.constraints.soc
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+opengen.constraints.zero module
+-------------------------------
+
+.. automodule:: opengen.constraints.zero
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: opengen.constraints
+   :members:
+   :undoc-members:
+   :show-inheritance:

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

@@ -0,0 +1,85 @@
+opengen.functions package
+=========================
+
+Submodules
+----------
+
+opengen.functions.fabs module
+-----------------------------
+
+.. automodule:: opengen.functions.fabs
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+opengen.functions.fmax module
+-----------------------------
+
+.. automodule:: opengen.functions.fmax
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+opengen.functions.fmin module
+-----------------------------
+
+.. automodule:: opengen.functions.fmin
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+opengen.functions.is\_numeric module
+------------------------------------
+
+.. automodule:: opengen.functions.is_numeric
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+opengen.functions.is\_symbolic module
+-------------------------------------
+
+.. automodule:: opengen.functions.is_symbolic
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+opengen.functions.norm2 module
+------------------------------
+
+.. automodule:: opengen.functions.norm2
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+opengen.functions.norm2\_squared module
+---------------------------------------
+
+.. automodule:: opengen.functions.norm2_squared
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+opengen.functions.rosenbrock module
+-----------------------------------
+
+.. automodule:: opengen.functions.rosenbrock
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+opengen.functions.sign module
+-----------------------------
+
+.. automodule:: opengen.functions.sign
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: opengen.functions
+   :members:
+   :undoc-members:
+   :show-inheritance:

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

@@ -0,0 +1,33 @@
+opengen package
+===============
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   opengen.builder
+   opengen.config
+   opengen.constraints
+   opengen.functions
+   opengen.tcp
+
+Submodules
+----------
+
+opengen.definitions module
+--------------------------
+
+.. automodule:: opengen.definitions
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: opengen
+   :members:
+   :undoc-members:
+   :show-inheritance: