SumLargest-class: The SumLargest class.

In anqif/CVXR: Disciplined Convex Optimization

The SumLargest class.

Description

The sum of the largest k values of a matrix.

Usage

SumLargest(x, k)

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

## S4 method for signature 'SumLargest'
validate_args(object)

## S4 method for signature 'SumLargest'
dim_from_args(object)

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

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

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

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

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

## S4 method for signature 'SumLargest'
get_data(object)

## S4 method for signature '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(SumLargest): The sum of the k largest entries of the vector or matrix.

• validate_args(SumLargest): Check that k is a positive integer.

• dim_from_args(SumLargest): The atom is a scalar.

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

• is_atom_convex(SumLargest): The atom is convex.

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

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

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

• get_data(SumLargest): A list containing k.

• .grad(SumLargest): 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.

anqif/CVXR documentation built on Feb. 6, 2024, 4:28 a.m.