CVXR (version 0.99-7)

KLDiv-class: The KLDiv class.

Description

The elementwise KL-divergence \(x\log(x/y) - x + y\).

Usage

KLDiv(x, y)
# S4 method for KLDiv
to_numeric(object, values)
# S4 method for KLDiv
sign_from_args(object)
# S4 method for KLDiv
is_atom_convex(object)
# S4 method for KLDiv
is_atom_concave(object)
# S4 method for KLDiv
is_incr(object, idx)
# S4 method for KLDiv
is_decr(object, idx)
# S4 method for KLDiv
graph_implementation(object, arg_objs, size,
  data = NA_real_)

Arguments

x

An '>Expression or numeric constant.

y

An '>Expression or numeric constant.

object

A '>KLDiv object.

values

A list of arguments to the atom.

idx

An index into the atom.

arg_objs

A list of linear expressions for each argument.

size

A vector with two elements representing the size of the resulting expression.

data

A list of additional data required by the atom.

Methods (by generic)

• to_numeric: The KL-divergence evaluted elementwise on the input value.

• sign_from_args: The atom is positive.

• is_atom_convex: The atom is convex.

• is_atom_concave: The atom is not concave.

• is_incr: The atom is not monotonic in any argument.

• is_decr: The atom is not monotonic in any argument.

• graph_implementation: The graph implementation of the atom.

Slots

x

An '>Expression or numeric constant.

y

An '>Expression or numeric constant.