tick.prox.ProxPositive

class tick.prox.ProxPositive(range: tuple = None, positive: bool = False)[source]

Projection operator onto the half-space of vectors with non-negative entries

Parameters

range : tuple of two int, default=`None`

Range on which the prox is applied. If None then the prox is applied on the whole vector

Attributes

dtype : {'float64', 'float32'}

Type of the arrays used.

__init__(range: tuple = None, positive: bool = False)[source]

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

call(coeffs, step=1.0, out=None)

Apply proximal operator on a vector. It computes:

\[argmin_x \big( f(x) + \frac{1}{2} \|x - v\|_2^2 \big)\]
Parameters

coeffs : numpy.ndarray, shape=(n_coeffs,)

Input vector on which is applied the proximal operator

step : float or np.array, default=1.

The amount of penalization is multiplied by this amount

  • If float, the amount of penalization is multiplied by this amount

  • If np.array, then each coordinate of coeffs (within the given range), receives an amount of penalization multiplied by t (available only for separable prox)

out : numpy.ndarray, shape=(n_params,), default=None

If not None, the output is stored in the given out. Otherwise, a new vector is created.

Returns

output : numpy.ndarray, shape=(n_coeffs,)

Same object as out

Notes

step must have the same size as coeffs whenever range is None, or a size matching the one given by the range otherwise

value(coeffs: numpy.ndarray)[source]

Returns the projected coeffs

Parameters

coeffs : numpy.ndarray, shape=(n_coeffs,)

Vector to be projected

Returns

output : float

Returns 0 (as this is a projection)

Examples using tick.prox.ProxPositive