checkAFFargs: Check the arguments for AFF (no change detection)

View source: R/errorMessage.R

checkAFFargsR Documentation

Check the arguments for AFF (no change detection)

Description

A function which will do all the checks for AFF, check the parameters are in the proper ranges, etc. Does not return any values.

Usage

checkAFFargs(eta, functionName = "")

Arguments

eta

The value of the step size in the gradient descent. Must be finite, in range [0,1], etc.

functionName

The name of the original function which is being called to check the parameters. Will help user with debugging. Default is "", in which case no function name will be displayed.


ffstream documentation built on May 31, 2023, 7:53 p.m.