PfEigenvalue-class {CVXR}

The PfEigenvalue class.

Description

This class represents the Perron-Frobenius eigenvalue of a positive matrix.

Usage

PfEigenvalue(X)

## S4 method for signature 'PfEigenvalue'
name(x)

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

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

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

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

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

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

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

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

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

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

Arguments

X

An Expression or numeric matrix.

x, object

A PfEigenvalue object.

values

A list of numeric values for the arguments

idx

An index into the atom.

Methods (by generic)

• name(PfEigenvalue): The name and arguments of the atom.

• to_numeric(PfEigenvalue): Returns the Perron-Frobenius eigenvalue of X.

• dim_from_args(PfEigenvalue): The dimensions of the atom.

• sign_from_args(PfEigenvalue): Returns the sign (is positive, is negative) of the atom.

• is_atom_convex(PfEigenvalue): Is the atom convex?

• is_atom_concave(PfEigenvalue): Is the atom concave?

• is_atom_log_log_convex(PfEigenvalue): Is the atom log-log convex?

• is_atom_log_log_concave(PfEigenvalue): Is the atom log-log concave?

• is_incr(PfEigenvalue): Is the atom weakly increasing in the argument idx?

• is_decr(PfEigenvalue): Is the atom weakly decreasing in the argument idx?

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

Slots

X

An Expression or numeric matrix.