The Entr class.

Source: R/elementwise.R

This class represents the elementwise operation \(-xlog(x)\).

Entr(x)

# S4 method for class 'Entr'
to_numeric(object, values)

# S4 method for class 'Entr'
sign_from_args(object)

# S4 method for class 'Entr'
is_atom_convex(object)

# S4 method for class 'Entr'
is_atom_concave(object)

# S4 method for class 'Entr'
is_incr(object, idx)

# S4 method for class 'Entr'
is_decr(object, idx)

# S4 method for class 'Entr'
.grad(object, values)

# S4 method for class 'Entr'
.domain(object)

Arguments

x

An Expression or numeric constant.

object

An Entr object.

values

A list of numeric values for the arguments

idx

An index into the atom.

Methods (by generic)

  • to_numeric(Entr): The elementwise entropy function evaluated at the value.

  • sign_from_args(Entr): The sign of the atom is unknown.

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

  • is_atom_concave(Entr): The atom is concave.

  • is_incr(Entr): The atom is weakly increasing.

  • is_decr(Entr): The atom is weakly decreasing.

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

  • .domain(Entr): Returns constraints descrbing the domain of the node

Slots

x

An Expression or numeric constant.