Skip to content

Commit 816809a

Browse files
committed
change version number and add documentation
1 parent 07e9fa7 commit 816809a

1 file changed

Lines changed: 20 additions & 1 deletion

File tree

README.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
<p align="center">
66
<a href="https://shields.io/" alt="">
7-
<img src="https://img.shields.io/badge/Version-0.2-orange.svg" /></a>
7+
<img src="https://img.shields.io/badge/Version-0.2.1-orange.svg" /></a>
88
<a href="https://shields.io/" alt="">
99
<img src="https://img.shields.io/badge/Status-Beta-orange.svg" /></a>
1010
<a href="https://shields.io/" alt="">
@@ -137,3 +137,22 @@ int main()
137137
}
138138
```
139139
See the [tests](tests) for more examples.
140+
141+
### Problem Formulation
142+
The following terms may be passed to the contraint functions:
143+
144+
| Function | Allowed expressions |
145+
| --- | --- |
146+
| `equalTo()`|`Affine == Affine` |
147+
| `lessThan()`| `Affine <= Affine` or `Norm2 + Affine <= Affine` (SOCP) |
148+
| `greaterThan()`| `Affine >= Affine` or `Affine >= Norm2 + Affine` (SOCP) |
149+
| `box()`| `Affine <= Affine <= Affine` |
150+
| `addCostTerm()`| `Affine` (SOCP) or `QuadForm + Affine` (QP) |
151+
152+
With the following expressions:
153+
154+
| Expression | Example |
155+
| --- | --- |
156+
| Affine | p1 * x1 + p2 * x2 + ... + c |
157+
| Norm2 | (Affine1^2 + Affine2^2 + ...)^(1/2) |
158+
| QuadForm | x' * P * x where P is Hermitian |

0 commit comments

Comments
 (0)