Learn R Programming
CVXR (version 1.0)

SumLargest-class: The SumLargest class.

Description

The sum of the largest k values of a matrix.

Usage

SumLargest(x, k)
# S4 method for SumLargest
to_numeric(object, values)
# S4 method for SumLargest
validate_args(object)
# S4 method for SumLargest
dim_from_args(object)
# S4 method for SumLargest
sign_from_args(object)
# S4 method for SumLargest
is_atom_convex(object)
# S4 method for SumLargest
is_atom_concave(object)
# S4 method for SumLargest
is_incr(object, idx)
# S4 method for SumLargest
is_decr(object, idx)
# S4 method for SumLargest
get_data(object)
# S4 method for SumLargest
.grad(object, values)

Arguments

x

An '>Expression or numeric matrix.

k

The number of largest values to sum over.

object

A '>SumLargest object.

values

A list of numeric values for the arguments

idx

An index into the atom.

Methods (by generic)

  • to_numeric: The sum of the k largest entries of the vector or matrix.

  • validate_args: Check that k is a positive integer.

  • dim_from_args: The atom is a scalar.

  • sign_from_args: The sign of the atom.

  • is_atom_convex: The atom is convex.

  • is_atom_concave: The atom is not concave.

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

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

  • get_data: A list containing k.

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

Slots

x

An '>Expression or numeric matrix.

k

The number of largest values to sum over.