rust_ad_consts/lib.rs
1//! **I do not recommend using this directly, please sea [rust-ad](https://crates.io/crates/rust-ad).**
2//!
3//! Internal constants.
4//!
5//! Lowest level of dependency.
6
7use const_format::concatcp;
8
9/// Prefix used for the derivatives of a variable (e.g. The derivative of `x` would be `der_x`).
10pub const DERIVATIVE_PREFIX: &str = "__der_";
11/// Prefix for external forward auto-diff functions.
12pub const FORWARD_PREFIX: &str = "__f_";
13/// Prefix for external reverse auto-diff functions.
14pub const REVERSE_PREFIX: &str = "__r_";
15/// Suffix for internal functions.
16const INTERNAL_SUFFIX: &str = "internal_";
17/// Prefix for internal forward auto-diff functions (e.g. `__f_a_users_function` vs `__f_internal_powi_f32`).
18pub const INTERNAL_FORWARD_PREFIX: &str = concatcp!(FORWARD_PREFIX, INTERNAL_SUFFIX);
19/// Prefix for internal reverse auto-diff functions (e.g. `__r_a_users_function` vs `__r_internal_powi_f32`).
20pub const INTERNAL_REVERSE_PREFIX: &str = concatcp!(REVERSE_PREFIX, INTERNAL_SUFFIX);
21
22// const RETURN_SUFFIX: &str = "__rtn";
23// pub const REVERSE_RETURN_DERIVATIVE: &str = concatcp!(DERIVATIVE_PREFIX,RETURN_SUFFIX);
24
25pub const REVERSE_RETURN_DERIVATIVE: &str = "r";