has_converged: Is the relative error between two numbers is less than the...
In scanstatistics: Space-Time Anomaly Detection using Scan Statistics
View source: R/utility_functions.R
has_converged R Documentation
Is the relative error between two numbers is less than the given tolerance?
Description
Given two consecutive numbers in a sequence, return TRUE if the
relative change is positive but less than the given tolerance.
Usage
has_converged(current, previous, tol = 0.01)
Arguments
current
A scalar; the most recent value of the sequence.
previous
A scalar; the second most recent value of the sequence, or a
reference value.
tol
The tolerance, a positive scalar near zero.
scanstatistics documentation built on Feb. 16, 2023, 10:32 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
View source: R/utility_functions.R
| has_converged | R Documentation |
Is the relative error between two numbers is less than the given tolerance?
Description
Given two consecutive numbers in a sequence, return TRUE if the
relative change is positive but less than the given tolerance.
Usage
has_converged(current, previous, tol = 0.01)
Arguments
current |
A scalar; the most recent value of the sequence. |
previous |
A scalar; the second most recent value of the sequence, or a reference value. |
tol |
The tolerance, a positive scalar near zero. |
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.