nostd_structs 0.5.0

Datastructures and algorithms for nostd environments
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

use core::ops::{Add, Div, Mul};

/// Calculate the square root of a value using Newton-Raphson iteration.
/// The number of iterations determines the precision of the result.
pub fn sqrt<T>(val: T, iterations: usize) -> Result<T, ()>
where
    T: PartialOrd + From<f32> + Div<Output = T> + Mul<Output = T> + Add<Output = T> + Copy,
{
    let zero = T::from(0.0);
    if val < zero {
        return Err(());
    }
    if val == zero {
        return Ok(zero);
    }

    // Initial guess
    let two = T::from(2.0);
    let mut guess = val / two;

    // Iterate Newton-Raphson until convergence
    let half = T::from(0.5);
    for _ in 0..iterations {
        guess = half * (guess + val / guess);
    }
    Ok(guess)
}