AffAtom-class: The AffAtom class.

AffAtom-classR Documentation

The AffAtom class.

Description

This virtual class represents an affine atomic expression.

Usage

## S4 method for signature 'AffAtom'
allow_complex(object)

## S4 method for signature 'AffAtom'
sign_from_args(object)

## S4 method for signature 'AffAtom'
is_imag(object)

## S4 method for signature 'AffAtom'
is_complex(object)

## S4 method for signature 'AffAtom'
is_atom_convex(object)

## S4 method for signature 'AffAtom'
is_atom_concave(object)

## S4 method for signature 'AffAtom'
is_incr(object, idx)

## S4 method for signature 'AffAtom'
is_decr(object, idx)

## S4 method for signature 'AffAtom'
is_quadratic(object)

## S4 method for signature 'AffAtom'
is_qpwa(object)

## S4 method for signature 'AffAtom'
is_pwl(object)

## S4 method for signature 'AffAtom'
is_psd(object)

## S4 method for signature 'AffAtom'
is_nsd(object)

## S4 method for signature 'AffAtom'
.grad(object, values)

Arguments

object

An AffAtom object.

idx

An index into the atom.

values

A list of numeric values for the arguments

Methods (by generic)

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

  • sign_from_args(AffAtom): The sign of the atom.

  • is_imag(AffAtom): Is the atom imaginary?

  • is_complex(AffAtom): Is the atom complex valued?

  • is_atom_convex(AffAtom): The atom is convex.

  • is_atom_concave(AffAtom): The atom is concave.

  • is_incr(AffAtom): The atom is weakly increasing in every argument.

  • is_decr(AffAtom): The atom is not weakly decreasing in any argument.

  • is_quadratic(AffAtom): Is every argument quadratic?

  • is_qpwa(AffAtom): Is every argument quadratic of piecewise affine?

  • is_pwl(AffAtom): Is every argument piecewise linear?

  • is_psd(AffAtom): Is the atom a positive semidefinite matrix?

  • is_nsd(AffAtom): Is the atom a negative semidefinite matrix?

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


CVXR documentation built on June 27, 2024, 5:11 p.m.