oefpil

Crates.iooefpil
lib.rsoefpil
version
sourcesrc
created_at2024-12-11 23:33:55.893903
updated_at2024-12-11 23:33:55.893903
descriptionOptimum Estimate of Function Parameters by Iterated Linearization (OEFPIL): Algorithm for nonlinear function fitting to data with errors in both dependent and independent variables where correlation, both within variables and among variables, might be present.
homepage
repositoryhttps://github.com/qu1x/oefpil
max_upload_size
id1480612
Cargo.toml error:TOML parse error at line 28, column 1 | 28 | autolib = false | ^^^^^^^ unknown field `autolib`, expected one of `name`, `version`, `edition`, `authors`, `description`, `readme`, `license`, `repository`, `homepage`, `documentation`, `build`, `resolver`, `links`, `default-run`, `default_dash_run`, `rust-version`, `rust_dash_version`, `rust_version`, `license-file`, `license_dash_file`, `license_file`, `licenseFile`, `license_capital_file`, `forced-target`, `forced_dash_target`, `autobins`, `autotests`, `autoexamples`, `autobenches`, `publish`, `metadata`, `keywords`, `categories`, `exclude`, `include`
size0
Rouven Spreckels (n3vu0r)

documentation

https://docs.rs/oefpil

README

oefpil

Build Documentation Downloads Version Rust License

Optimum Estimate of Function Parameters by Iterated Linearization (OEFPIL)

Algorithm for nonlinear function fitting to data with errors in variables where correlation, both within variables and among variables, might be present. In principle, OEFPIL can be employed for fitting both explicit and implicit functions of any number of variables. Importantly, apart from the parameter estimates, OEFPIL also yields their covariance matrix, required for further analyses.1 Common methods such as ordinary nonlinear least squares are not capable of treating general uncertainties and correlations in both dependent and independent variables. A new computation method for nonlinear curve fitting to data with a general covariance structure is introduced. Numerical simulations show that the new method yields parameter estimates in agreement with other methods for simple covariance structures. The obtained uncertainty estimates are in agreement with Monte Carlo studies.2

The most notable features of OEFPIL are as follows:2

  • The OEFPIL algorithm features an improved estimation of uncertainties and covariance matrices of the fitted parameters which can be further propagated to physical output variables.
  • More general covariance matrices for input data can be applied, although so far they do not seem to lead to significant shifts in the physical output variables. However, estimates of uncertainties of these are obviously affected.
  • Unlike ordinary least squares OEFPIL is not sensitive to the choice of dependent and independent variables.
  • Unlike non-linear least squares and orthogonal distance regression, a reasonable uncertainty estimate can be deduced directly without resorting to Monte Carlo studies, evading thus long computation times.
  • A possible disadvantage of OEFPIL is a higher sensitivity to initial estimates of parameters and the covariance matrix of the input data. However, so far problems have been encountered only for exaggerated estimates of the input covariance matrix.

This crate provides a safe API to the oefpil-sys crate (see its system requirements) which statically links to the C/Fortran library.

See the release history to keep track of the development.

Licenses

This work is free, open source, open collaboration, and permissively licensed.

This work is dual-licensed under either MIT or Apache-2.0 at your option. This means you can select the license you prefer. This dual-licensing approach is the de-facto standard in the Rust ecosystem. For full authorship information, see the individual files and/or the commit history.

Contributions

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual-licensed as above, without any additional terms or conditions.

Footnotes

  1. R. Šlesinger, A. C. Campbell, Z. Geršlová, V. Šindlář, and G. Wimmer, “OEFPIL: New Method and Software Tool for Fitting Nonlinear Functions to Correlated Data With Errors in Variables”, 2023 14th International Conference on Measurement, 126-129 (2023).

  2. A. C. Campbell, Z. Geršlová, V. Šindlář, R. Šlesinger, and G. Wimmer, “New framework for nanoindentation curve fitting and measurement uncertainty estimation”, Precision Engineering 85, 166-173 (2024). 2

Commit count: 7

cargo fmt