The CumMax class.

Source: R/atoms.R

This class represents the cumulative maximum of an expression.

CumMax(expr, axis = 2)

# S4 method for class 'CumMax'
to_numeric(object, values)

# S4 method for class 'CumMax'
.grad(object, values)

# S4 method for class 'CumMax'
.column_grad(object, value)

# S4 method for class 'CumMax'
dim_from_args(object)

# S4 method for class 'CumMax'
sign_from_args(object)

# S4 method for class 'CumMax'
get_data(object)

# S4 method for class 'CumMax'
is_atom_convex(object)

# S4 method for class 'CumMax'
is_atom_concave(object)

# S4 method for class 'CumMax'
is_incr(object, idx)

# S4 method for class 'CumMax'
is_decr(object, idx)

Arguments

expr

An Expression.

axis

A numeric vector indicating the axes along which to apply the function. For a 2D matrix, 1 indicates rows, 2 indicates columns, and c(1,2) indicates rows and columns.

object

A CumMax object.

values

A list of numeric values for the arguments

value

A numeric value.

idx

An index into the atom.

Methods (by generic)

  • to_numeric(CumMax): The cumulative maximum along the axis.

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

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

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

  • sign_from_args(CumMax): The (is positive, is negative) sign of the atom.

  • get_data(CumMax): Returns the axis along which the cumulative max is taken.

  • is_atom_convex(CumMax): Is the atom convex?

  • is_atom_concave(CumMax): Is the atom concave?

  • is_incr(CumMax): Is the atom weakly increasing in the index?

  • is_decr(CumMax): Is the atom weakly decreasing in the index?

Slots

expr

An Expression.

axis

A numeric vector indicating the axes along which to apply the function. For a 2D matrix, 1 indicates rows, 2 indicates columns, and c(1,2) indicates rows and columns.