Package parsimony :: Package functions :: Module properties :: Class AugmentedProximalOperator
[hide private]
[frames] | no frames]

Class AugmentedProximalOperator

source code

      object --+    
               |    
ProximalOperator --+
                   |
                  AugmentedProximalOperator
Known Subclasses:

Given the problem

    min. f(x)
    s.t. x = z

the augmented Lagrangian is

    L(x)  = f(x) + y'(x - z) + (rho / 2) * ||x - z||²
        === f(x) + (rho / 2) * ||x - z + u||²
          = prox_{(1 / rho) * f}(z - u)

where y = rho * u is a dual variable associated to the constraint x = z,
and ||.||² is the squared L2 norm. We note that this is the proximal
operator of f(x) at the point z - u.

This Function represents the proximal operator of f at z - u, given the
augmented Lagrangian.

Parameters
----------
rho : Non-negative float. The regularisation constant for the augmented
        Lagrangian.

Instance Methods [hide private]
 
__init__(self, rho=1.0)
x.__init__(...) initializes x; see help(type(x)) for signature
source code
 
set_rho(self, rho)
Update the penalty parameter.
source code

Inherited from ProximalOperator: prox

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Variables [hide private]
  __metaclass__ = abc.ABCMeta
Metaclass for defining Abstract Base Classes (ABCs).

Inherited from ProximalOperator: __abstractmethods__

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, rho=1.0)
(Constructor)

source code 

x.__init__(...) initializes x; see help(type(x)) for signature

Overrides: object.__init__
(inherited documentation)