CVXR: MulExpression-class – R documentation

Pricing

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

Get Started for Free

Documentation

CVXR

MulExpression-class

The MulExpression class.

Description

This class represents the matrix product of two linear expressions. See Multiply for the elementwise product.

Usage

## S4 method for signature 'Expression,Expression'
x %*% y

## S4 method for signature 'Expression,ConstVal'
x %*% y

## S4 method for signature 'ConstVal,Expression'
x %*% y

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

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

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

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

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

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

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

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

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

## S4 method for signature 'MulExpression'
graph_implementation(object, arg_objs, dim, data = NA_real_)

Arguments

`x, y`	The Expression objects or numeric constants to multiply.
`object`	A MulExpression object.
`values`	A list of numeric values for the arguments
`idx`	An index into the atom.
`arg_objs`	A list of linear expressions for each argument.
`dim`	A vector representing the dimensions of the resulting expression.
`data`	A list of additional data required by the atom.

Methods (by generic)

to_numeric: Matrix multiplication.
dim_from_args: The (row, col) dimensions of the expression.
is_atom_convex: Multiplication is convex (affine) in its arguments only if one of the arguments is constant.
is_atom_concave: If the multiplication atom is convex, then it is affine.
is_atom_log_log_convex: Is the atom log-log convex?
is_atom_log_log_concave: Is the atom log-log concave?
is_incr: Is the left-hand expression positive?
is_decr: Is the left-hand expression negative?
.grad: Gives the (sub/super)gradient of the atom w.r.t. each variable
graph_implementation: The graph implementation of the expression.