The QuadForm class.

Source: R/atoms.R

This class represents the quadratic form \(x^T P x\)

QuadForm(x, P)

# S4 method for QuadForm
name(x)

# S4 method for QuadForm
allow_complex(object)

# S4 method for QuadForm
to_numeric(object, values)

# S4 method for QuadForm
validate_args(object)

# S4 method for QuadForm
sign_from_args(object)

# S4 method for QuadForm
dim_from_args(object)

# S4 method for QuadForm
is_atom_convex(object)

# S4 method for QuadForm
is_atom_concave(object)

# S4 method for QuadForm
is_atom_log_log_convex(object)

# S4 method for QuadForm
is_atom_log_log_concave(object)

# S4 method for QuadForm
is_incr(object, idx)

# S4 method for QuadForm
is_decr(object, idx)

# S4 method for QuadForm
is_quadratic(object)

# S4 method for QuadForm
is_pwl(object)

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

Arguments

x

An Expression or numeric vector.

P

An Expression, numeric matrix, or vector.

object

A QuadForm object.

values

A list of numeric values for the arguments

idx

An index into the atom.

Methods (by generic)

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

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

  • to_numeric(QuadForm): Returns the quadratic form.

  • validate_args(QuadForm): Checks the dimensions of the arguments.

  • sign_from_args(QuadForm): Returns the sign (is positive, is negative) of the atom.

  • dim_from_args(QuadForm): The dimensions of the atom.

  • is_atom_convex(QuadForm): Is the atom convex?

  • is_atom_concave(QuadForm): Is the atom concave?

  • is_atom_log_log_convex(QuadForm): Is the atom log-log convex?

  • is_atom_log_log_concave(QuadForm): Is the atom log-log concave?

  • is_incr(QuadForm): Is the atom weakly increasing in the argument idx?

  • is_decr(QuadForm): Is the atom weakly decreasing in the argument idx?

  • is_quadratic(QuadForm): Is the atom quadratic?

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

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

Slots

x

An Expression or numeric vector.

P

An Expression, numeric matrix, or vector.