summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorMichael Schneeberger <michael.schneeberger@fhnw.ch>2023-01-30 13:35:04 +0100
committerMichael Schneeberger <michael.schneeberger@fhnw.ch>2023-01-30 13:35:04 +0100
commita3c417fe0bc2c7a2ca789b890dfba1e245fe2e79 (patch)
tree0d158e304927704aabb37896e0d24f8fe04d88a1 /README.md
parentfrom sympy expression does not accept numpy arrays (diff)
downloadpolymatrix-a3c417fe0bc2c7a2ca789b890dfba1e245fe2e79.tar.gz
polymatrix-a3c417fe0bc2c7a2ca789b890dfba1e245fe2e79.zip
update README
Diffstat (limited to '')
-rw-r--r--README.md6
1 files changed, 3 insertions, 3 deletions
diff --git a/README.md b/README.md
index 5c56079..d114b6d 100644
--- a/README.md
+++ b/README.md
@@ -9,9 +9,9 @@ It is used to define Sum Of Squares optimization problems.
Some aspects of the library:
* it has a lazy behavior
- * the library implements operators to build polynomial expression
+ * the library implements operators to build polynomial expressions
* the actual polynomial is created by calling the [`apply(state)`](https://gitlab.nccr-automation.ch/michael.schneeberger/polymatrix/-/blob/main/polymatrix/expression/mixins/expressionbasemixin.py) method on the polynomial expression
-* a `sympy` expression is converted to a polynomial expression using the [`polymatrix.from_sympy`](https://gitlab.nccr-automation.ch/michael.schneeberger/polymatrix/-/blob/main/polymatrix/__init__.py) function
+* a `sympy` expression is converted to a polynomial expression using the [`polymatrix.from_`](https://gitlab.nccr-automation.ch/michael.schneeberger/polymatrix/-/blob/main/polymatrix/__init__.py) function
* multiple polynomial expressions are combined using functions like
* [`polymatrix.v_stack`](https://gitlab.nccr-automation.ch/michael.schneeberger/polymatrix/-/blob/main/polymatrix/__init__.py)
* [`polymatrix.block_diag`](https://gitlab.nccr-automation.ch/michael.schneeberger/polymatrix/-/blob/main/polymatrix/__init__.py).
@@ -31,7 +31,7 @@ f_1(x_1, x_2) = x_1 + x_2
f_2(x_1, x_2) = x_1 + x_1 x_2
-Then, the two expression are combined using the [`__add__`](https://gitlab.nccr-automation.ch/michael.schneeberger/polymatrix/-/blob/main/polymatrix/expression/mixins/expressionmixin.py) (or equivalently `+`) method
+Then, the two expression are combined using the [`__add__`](https://gitlab.nccr-automation.ch/michael.schneeberger/polymatrix/-/blob/main/polymatrix/expression/mixins/expressionmixin.py) (or equivalently `+` infix) method
f_3(x_1, x_2) = f_1(x_1, x_2) + f_2(x_1, x_2) = 2 x_1 + x_2 + x_1 x_2