rinia 0.0.16

Stable numeric foundations for graphics, animation, and simulation.
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
72
73
74
75
76
77
78
79
80
81
82
83
84
85

#[cfg(feature = "zerocopy")]
use ::zerocopy::*;

use crate::{
    scalar::{Scalard, Scalarf},
    tuple::Tuple,
};

/// A 2-dimensional vector with components of type `T`.
pub type Vec2<T> = Vector<T, 2>;

/// A 3-dimensional vector with components of type `T`.
pub type Vec3<T> = Vector<T, 3>;

/// A 4-dimensional vector with components of type `T`.
pub type Vec4<T> = Vector<T, 4>;

/// A 2-dimensional vector with single-precision floating-point components.
pub type Vec2f = Vec2<Scalarf>;

/// A 3-dimensional vector with single-precision floating-point components.
pub type Vec3f = Vec3<Scalarf>;

/// A 4-dimensional vector with single-precision floating-point components.
pub type Vec4f = Vec4<Scalarf>;

/// A 2-dimensional vector with double-precision floating-point components.
pub type Vec2d = Vec2<Scalard>;

/// A 3-dimensional vector with double-precision floating-point components.
pub type Vec3d = Vec3<Scalard>;

/// A 4-dimensional vector with double-precision floating-point components.
pub type Vec4d = Vec4<Scalard>;

/// A generic vector type with `N` dimensions and components of type `T`.
#[derive(Debug, Clone, Copy, PartialEq)]
#[cfg_attr(feature = "sakka", derive(sakka::Encode, sakka::Decode))]
#[cfg_attr(feature = "zerocopy", derive(FromBytes, Immutable, IntoBytes, KnownLayout))]
#[repr(transparent)]
pub struct Vector<T, const N: usize> {
    pub(crate) data: Tuple<T, N>,
}

/// A 2-dimensional vector with named fields `x` and `y`.
#[doc(hidden)]
#[repr(C)]
pub struct Vector2Fields<T> {
    /// The x-component of the vector.
    pub x: T,

    /// The y-component of the vector.
    pub y: T,
}

/// A 3-dimensional vector with named fields `x`, `y`, and `z`.
#[doc(hidden)]
#[repr(C)]
pub struct Vector3Fields<T> {
    /// The x-component of the vector.
    pub x: T,

    /// The y-component of the vector.
    pub y: T,

    /// The z-component of the vector.
    pub z: T,
}

/// A 4-dimensional vector with named fields `x`, `y`, `z`, and `w`.
#[doc(hidden)]
#[repr(C)]
pub struct Vector4Fields<T> {
    /// The x-component of the vector.
    pub x: T,

    /// The y-component of the vector.
    pub y: T,

    /// The z-component of the vector.
    pub z: T,

    /// The w-component of the vector.
    pub w: T,
}