The AxisAtom class.

Source: R/atoms.R

This virtual class represents atomic expressions that can be applied along an axis in CVXR.

# S4 method for AxisAtom
dim_from_args(object)

# S4 method for AxisAtom
get_data(object)

# S4 method for AxisAtom
validate_args(object)

# S4 method for AxisAtom
.axis_grad(object, values)

# S4 method for AxisAtom
.column_grad(object, value)

Arguments

object

An Atom object.

values

A list of numeric values for the arguments

value

A numeric value

Methods (by generic)

  • dim_from_args(AxisAtom): The dimensions of the atom determined from its arguments.

  • get_data(AxisAtom): A list containing axis and keepdims.

  • validate_args(AxisAtom): Check that the new dimensions have the same number of entries as the old.

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

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

Slots

expr

A numeric element, data.frame, matrix, vector, or Expression.

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.