List of Properties

\[\]

This section gives an overview of all the properties for each abstract class (and thus all inherited classes). Each derived class can have further new properties which can be found in the technical documentation dedicated to each class.

Map

Properties	Description
name	name of the Map.
sizein	Input size.
sizeout	Output size.
norm	norm of the Map.
isInvertible	Boolean true if invertible Map.
isDifferentiable	Boolean true if differentiable Map.
memoizeOpts	Structure of booleans with one field per method. If one field is true, the corresponding method will use the memoize mechanism.
doPrecomputation	Boolean true if precomputations are allowed

LinOp

Properties	Description
name	Inherited from Map
sizein	Inherited from Map
sizeout	Inherited from Map
norm	Inherited from Map
isInvertible	Inherited from Map
isDifferentiable	Inherited from Map
memoizeOpts	Inherited from Map
doPrecomputation	Inherited from Map

Cost

Properties	Description
name	Inherited from Map
sizein	Inherited from Map
sizeout	Inherited from Map, fixed to 1 for costs.
norm	Inherited from Map, fixed to -1 for costs.
lip	Lipschitz constant of the gradient (when applicable)
isConvex	Boolean true if the cost is convex.
isSeparable	Boolean true if the cost is separable (\(\mathbb{R}^N basis\)).
y	Data vector.
isInvertible	Inherited from Map
isDifferentiable	Inherited from Map
memoizeOpts	Inherited from Map
doPrecomputation	Inherited from Map

Opti

Properties	Description
name	Name of the algorithm.
cost	Minimized Cost.
maxiter	Maximal number of iterations.
xtol	tolerance on the relative difference between two iterates.
OutOp	OutputOpti object.
ItUpOut	Number of iterations between two calls to the update method of the OutputOpti object OutOp.
xtol	Tolerance on the relative difference between two iterates.
time	Execution time of the algorithm.
niter	Iteration counter.
xopt	Optimization variable.