motion 0.1.6

A bare metal physics engine.
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
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71

use crate::vec::vec_2d::Vec2d;

use super::sqrt::sqrt;

/// Calculates the dot product of two 2D vectors.
///
/// # Examples
///
/// ```
/// let u = Vec2d::new(3.0, 4.0);
/// let v = Vec2d::new(1.0, 2.0);
/// let result = dot(u, v);
/// assert_eq!(result, 11.0);
/// ```
///
/// # Parameters
///
/// - `u`: The first vector.
/// - `v`: The second vector.
///
/// # Returns
///
/// The dot product of the two vectors.
#[must_use]
pub fn dot(u: Vec2d, v: Vec2d) -> f32 {
    u.x * v.x + u.y * v.y
}

/// Calculates the squared length of a 2D vector.
///
/// # Examples
///
/// ```
/// let u = Vec2d::new(3.0, 4.0);
/// let result = length2(u);
/// assert_eq!(result, 25.0);
/// ```
///
/// # Parameters
///
/// - `u`: The vector to calculate the squared length for.
///
/// # Returns
///
/// The squared length of the vector.
#[must_use]
pub fn length2(u: Vec2d) -> f32 {
    dot(u, u)
}

/// Calculates the length (magnitude) of a 2D vector.
///
/// # Examples
///
/// ```
/// let u = Vec2d::new(3.0, 4.0);
/// let result = length(u);
/// assert_eq!(result, 5.0);
/// ```
///
/// # Parameters
///
/// - `u`: The vector to calculate the length for.
///
/// # Returns
///
/// The length of the vector.
#[must_use]
pub fn length(u: Vec2d) -> f32 {
    sqrt(length2(u))
}