data-structures-algorithms 1.0.0

Data Structures and Algorithms in Rust!
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
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53

/// Performs the Euclidean Algorithm on `a` and `b` to
/// calculate the greatest common divisor (GCD) between
/// `a` and `b`
/// 
/// # Parameters
/// - `a`: An unsigned 64-bit integer
/// - `b`: An unsigned 64-bit integer
/// 
/// # Returns
/// - An unsigned 64-bit integer representing 
/// the greatest common divisor of `a` and `b`
/// 
/// # Examples
/// ```
/// use dsa::algorithms::intro_algorithm::euclidean_algorithm;
/// 
/// assert_eq!(euclidean_algorithm(20, 5), 5);
/// ```
pub fn euclidean_algorithm(mut a: u64, mut b: u64) -> u64 {
    while b != 0 {
        let temp = b;
        b = a % b;
        a = temp;
    }
    
    a
}

/// Performs the Euclidean Algorithm **recursively** on `a` and `b`
/// to calculate the greatest common divisor (GCD) between
/// `a` and `b`
/// 
/// # Parameters
/// - `a`: An unsigned 64-bit integer
/// - `b`: An unsigned 64-bit integer
/// 
/// # Returns
/// - An unsigned 64-bit integer representing the
///   greatest common divisor of `a` and `b`
/// 
/// # Examples
/// ```
/// use dsa::algorithms::intro_algorithm::euclidean_algorithm_recursion;
/// 
/// assert_eq!(euclidean_algorithm_recursion(20, 5), 5);
/// ```
pub fn euclidean_algorithm_recursion(a: u64, b: u64) -> u64 {
    if b == 0 {
        return a;
    }
    
    euclidean_algorithm_recursion(b, a % b)
}