safe_sqrt: Safe square root
In fb4package: 'Fish Bioenergetics 4.0' Model Implementation with High-Performance 'TMB' Backend
safe_sqrt R Documentation
Safe square root
Description
Computes sqrt(x) with protection against negative inputs.
Negative values are clamped to min_val before taking the root.
Usage
safe_sqrt(x, min_val = 0, warn = TRUE, param_name = "value")
Arguments
x
Numeric value or vector
min_val
Minimum value before sqrt, default 0
warn
Logical; issue a warning when clamping occurs, default TRUE
param_name
Name used in warning messages
Value
sqrt(x), or sqrt(min_val) for negative values
Examples
safe_sqrt(4)
suppressWarnings(safe_sqrt(-1))
fb4package documentation built on May 8, 2026, 1: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.
| safe_sqrt | R Documentation |
Safe square root
Description
Computes sqrt(x) with protection against negative inputs.
Negative values are clamped to min_val before taking the root.
Usage
safe_sqrt(x, min_val = 0, warn = TRUE, param_name = "value")
Arguments
x |
Numeric value or vector |
min_val |
Minimum value before sqrt, default 0 |
warn |
Logical; issue a warning when clamping occurs, default TRUE |
param_name |
Name used in warning messages |
Value
sqrt(x), or sqrt(min_val) for negative values
Examples
safe_sqrt(4)
suppressWarnings(safe_sqrt(-1))
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.