The MaxEntries class.

Source: R/atoms.R

The maximum of an expression.

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

# S4 method for MaxEntries
to_numeric(object, values)

# S4 method for MaxEntries
sign_from_args(object)

# S4 method for MaxEntries
is_atom_convex(object)

# S4 method for MaxEntries
is_atom_concave(object)

# S4 method for MaxEntries
is_atom_log_log_convex(object)

# S4 method for MaxEntries
is_atom_log_log_concave(object)

# S4 method for MaxEntries
is_incr(object, idx)

# S4 method for MaxEntries
is_decr(object, idx)

# S4 method for MaxEntries
is_pwl(object)

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

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

Arguments

x

An Expression representing a vector or matrix.

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 MaxEntries object.

values

A list of numeric values for the arguments

idx

An index into the atom.

value

A numeric value

Methods (by generic)

  • to_numeric(MaxEntries): The largest entry in x.

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

  • is_atom_convex(MaxEntries): The atom is convex.

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

  • is_atom_log_log_convex(MaxEntries): Is the atom log-log convex.

  • is_atom_log_log_concave(MaxEntries): Is the atom log-log concave.

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

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

  • is_pwl(MaxEntries): Is x piecewise linear?

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

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

Slots

x

An Expression representing a vector or matrix.

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.