Skip to content

Commit de21293

Browse files
committed
fix #13
1 parent edf4c95 commit de21293

2 files changed

Lines changed: 10 additions & 13 deletions

File tree

docs/src/api_cone_types.md

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,13 @@
11
# [Supported Cone Types](@id api-cone-types)
22

3-
43
Clarabel natively supports optimization problems with conic constraints defined on the following cones:
54

6-
Cone Type| Constructor | Definition
7-
----- | :----- | :-----
8-
Zero cone | `ZeroConeT(n)` | ``\{ 0 \}^{n}``
9-
Nonnegative Orthant | `NonnegativeConeT(n)` | ``\{ x \in \mathbb{R}^{n} : x_i \ge 0, \forall i=1,\dots,\mathrm{n} \}``
10-
Second-Order Cone | `SecondOrderConeT(n)` | ``\{ (t,x) \in \mathbb{R}^{n} : \|\|x\|\|_2 \leq t \}``
11-
Exponential Cone | `ExponentialConeT()` | ``\{(x, y, z) : y > 0,~~ ye^{x/y} ≤ z \}``
12-
Power Cone | `PowerConeT(a)` | ``\{(x, y, z) : x^a y^{(1-a)} \geq \|z\|,~ (x,y) \geq 0 \}`` with ``a \in (0,1)``
13-
Generalized Power Cone | `GenPowerConeT(a,n)` | ``\{(x, y) \in \mathbb{R}^{len(a)} \times \mathbb{R}^{n} : \prod\limits_{a_i \in a} x_i^{a_i} \geq \|\|y\|\|_2,~ x \ge 0 \}`` with ``a_i \in (0,1)`` and ``\sum a_i = 1``
14-
Positive Semidefinite Cone (triangular part) | `PSDTriangleConeT(n)` | Upper triangular part of the positive semidefinite cone ``\mathbb{S}^{n}_+``. The elements ``x`` of this cone represent the columnwise stacking of the upper triangular part of a positive semidefinite matrix ``X \in \mathbb{S}^{n}_+``, so that ``x \in \mathbb{R}^d`` with ``d = {n(n+1)}/{2}.``
15-
16-
5+
| Cone Type | Constructor | Definition |
6+
| -------------------------------------------- | :---------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
7+
| Zero cone | `ZeroConeT(n)` | ``\{ 0 \}^{n}`` |
8+
| Nonnegative Orthant | `NonnegativeConeT(n)` | ``\{ x \in \mathbb{R}^{n} : x_i \ge 0, \forall i=1,\dots,\mathrm{n} \}`` |
9+
| Second-Order Cone | `SecondOrderConeT(n)` | ``\{ (t,x) \in \mathbb{R}^{n} : \|\|x\|\|_2 \leq t \}`` |
10+
| Exponential Cone | `ExponentialConeT()` | ``\{(x, y, z) : y > 0,~~ ye^{x/y} ≤ z \}`` |
11+
| Power Cone | `PowerConeT(a)` | ``\{(x, y, z) : x^a y^{(1-a)} \geq \|z\|,~ (x,y) \geq 0 \}`` with ``a \in (0,1)`` |
12+
| Generalized Power Cone | `GenPowerConeT(a,n)` | ``\{(x, y) \in \mathbb{R}^{len(a)} \times \mathbb{R}^{n} : \prod\limits_{a_i \in a} x_i^{a_i} \geq \|\|y\|\|_2,~ x \ge 0 \}`` with ``a_i \in (0,1)`` and ``\sum a_i = 1`` |
13+
| Positive Semidefinite Cone (triangular part) | `PSDTriangleConeT(n)` | Upper triangular part of the scaled positive semidefinite cone ``\mathbb{S}^{n}_+``. The elements ``x`` of this cone represent the columnwise stacking of the scaled upper triangular part of a positive semidefinite matrix ``X \in \mathbb{S}^{n}_+``, so that ``x \in \mathbb{R}^d`` with ``d = {n(n+1)}/{2}.``   When extracting the upper triangular part of the matrix, off-diagonal terms are scaled by ``\sqrt{2}`` so that inner products are preserved. |

docs/src/examples/example_sdp.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ The solver's default configuration expects constraints in the form $Ax + s = b$.
7676
where $\mathcal{K}_{\text{tri}}^n$ is the cone of vectors representing the triangular part of matrices in $\mathbb{S}_+^n$.
7777

7878

79-
For the equality constraint can we must be careful to rewrite the inner product on $X$ in a form that is an equivalent linear function of $x$. We therefore write
79+
For the equality constraint we must be careful to rewrite the inner product on $X$ in a form that is an equivalent linear function of $x$. We therefore write
8080
```math
8181
\begin{aligned}
8282
\langle A,X\rangle &= \textrm{vec}(A)^T\textrm{vec}(X) \\

0 commit comments

Comments
 (0)