Skip to content

Commit

Permalink
doc: small improvement in projection operators
Browse files Browse the repository at this point in the history
  • Loading branch information
nperraud committed Jan 26, 2021
1 parent b0367d1 commit f809a01
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion pyunlocbox/functions.py
Original file line number Diff line number Diff line change
Expand Up @@ -863,7 +863,8 @@ class proj_spsd(proj):
Projection on symmetric positive semi-definite matrices (eval, prox).
This function is the indicator function :math:`i_S(M)` of the set
:math:`S = \left\{M \in \mathbb{R}^{N \times N} \mid M \leq 0 \right\}`
:math:`S = \left\{M \in \mathbb{R}^{N \times N}
\mid M \succeq 0, M=M^T \right\}`
that is zero if :math:`M` is in the set and infinite otherwise.
See generic attributes descriptions of the
Expand Down Expand Up @@ -942,6 +943,10 @@ class proj_b2(proj):
:math:`\|A(z)-y\|_2 \leq \epsilon`. It is thus a projection of the vector
`x` onto an L2-ball of diameter `epsilon`.
See Also
--------
proj_lineq : use instead of ``epsilon=0``
Examples
--------
>>> from pyunlocbox import functions
Expand Down Expand Up @@ -1064,6 +1069,10 @@ class proj_lineq(proj):
parameter `A` is provided as an operator/callable (not a matrix).
* The evaluation of this function is zero.
See Also
--------
proj_b2 : quadratic case
Examples
--------
>>> from pyunlocbox import functions
Expand Down

0 comments on commit f809a01

Please sign in to comment.