Skip to content

Commit f809a01

Browse files
committed
doc: small improvement in projection operators
1 parent b0367d1 commit f809a01

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

pyunlocbox/functions.py

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -863,7 +863,8 @@ class proj_spsd(proj):
863863
Projection on symmetric positive semi-definite matrices (eval, prox).
864864
865865
This function is the indicator function :math:`i_S(M)` of the set
866-
:math:`S = \left\{M \in \mathbb{R}^{N \times N} \mid M \leq 0 \right\}`
866+
:math:`S = \left\{M \in \mathbb{R}^{N \times N}
867+
\mid M \succeq 0, M=M^T \right\}`
867868
that is zero if :math:`M` is in the set and infinite otherwise.
868869
869870
See generic attributes descriptions of the
@@ -942,6 +943,10 @@ class proj_b2(proj):
942943
:math:`\|A(z)-y\|_2 \leq \epsilon`. It is thus a projection of the vector
943944
`x` onto an L2-ball of diameter `epsilon`.
944945
946+
See Also
947+
--------
948+
proj_lineq : use instead of ``epsilon=0``
949+
945950
Examples
946951
--------
947952
>>> from pyunlocbox import functions
@@ -1064,6 +1069,10 @@ class proj_lineq(proj):
10641069
parameter `A` is provided as an operator/callable (not a matrix).
10651070
* The evaluation of this function is zero.
10661071
1072+
See Also
1073+
--------
1074+
proj_b2 : quadratic case
1075+
10671076
Examples
10681077
--------
10691078
>>> from pyunlocbox import functions

0 commit comments

Comments
 (0)