Slide 6
Slide 6 text
/// Returns a value of gaussian function.
///
/// # Examples
/// Returns a value of gaussian function.
///
/// ```
/// use fitting::gaussian::val;
///
/// let (mu, sigma, a): (f64, f64, f64) = (5., 3., 1.);
/// let x = 5.;
/// let y = val(x, mu, sigma, a);
/// assert_eq!(y, a);
///
/// ```
pub fn val(x: f64, mu: f64, sigma: f64, a: f64) -> f64 {
a * (-(x - mu).powi(2) / (2. * sigma.powi(2))).exp()
}
6
/// でドキュメント用のコメントを書く
・マークダウンをサポート
・Exampleセクション
❯ cargo test でテスト実行
・ドキュメントの確認
❯ cargo doc --open
参考： What is rustdoc? -
2.ドキュメンテーションコメント