summary.optrefit: 'summary' method for 'optrefit' objects.

In mlysy/optimCheck: Graphical and Numerical Checks for Mode-Finding Routines

summary method for optrefit objects.

Description

summary method for optrefit objects.

Usage

## S3 method for class 'optrefit'
summary(object, xnames, ...)

Arguments

object	An optrefit object, i.e., output from the function optim_refit().
xnames	Optional vector of names for the elements of the potential solution.
...	Further arguments to be passed to or from other methods.

Value

An object of class summary.optrefit inheriting from summary.optcheck, with elements:

xsol

The potential solution vector.

ysol

The value of the objective function at xsol.

maximize

Logical indicating whether the potential solution should maximize or minimize the objective function.

xopt

A vector containing the argmax/argmin in each projection plot.

yopt

The scalar value of the max/min found by optim_refit.

xdiff

A two-column matrix containing the differences between xsol and xopt. The first column is the absolute difference D = xopt - xsol, the second is the relative difference ⁠R = D/|xsol|⁠.

ydiff

A length-two vector containing the absolute and relative difference between ysol and yopt.

See Also

print.summary.optcheck() for print method.

mlysy/optimCheck documentation built on Sept. 9, 2024, 1:21 p.m.