problems.container

Module: problems.container

Inheritance diagram for regreg.problems.container:

digraph inheritance43144ac92e { rankdir=LR; size="8.0, 12.0"; "problems.composite.composite" [URL="regreg.problems.composite.html#regreg.problems.composite.composite",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top",tooltip="A generic way to specify a problem in composite form."]; "problems.container.container" [URL="#regreg.problems.container.container",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top",tooltip="A container class for storing/combining seminorm_atom classes"]; "problems.composite.composite" -> "problems.container.container" [arrowsize=0.5,style="setlinewidth(0.5)"]; }

container

class regreg.problems.container.container(*atoms, **keywords)

Bases: regreg.problems.composite.composite

A container class for storing/combining seminorm_atom classes

Notes

This function copies the nonsmooth atoms

__init__(*atoms, **keywords)

Initialize self. See help(type(self)) for accurate signature.

apply_offset(x)

If self.offset is not None, return x-self.offset, else return x.

default_solver

alias of regreg.algorithms.FISTA

get_offset()

get_quadratic()

Get the quadratic part of the composite.

latexify(var=None, idx='')

nonsmooth_objective(x, check_feasibility=False)

objective(x, check_feasibility=False)

objective_template = 'f(%(var)s)'

objective_vars = {'offset': '\\alpha', 'shape': 'p', 'var': '\\beta'}

property offset

proximal(proxq, prox_control=None)

The proximal function for the primal problem

proximal_optimum(quadratic)

proximal_step(quadratic, prox_control=None)

Compute the proximal optimization

Parameters

prox_control: [None, dict]

If not None, then a dictionary of parameters for the prox procedure

property quadratic

Quadratic part of the object, instance of regreg.identity_quadratic.identity_quadratic.

set_offset(value)

set_quadratic(quadratic)

Set the quadratic part of the composite.

smooth_objective(x, mode='both', check_feasibility=False)

The smooth_objective DOES NOT INCLUDE the identity quadratic of all the smooth atoms.

smoothed(smoothing_quadratic)

Add quadratic smoothing term

solve(quadratic=None, return_optimum=False, **fit_args)