The Norm1 class.

Source: R/atoms.R

This class represents the 1-norm of an expression.

Norm1(x, axis = NA_real_, keepdims = FALSE)

# S4 method for class 'Norm1'
name(x)

# S4 method for class 'Norm1'
to_numeric(object, values)

# S4 method for class 'Norm1'
allow_complex(object)

# S4 method for class 'Norm1'
sign_from_args(object)

# S4 method for class 'Norm1'
is_atom_convex(object)

# S4 method for class 'Norm1'
is_atom_concave(object)

# S4 method for class 'Norm1'
is_incr(object, idx)

# S4 method for class 'Norm1'
is_decr(object, idx)

# S4 method for class 'Norm1'
is_pwl(object)

# S4 method for class 'Norm1'
get_data(object)

# S4 method for class 'Norm1'
.domain(object)

# S4 method for class 'Norm1'
.grad(object, values)

# S4 method for class 'Norm1'
.column_grad(object, value)

Arguments

x

An Expression object.

axis

(Optional) The dimension across which to apply the function: 1 indicates rows, 2 indicates columns, and NA indicates rows and columns. The default is NA.

keepdims

(Optional) Should dimensions be maintained when applying the atom along an axis? If FALSE, result will be collapsed into an \(n x 1\) column vector. The default is FALSE.

object

A Norm1 object.

values

A list of numeric values for the arguments

idx

An index into the atom.

value

A numeric value

Methods (by generic)

  • name(Norm1): The name and arguments of the atom.

  • to_numeric(Norm1): Returns the 1-norm of x along the given axis.

  • allow_complex(Norm1): Does the atom handle complex numbers?

  • sign_from_args(Norm1): The atom is always positive.

  • is_atom_convex(Norm1): The atom is convex.

  • is_atom_concave(Norm1): The atom is not concave.

  • is_incr(Norm1): Is the composition weakly increasing in argument idx?

  • is_decr(Norm1): Is the composition weakly decreasing in argument idx?

  • is_pwl(Norm1): Is the atom piecewise linear?

  • get_data(Norm1): Returns the axis.

  • .domain(Norm1): Returns constraints describing the domain of the node

  • .grad(Norm1): Gives the (sub/super)gradient of the atom w.r.t. each variable

  • .column_grad(Norm1): Gives the (sub/super)gradient of the atom w.r.t. each column variable

Slots

x

An Expression object.