MinEntries-class: The MinEntries class.

MinEntries-classR Documentation

The MinEntries class.

Description

The minimum of an expression.

Usage

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

## S4 method for signature 'MinEntries'
to_numeric(object, values)

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

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

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

## S4 method for signature 'MinEntries'
is_atom_log_log_convex(object)

## S4 method for signature 'MinEntries'
is_atom_log_log_concave(object)

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

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

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

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

## S4 method for signature 'MinEntries'
.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 MinEntries 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(MinEntries): The largest entry in x.

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

  • is_atom_convex(MinEntries): The atom is not convex.

  • is_atom_concave(MinEntries): The atom is concave.

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

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

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

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

  • is_pwl(MinEntries): Is x piecewise linear?

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

  • .column_grad(MinEntries): 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.


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