MoreauEnvelope¶
-
class
odl.solvers.functional.default_functionals.
MoreauEnvelope
(*args, **kwargs)[source]¶ Bases:
odl.solvers.functional.functional.Functional
Moreau envelope of a convex functional.
The Moreau envelope is a way to smooth an arbitrary convex functional such that its gradient can be computed given the proximal of the original functional. The new functional has the same critical points as the original. It is also called the Moreau-Yosida regularization.
Note that the only computable property of the Moreau envelope is the gradient, the functional itself cannot be evaluated efficiently.
See `Proximal Algorithms`_ for more information.
Notes
The Moreau envelope of a convex functional multiplied by a scalar is defined by
The gradient of the envelope is given by
Example: if , then
which is the usual Huber functional.
https://web.stanford.edu/~boyd/papers/pdf/prox_algs.pdf
- Attributes
adjoint
Adjoint of this operator (abstract).
convex_conj
Convex conjugate functional of the functional.
domain
Set of objects on which this operator can be evaluated.
functional
The functional that has been regularized.
grad_lipschitz
Lipschitz constant for the gradient of the functional.
gradient
The gradient operator.
inverse
Return the operator inverse.
is_functional
True
if this operator’s range is aField
.is_linear
True
if this operator is linear.proximal
Proximal factory of the functional.
range
Set in which the result of an evaluation of this operator lies.
sigma
Regularization constant, larger means stronger regularization.
Methods
_call
(self, x[, out])Implementation of the operator evaluation.
bregman
(self, point, subgrad)Return the Bregman distance functional.
derivative
(self, point)Return the derivative operator in the given point.
norm
(self[, estimate])Return the operator norm of this operator.
translated
(self, shift)Return a translation of the functional.
-
__init__
(self, functional, sigma=1.0)[source]¶ Initialize an instance.
- Parameters
- functional
Functional
The functional
f
in the definition of the Moreau envelope that is to be smoothed.- sigmapositive float, optional
The scalar
sigma
in the definition of the Moreau envelope. Larger values mean stronger smoothing.
- functional
Examples
Create smoothed l1 norm:
>>> space = odl.rn(3) >>> l1_norm = odl.solvers.L1Norm(space) >>> smoothed_l1 = MoreauEnvelope(l1_norm)