The SigmaMax class.

Source: R/atoms.R

The maximum singular value of a matrix.

SigmaMax(A = A)

# S4 method for SigmaMax
to_numeric(object, values)

# S4 method for SigmaMax
allow_complex(object)

# S4 method for SigmaMax
dim_from_args(object)

# S4 method for SigmaMax
sign_from_args(object)

# S4 method for SigmaMax
is_atom_convex(object)

# S4 method for SigmaMax
is_atom_concave(object)

# S4 method for SigmaMax
is_incr(object, idx)

# S4 method for SigmaMax
is_decr(object, idx)

# S4 method for SigmaMax
.grad(object, values)

Arguments

A

An Expression or matrix.

object

A SigmaMax object.

values

A list of numeric values for the arguments

idx

An index into the atom.

Methods (by generic)

  • to_numeric(SigmaMax): The largest singular value of A.

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

  • dim_from_args(SigmaMax): The atom is a scalar.

  • sign_from_args(SigmaMax): The atom is positive.

  • is_atom_convex(SigmaMax): The atom is convex.

  • is_atom_concave(SigmaMax): The atom is concave.

  • is_incr(SigmaMax): The atom is not monotonic in any argument.

  • is_decr(SigmaMax): The atom is not monotonic in any argument.

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

Slots

A

An Expression or numeric matrix.