stoploss: Calculate the weighted multiobjective loss function used in...

View source: R/stoploss.R

stoplossR Documentation

Calculate the weighted multiobjective loss function used in STOPS

Description

Calculate the weighted multiobjective loss function used in STOPS

Usage

stoploss(
  obj,
  stressweight = 1,
  structures,
  strucweight = rep(-1/length(structures), length(structures)),
  strucpars,
  stoptype = c("additive", "multiplicative"),
  verbose = 0,
  registry = struc_reg
)

Arguments

obj

object returned inside a stop_* function. Uses the stress.m slot for getting the stress.

stressweight

weight to be used for the fit measure; defaults to 1

structures

which c-structuredness indices to be included in the loss

strucweight

the weights of the structuredness indices; defaults to -1/#number of structures

strucpars

a list of parameters to be passed to the c-structuredness indices in the same order as the values in structures. If the index has no parameters or you want to use the defaults, supply NULL. (alternatively a named list that has the structure name as the element name).

stoptype

what type of weighted combination should be used? Can be 'additive' or 'multiplicative'.

verbose

verbose output

registry

an object of class registry. This can be used to add additional c-structuredness indices. Defaults ot the registry created via .onLoad in zzz.R

Value

a list with calculated stoploss ($stoploss), structuredness indices ($strucinidices) and hyperparameters ($parameters and $theta)


stops documentation built on July 7, 2025, 3:01 p.m.