glm 0.3.0

GLSL mathematics for 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
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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144

//
// GLSL Mathematics for Rust.
//
// Copyright (c) 2015, 2025 The glm-rs authors.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.

// The GLSL Specification, ch 8.1, Angle and Trigonometry Functions.

use num_traits::Float;

use crate::basenum::BaseFloat;
use crate::traits::GenFloat;

/// Converts `degrees` to radians, i.e., `π/180 * degrees`.
#[inline(always)]
pub fn radians<F: BaseFloat, T: GenFloat<F>>(degrees: T) -> T {
    degrees.map(BaseFloat::to_radians)
}

/// Converts `radians` to degrees, i.e., `180/π * radians`.
#[inline(always)]
pub fn degrees<F: BaseFloat, T: GenFloat<F>>(radians: T) -> T {
    radians.map(BaseFloat::to_degrees)
}

/// The standard trigonometric sine function.
#[inline(always)]
pub fn sin<F: BaseFloat, T: GenFloat<F>>(angle: T) -> T {
    angle.map(Float::sin)
}

/// The standard trigonometric cosine function.
#[inline(always)]
pub fn cos<F: BaseFloat, T: GenFloat<F>>(angle: T) -> T {
    angle.map(Float::cos)
}

/// The standard trigonometric tangent.
#[inline(always)]
pub fn tan<F: BaseFloat, T: GenFloat<F>>(angle: T) -> T {
    angle.map(Float::tan)
}

/// Returns an angle whose sine is `x`.
///
/// The range of values returned by this function is `[-π/2, π/2]`.
///
/// Results are undefined if `|x| > 1`.
#[inline(always)]
pub fn asin<F: BaseFloat, T: GenFloat<F>>(x: T) -> T {
    x.map(Float::asin)
}

/// Returns an angle whose cosine is `x`.
///
/// The range of values returned by this function is `[0, π]`.
///
/// Results are undefined if `∣x∣ > 1`.
#[inline(always)]
pub fn acos<F: BaseFloat, T: GenFloat<F>>(x: T) -> T {
    x.map(Float::acos)
}

/// Returns an angle whose tangent is `y / x`.
///
/// The signs of `x` and `y` are used to determine what quadrant the angle is
/// in.
///
/// The range of values returned by this function is `[−π, π]`.
///
/// Results are undefined if `x` and `y` are both `0`.
///
/// # Note
///
/// `atan2` is not a GLSL function name.
#[inline(always)]
pub fn atan2<F: BaseFloat, T: GenFloat<F>>(y: T, x: T) -> T {
    x.zip(y, Float::atan2)
}

/// Returns an angle whose tangent is `y_over_x`.
///
/// The range of values returned by this function is `[-π/2, π/2]`.
#[inline(always)]
pub fn atan<F: BaseFloat, T: GenFloat<F>>(y_over_x: T) -> T {
    y_over_x.map(Float::atan)
}

/// Returns the hyperbolic sine function (e<sup>x</sup> - e<sup>-x</sup>) / 2.
#[inline(always)]
pub fn sinh<F: BaseFloat, T: GenFloat<F>>(x: T) -> T {
    x.map(Float::sinh)
}

/// Returns the hyperbolic cosine function (e<sup>x</sup> + e<sup>-x</sup>) / 2.
#[inline(always)]
pub fn cosh<F: BaseFloat, T: GenFloat<F>>(x: T) -> T {
    x.map(Float::cosh)
}

/// Returns the hyperbolic tangent function `sinh(x)/cosh(x)`.
#[inline(always)]
pub fn tanh<F: BaseFloat, T: GenFloat<F>>(x: T) -> T {
    x.map(Float::tanh)
}

/// Arc hyperbolic sine; returns the inverse of **sinh**.
#[inline(always)]
pub fn asinh<F: BaseFloat, T: GenFloat<F>>(x: T) -> T {
    x.map(Float::asinh)
}

/// Arc hyperbolic cosine; returns the non-negative inverse of **cosh**.
///
/// Results are undefined if `x < 1`.
#[inline(always)]
pub fn acosh<F: BaseFloat, T: GenFloat<F>>(x: T) -> T {
    x.map(Float::acosh)
}

/// Arc hyperbolic tangent; returns the inverse of **tanh**.
///
/// Results are undefined if `∣x∣ ≥ 1`.
#[inline(always)]
pub fn atanh<F: BaseFloat, T: GenFloat<F>>(x: T) -> T {
    x.map(Float::atanh)
}