ndarray_cg 0.4.0

High-performance computer graphics mathematics library based on ndarray with vectors, matrices, and transformations
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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106

use crate::*;

/// Produces a 2D rotation matrix for a given angle in radians.
///
/// # Parameters
/// - `angle_radians`: The angle of rotation in radians.
///
/// # Returns
/// - `Mat<E, 2, 2>`: A 2x2 rotation matrix.
#[ inline ]
pub fn rot< E >( angle_radians : E ) -> Mat2< E, mat::DescriptorOrderColumnMajor >
where
  E : MatEl + nd::NdFloat,
  Mat2< E, mat::DescriptorOrderColumnMajor > : RawSliceMut< Scalar = E >,
{
  let cos_theta = angle_radians.cos();
  let sin_theta = angle_radians.sin();
  Mat2::from_row_major
  ([
    cos_theta, -sin_theta,
    sin_theta, cos_theta,
  ])
}

/// Produces a 2D scaling matrix.
///
/// # Parameters
/// - `scaling`: A vector representing scaling factors along the x and y axes.
///
/// # Returns
/// - `Mat<E, 2, 2>`: A 2x2 scaling matrix.
#[ inline ]
pub fn scale< E, Scaling >( scaling : Scaling ) -> Mat2< E, mat::DescriptorOrderColumnMajor >
where
  E : MatEl + nd::NdFloat,
  Scaling : VectorIter< E, 2 >,
  Mat2< E, mat::DescriptorOrderColumnMajor > : RawSliceMut< Scalar = E >,
{
  let mut iter = scaling.vector_iter();
  let sx = *iter.next().unwrap();
  let sy = *iter.next().unwrap();
  Mat2::from_row_major
  ([
    sx,        E::zero(),
    E::zero(), sy,
  ])
}

/// Produces a 2D shearing matrix.
///
/// # Parameters
/// - `shearing`: A vector representing shearing factors along the x and y axes.
///
/// # Returns
/// - `Mat<E, 2, 2>`: A 2x2 shearing matrix.
#[ inline ]
pub fn shear< E, Shearing >( shearing : Shearing ) -> Mat2< E, mat::DescriptorOrderColumnMajor >
where
  E : MatEl + nd::NdFloat,
  Shearing : VectorIter< E, 2 >,
  Mat2< E, mat::DescriptorOrderColumnMajor > : RawSliceMut< Scalar = E >,
{
  let mut iter = shearing.vector_iter();
  let shx = *iter.next().unwrap();
  let shy = *iter.next().unwrap();
  Mat2::from_row_major
  ([
    E::one(), shx,
    shy,      E::one(),
  ])
}

/// Produces a 2D reflection matrix across the x-axis.
///
/// # Returns
/// - `Mat<E, 2, 2>`: A 2x2 reflection matrix.
#[ inline ]
pub fn reflect_x< E >() -> Mat2< E, mat::DescriptorOrderColumnMajor >
where
  E : MatEl + nd::NdFloat,
  Mat2< E, mat::DescriptorOrderColumnMajor > : RawSliceMut< Scalar = E >,
{
  Mat2::from_row_major
  ([
    E::one(),   E::zero(),
    E::zero(), -E::one(),
  ])
}

/// Produces a 2D reflection matrix across the y-axis.
///
/// # Returns
/// - `Mat<E, 2, 2>`: A 2x2 reflection matrix.
#[ inline ]
pub fn reflect_y< E >() -> Mat2< E, mat::DescriptorOrderColumnMajor >
where
  E : MatEl + nd::NdFloat,
  Mat2< E, mat::DescriptorOrderColumnMajor > : RawSliceMut< Scalar = E >,
{
  Mat2::from_row_major
  ([
    -E::one(), E::zero(),
    E::zero(), E::one(),
  ])
}