distanceMaxRelRDI: Measure distance between current and previous state in terms...
In mizer: Dynamic Multi-Species Size Spectrum Modelling
distanceMaxRelRDI R Documentation
Measure distance between current and previous state in terms of RDI
Description
![[Experimental]](../help/figures/lifecycle-experimental.svg)
This function can be used in projectToSteady() to decide when sufficient
convergence to steady state has been achieved.
Usage
distanceMaxRelRDI(params, current, previous)
Arguments
params
MizerParams
current
A named list with entries n, n_pp and n_other
describing the current state
previous
A named list with entries n, n_pp and n_other
describing the previous state
Value
The largest absolute relative change in rdi:
max(abs((current_rdi - previous_rdi) / previous_rdi))
See Also
Other distance functions:
distanceSSLogN()
mizer documentation built on Oct. 17, 2024, 9:07 a.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.
| distanceMaxRelRDI | R Documentation |
Measure distance between current and previous state in terms of RDI
Description
This function can be used in projectToSteady() to decide when sufficient
convergence to steady state has been achieved.
Usage
distanceMaxRelRDI(params, current, previous)
Arguments
params |
MizerParams |
current |
A named list with entries |
previous |
A named list with entries |
Value
The largest absolute relative change in rdi:
max(abs((current_rdi - previous_rdi) / previous_rdi))
See Also
Other distance functions:
distanceSSLogN()
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.