summaryrefslogtreecommitdiff
path: root/macros/README.rst
diff options
context:
space:
mode:
Diffstat (limited to 'macros/README.rst')
-rw-r--r--macros/README.rst36
1 files changed, 36 insertions, 0 deletions
diff --git a/macros/README.rst b/macros/README.rst
new file mode 100644
index 0000000..5a07f63
--- /dev/null
+++ b/macros/README.rst
@@ -0,0 +1,36 @@
+MACROS
+======
+
+These files mainly consist of functions for checking the input and calling the gateway functions
+
+symphony
+--------
+
+It takes the input in symphony style and checks the input. After all the checks call the symphony_call function.
+
+symphonymat
+-----------
+
+It takes the input in symphony style and checks the input. After all the checks call the symphony_call function.
+
+symphony_call
+-------------
+
+It calls the gateway functions to initialize, set options and to solve it. After that it will call the functions to get the solution for the problem.
+
+setOptions
+----------
+
+It will set the options in the symphony.
+
+qpipopt
+-------
+
+It synatize the input and call solveqp in the ipopt style.
+
+qpipopt
+-------
+
+It synatize the input and call solveqp in the quadprog style.
+
+