polylane 0.9.0

Portable and versatile SIMD.
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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223

// Copyright 2025 Gabriel Bjørnager Jensen.
//
// This Source Code Form is subject to the terms of
// the Mozilla Public License, v. 2.0. If a copy of
// the MPL was not distributed with this file, you
// can obtain one at:
// <https://mozilla.org/MPL/2.0/>.

use crate::cmp::{SimdPartialEq, SimdPartialOrd};
use crate::num::SimdUint;
use crate::simd::SimdScalar;

use core::cmp::{PartialEq, PartialOrd};
use core::ops::{
	Add,
	AddAssign,
	Div,
	DivAssign,
	Mul,
	MulAssign,
	Neg,
	Rem,
	RemAssign,
	Sub,
	SubAssign,
};
use multitype::Float;

/// Denotes SIMD vector of floating-point scalars.
pub trait SimdFloat
where
	Self:
		crate::num::seal::SimdFloat
		+ Copy
		+ PartialEq
		+ PartialOrd
		+ SimdPartialEq
		+ SimdPartialOrd
		// Arithmetic operators:
		+ Add<Output = Self>
		+ Div<Output = Self>
		+ Mul<Output = Self>
		+ Neg<Output = Self>
		+ Rem<Output = Self>
		+ Sub<Output = Self>
		// Assigning arithmetic operators:
		+ AddAssign
		+ DivAssign
		+ MulAssign
		+ RemAssign
		+ SubAssign,
{
	/// The underlying, scalar type.
	type Scalar: SimdScalar + Float;

	/// The length of the vector type.
	const LEN: usize;

	/// A vector type of equivalently-wide, unsigned integers.
	type Bits: SimdUint;

	/// See <code>[f64]::[EPSILON](f64::EPSILON)</code>.
	const EPSILON:         Self;

	/// See <code>[f64]::[MIN](f64::MIN)</code>.
	const MIN:             Self;

	/// See <code>[f64]::[MIN_POSITIVE](f64::MIN_POSITIVE)</code>.
	const MIN_POSITIVE:    Self;

	/// See <code>[f64]::[MAX](f64::MAX)</code>.
	const MAX:             Self;

	/// See <code>[f64]::[INFINITY](f64::INFINITY)</code>.
	const INFINITY:        Self;

	/// See <code>[f64]::[NEG_INFINITY](f64::NEG_INFINITY)</code>.
	const NEG_INFINITY:    Self;

	/// See <code>[f64]::[NAN](f64::NAN)</code>.
	const NAN:             Self;

	/// See <code>[f64](core::f64)::[consts](core::f64::consts)::[E](core::f64::consts::E)</code>.
	const E:               Self;

	/// See <code>[f64](core::f64)::[consts](core::f64::consts)::[PI](core::f64::consts::PI)</code>.
	const PI:              Self;

	/// See <code>[f64](core::f64)::[consts](core::f64::consts)::[TAU](core::f64::consts::TAU)</code>.
	const TAU:             Self;

	/// See <code>[f64](core::f64)::[consts](core::f64::consts)::[LOG2_10](core::f64::consts::LOG2_10)</code>.
	const LOG2_10:         Self;

	/// See <code>[f64](core::f64)::[consts](core::f64::consts)::[LOG2_E](core::f64::consts::LOG2_E)</code>.
	const LOG2_E:          Self;

	/// See <code>[f64](core::f64)::[consts](core::f64::consts)::[LN_2](core::f64::consts::LN_2)</code>.
	const LN_2:            Self;

	/// See <code>[f64](core::f64)::[consts](core::f64::consts)::[LN_10](core::f64::consts::LN_10)</code>.
	const LN_10:           Self;

	/// See <code>[f64](core::f64)::[consts](core::f64::consts)::[LOG10_2](core::f64::consts::LOG10_2)</code>.
	const LOG10_2:         Self;

	/// See <code>[f64](core::f64)::[consts](core::f64::consts)::[LOG10_E](core::f64::consts::LOG10_E)</code>.
	const LOG10_E:         Self;

	/// See <code>[f64](core::f64)::[consts](core::f64::consts)::[SQRT_2](core::f64::consts::SQRT_2)</code>.
	const SQRT_2:          Self;

	/// See <code>[f64](core::f64)::[consts](core::f64::consts)::[FRAC_1_PI](core::f64::consts::FRAC_1_PI)</code>.
	const FRAC_1_PI:       Self;

	/// See <code>[f64](core::f64)::[consts](core::f64::consts)::[FRAC_1_SQRT_2](core::f64::consts::FRAC_1_SQRT_2)</code>.
	const FRAC_1_SQRT_2:   Self;

	/// See <code>[f64](core::f64)::[consts](core::f64::consts)::[FRAC_2_PI](core::f64::consts::FRAC_2_PI)</code>.
	const FRAC_2_PI:       Self;

	/// See <code>[f64](core::f64)::[consts](core::f64::consts)::[FRAC_2_SQRT_PI](core::f64::consts::FRAC_2_SQRT_PI)</code>.
	const FRAC_2_SQRT_PI:  Self;

	/// See <code>[f64](core::f64)::[consts](core::f64::consts)::[FRAC_PI_2](core::f64::consts::FRAC_PI_2)</code>.
	const FRAC_PI_2:       Self;

	/// See <code>[f64](core::f64)::[consts](core::f64::consts)::[FRAC_PI_3](core::f64::consts::FRAC_PI_3)</code>.
	const FRAC_PI_3:       Self;

	/// See <code>[f64](core::f64)::[consts](core::f64::consts)::[FRAC_PI_4](core::f64::consts::FRAC_PI_4)</code>.
	const FRAC_PI_4:       Self;

	/// See <code>[f64](core::f64)::[consts](core::f64::consts)::[FRAC_PI_6](core::f64::consts::FRAC_PI_6)</code>.
	const FRAC_PI_6:       Self;

	/// See <code>[f64](core::f64)::[consts](core::f64::consts)::[FRAC_PI_8](core::f64::consts::FRAC_PI_8)</code>.
	const FRAC_PI_8:       Self;

	/// See <code>[f64]::[from_bits](f64::from_bits)</code>.
	#[must_use]
	fn from_bits(bits: Self::Bits) -> Self;

	/// See <code>[f64]::[abs](f64::abs)</code>.
	#[must_use]
	fn abs(self) -> Self;

	/// See <code>[f64]::[recip](f64::recip)</code>.
	#[must_use]
	fn recip(self) -> Self;

	/// See <code>[f64]::[midpoint](f64::midpoint)</code>.
	#[must_use]
	fn midpoint(self, rhs: Self) -> Self;

	/// See <code>[f64]::[to_radians](f64::to_radians)</code>.
	#[must_use]
	fn to_radians(self) -> Self;

	/// See <code>[f64]::[to_degrees](f64::to_degrees)</code>.
	#[must_use]
	fn to_degrees(self) -> Self;

	/// See <code>[f64]::[next_down](f64::next_down)</code>.
	#[must_use]
	fn next_down(self) -> Self;

	/// See <code>[f64]::[next_up](f64::next_up)</code>.
	#[must_use]
	fn next_up(self) -> Self;

	/// See <code>[f64]::[signum](f64::signum)</code>.
	#[must_use]
	fn signum(self) -> Self;

	/// See <code>[f64]::[copysign](f64::copysign)</code>.
	#[must_use]
	fn copysign(self, sign: Self) -> Self;

	/// See <code>[f64]::[is_nan](f64::is_nan)</code>.
	#[must_use]
	fn is_nan(self) -> Self::Mask;

	/// See <code>[f64]::[is_infinite](f64::is_infinite)</code>.
	#[must_use]
	fn is_infinite(self) -> Self::Mask;

	/// See <code>[f64]::[is_finite](f64::is_finite)</code>.
	#[must_use]
	fn is_finite(self) -> Self::Mask;

	/// See <code>[f64]::[is_normal](f64::is_normal)</code>.
	#[must_use]
	fn is_normal(self) -> Self::Mask;

	/// See <code>[f64]::[is_subnormal](f64::is_subnormal)</code>.
	#[must_use]
	fn is_subnormal(self) -> Self::Mask;

	/// See <code>[f64]::[is_sign_negative](f64::is_sign_negative)</code>.
	#[must_use]
	fn is_sign_negative(self) -> Self::Mask;

	/// See <code>[f64]::[is_sign_positive](f64::is_sign_positive)</code>.
	#[must_use]
	fn is_sign_positive(self) -> Self::Mask;

	/// See <code>[f64]::[clamp](f64::clamp)</code>.
	#[must_use]
	fn clamp(self, min: Self, max: Self) -> Self;

	/// See <code>[f64]::[min](f64::min)</code>.
	#[must_use]
	fn min(self, rhs: Self) -> Self;

	/// See <code>[f64]::[max](f64::max)</code>.
	#[must_use]
	fn max(self, rhs: Self) -> Self;

	/// See <code>[f64]::[to_bits](f64::to_bits)</code>.
	#[must_use]
	fn to_bits(self) -> Self::Bits;
}