polylane 0.15.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
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258

// 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/>.

mod test;

mod r#impl;

use crate::ValidLayout;
use crate::mask::{Mask, MaskLayout};
use crate::simd::{Simd, SimdLayout, SimdScalar};

/// Denotes SIMD vector of mutable pointers.
#[expect(clippy::wrong_self_convention)]
pub trait SimdMutPtr<T, const N: usize>: crate::ptr::seal::SimdMutPtr
where
	T: Sized,

	SimdLayout<*mut T, N>: ValidLayout,

	SimdLayout<usize, N>: ValidLayout,
{
	/// See [`ptr::null_mut`](core::ptr::null_mut).
	#[must_use]
	fn null() -> Self;

	/// See [`ptr::dangling_mut`](core::ptr::dangling_mut).
	#[must_use]
	fn dangling() -> Self;

	/// See [`ptr::with_exposed_provenance_mut`](core::ptr::with_exposed_provenance_mut).
	#[must_use]
	fn with_exposed_provenance(addr: Simd<usize, N>) -> Self
	where
		SimdLayout<usize, N>: ValidLayout;

	/// See [`ptr::without_provenance_mut`](core::ptr::without_provenance_mut).
	#[must_use]
	fn without_provenance(addr: Simd<usize, N>) -> Self;

	#[cfg_attr(feature = "unstable_docs",      doc = "See [`<*mut _>::offset`](pointer::offset).")]
	#[cfg_attr(not(feature = "unstable_docs"), doc = "See `<*mut _>::offset`.")]
	#[expect(clippy::missing_safety_doc)]
	#[must_use]
	unsafe fn offset(self, count: Simd<isize, N>) -> Self
	where
		SimdLayout<isize, N>: ValidLayout;

	#[cfg_attr(feature = "unstable_docs",      doc = "See [`<*mut _>::byte_offset`](pointer::byte_offset).")]
	#[cfg_attr(not(feature = "unstable_docs"), doc = "See `<*mut _>::byte_offset`.")]
	#[expect(clippy::missing_safety_doc)]
	#[must_use]
	unsafe fn byte_offset(self, count: Simd<isize, N>) -> Self
	where
		SimdLayout<isize, N>: ValidLayout;

	#[cfg_attr(feature = "unstable_docs",      doc = "See [`<*mut _>::add`](pointer::add).")]
	#[cfg_attr(not(feature = "unstable_docs"), doc = "See `<*mut _>::add`.")]
	#[expect(clippy::missing_safety_doc)]
	#[must_use]
	unsafe fn add(self, count: Simd<usize, N>) -> Self
	where
		SimdLayout<usize, N>: ValidLayout;

	#[cfg_attr(feature = "unstable_docs",      doc = "See [`<*mut _>::byte_add`](pointer::byte_add).")]
	#[cfg_attr(not(feature = "unstable_docs"), doc = "See `<*mut _>::byte_add`.")]
	#[expect(clippy::missing_safety_doc)]
	#[must_use]
	unsafe fn byte_add(self, count: Simd<usize, N>) -> Self
	where
		SimdLayout<usize, N>: ValidLayout;

	#[cfg_attr(feature = "unstable_docs",      doc = "See [`<*mut _>::sub`](pointer::sub).")]
	#[cfg_attr(not(feature = "unstable_docs"), doc = "See `<*mut _>::sub`.")]
	#[expect(clippy::missing_safety_doc)]
	#[must_use]
	unsafe fn sub(self, count: Simd<usize, N>) -> Self
	where
		SimdLayout<usize, N>: ValidLayout;

	#[cfg_attr(feature = "unstable_docs",      doc = "See [`<*mut _>::byte_sub`](pointer::byte_sub).")]
	#[cfg_attr(not(feature = "unstable_docs"), doc = "See `<*mut _>::byte_sub`.")]
	#[expect(clippy::missing_safety_doc)]
	#[must_use]
	unsafe fn byte_sub(self, count: Simd<usize, N>) -> Self
	where
		SimdLayout<usize, N>: ValidLayout;

	#[cfg_attr(feature = "unstable_docs",      doc = "See [`<*mut _>::wrapping_offset`](pointer::wrapping_offset).")]
	#[cfg_attr(not(feature = "unstable_docs"), doc = "See `<*mut _>::wrapping_offset`.")]
	#[must_use]
	fn wrapping_offset(self, count: Simd<isize, N>) -> Self
	where
		SimdLayout<isize, N>: ValidLayout;

	#[cfg_attr(feature = "unstable_docs",      doc = "See [`<*mut _>::wrapping_byte_offset`](pointer::wrapping_byte_offset).")]
	#[cfg_attr(not(feature = "unstable_docs"), doc = "See `<*mut _>::wrapping_byte_offset`.")]
	#[must_use]
	fn wrapping_byte_offset(self, count: Simd<isize, N>) -> Self
	where
		SimdLayout<isize, N>: ValidLayout;

	#[cfg_attr(feature = "unstable_docs",      doc = "See [`<*mut _>::wrapping_add`](pointer::wrapping_add).")]
	#[cfg_attr(not(feature = "unstable_docs"), doc = "See `<*mut _>::wrapping_add`.")]
	#[must_use]
	fn wrapping_add(self, count: Simd<usize, N>) -> Self
	where
		SimdLayout<usize, N>: ValidLayout;

	#[cfg_attr(feature = "unstable_docs",      doc = "See [`<*mut _>::wrapping_byte_add`](pointer::wrapping_byte_add).")]
	#[cfg_attr(not(feature = "unstable_docs"), doc = "See `<*mut _>::wrapping_byte_add`.")]
	#[must_use]
	fn wrapping_byte_add(self, count: Simd<usize, N>) -> Self
	where
		SimdLayout<usize, N>: ValidLayout;

	#[cfg_attr(feature = "unstable_docs",      doc = "See [`<*mut _>::wrapping_sub`](pointer::wrapping_sub).")]
	#[cfg_attr(not(feature = "unstable_docs"), doc = "See `<*mut _>::wrapping_sub`.")]
	#[must_use]
	fn wrapping_sub(self, count: Simd<usize, N>) -> Self
	where
		SimdLayout<usize, N>: ValidLayout;

	#[cfg_attr(feature = "unstable_docs",      doc = "See [`<*mut _>::wrapping_byte_sub`](pointer::wrapping_byte_sub).")]
	#[cfg_attr(not(feature = "unstable_docs"), doc = "See `<*mut _>::wrapping_byte_sub`.")]
	#[must_use]
	fn wrapping_byte_sub(self, count: Simd<usize, N>) -> Self
	where
		SimdLayout<usize, N>: ValidLayout;

	#[cfg_attr(feature = "unstable_docs",      doc = "See [`<*mut _>::map_addr`](pointer::map_addr).")]
	#[cfg_attr(not(feature = "unstable_docs"), doc = "See `<*mut _>::map_addr`.")]
	#[must_use]
	fn map_addr<F>(self, op: F) -> Self
	where
		F: FnMut(usize) -> usize,

		SimdLayout<usize, N>: ValidLayout;

	#[cfg_attr(feature = "unstable_docs",      doc = "See [`<*mut _>::read`](pointer::read).")]
	#[cfg_attr(not(feature = "unstable_docs"), doc = "See [`ptr::read`](core::ptr::read).")]
	#[expect(clippy::missing_safety_doc)]
	#[must_use]
	unsafe fn read(self) -> Simd<T, N>
	where
		T: SimdScalar,

		SimdLayout<T, N>: ValidLayout;

	#[cfg_attr(feature = "unstable_docs",      doc = "See [`<*mut _>::read_volatile`](pointer::read_volatile).")]
	#[cfg_attr(not(feature = "unstable_docs"), doc = "See [`ptr::read_volatile`](core::ptr::read_volatile).")]
	#[expect(clippy::missing_safety_doc)]
	#[must_use]
	unsafe fn read_volatile(self) -> Simd<T, N>
	where
		T: SimdScalar,

		SimdLayout<T, N>: ValidLayout;

	#[cfg_attr(feature = "unstable_docs",      doc = "See [`<*mut _>::read_unaligned`](pointer::read_unaligned).")]
	#[cfg_attr(not(feature = "unstable_docs"), doc = "See [`ptr::read_unaligned`](core::ptr::read_unaligned).")]
	#[expect(clippy::missing_safety_doc)]
	#[must_use]
	unsafe fn read_unaligned(self) -> Simd<T, N>
	where
		T: SimdScalar,

		SimdLayout<T, N>: ValidLayout;

	#[cfg_attr(feature = "unstable_docs",      doc = "See [`<*mut _>::write`](pointer::write).")]
	#[cfg_attr(not(feature = "unstable_docs"), doc = "See [`ptr::read`](write::ptr::write).")]
	#[expect(clippy::missing_safety_doc)]
	unsafe fn write(self, value: Simd<T, N>)
	where
		T: SimdScalar,

		SimdLayout<T, N>: ValidLayout;

	#[cfg_attr(feature = "unstable_docs",      doc = "See [`<*mut _>::write_volatile`](pointer::write_volatile).")]
	#[cfg_attr(not(feature = "unstable_docs"), doc = "See [`ptr::write_volatile`](core::ptr::write_volatile).")]
	#[expect(clippy::missing_safety_doc)]
	unsafe fn write_volatile(self, value: Simd<T, N>)
	where
		T: SimdScalar,

		SimdLayout<T, N>: ValidLayout;

	#[cfg_attr(feature = "unstable_docs",      doc = "See [`<*mut _>::write_unaligned`](pointer::write_unaligned).")]
	#[cfg_attr(not(feature = "unstable_docs"), doc = "See [`ptr::write_unaligned`](core::ptr::write_unaligned).")]
	#[expect(clippy::missing_safety_doc)]
	unsafe fn write_unaligned(self, value: Simd<T, N>)
	where
		T: SimdScalar,

		SimdLayout<T, N>: ValidLayout;

	#[cfg_attr(feature = "unstable_docs",      doc = "See [`<*mut _>::addr`](pointer::addr).")]
	#[cfg_attr(not(feature = "unstable_docs"), doc = "See `<*mut _>::addr`.")]
	#[must_use]
	fn addr(self) -> Simd<usize, N>
	where
		SimdLayout<usize,  N>: ValidLayout;

	#[cfg_attr(feature = "unstable_docs",      doc = "See [`<*mut _>::align_offset`](pointer::align_offset).")]
	#[cfg_attr(not(feature = "unstable_docs"), doc = "See `<*mut _>::align_offset`.")]
	#[must_use]
	fn align_offset(self, align: Simd<usize, N>) -> Simd<usize, N>
	where
		SimdLayout<usize, N>: ValidLayout;

	#[cfg_attr(feature = "unstable_docs",      doc = "See [`<*mut _>::is_null`](pointer::is_null).")]
	#[cfg_attr(not(feature = "unstable_docs"), doc = "See `<*mut _>::is_null`.")]
	#[must_use]
	fn is_null(self) -> Mask<N>
	where
		MaskLayout<N>: ValidLayout;

	#[cfg_attr(feature = "unstable_docs",      doc = "See [`<*mut _>::is_aligned`](pointer::is_aligned).")]
	#[cfg_attr(not(feature = "unstable_docs"), doc = "See `<*mut _>::is_aligned`.")]
	#[must_use]
	fn is_aligned(self) -> Mask<N>
	where
		MaskLayout<N>: ValidLayout;

	#[cfg_attr(feature = "unstable_docs",      doc = "See [`<*mut _>::with_addr`](pointer::with_addr).")]
	#[cfg_attr(not(feature = "unstable_docs"), doc = "See `<*mut _>::with_addr`.")]
	#[must_use]
	fn with_addr(self, addr: Simd<usize, N>) -> Self
	where
		SimdLayout<usize, N>: ValidLayout;

	#[cfg_attr(feature = "unstable_docs",      doc = "See [`<*mut _>::cast`](pointer::cast).")]
	#[cfg_attr(not(feature = "unstable_docs"), doc = "See `<*mut _>::cast`.")]
	#[must_use]
	fn cast<U>(self) -> Simd<*mut U, N>
	where
		U: Sized,

		SimdLayout<*mut U, N>: ValidLayout;

	#[cfg_attr(feature = "unstable_docs",      doc = "See [`<*mut _>::cast_mut`](pointer::cast_mut).")]
	#[cfg_attr(not(feature = "unstable_docs"), doc = "See `<*mut _>::cast_mut`.")]
	#[must_use]
	fn cast_const(self) -> Simd<*const T, N>
	where
		SimdLayout<*const T, N>: ValidLayout;

	#[cfg_attr(feature = "unstable_docs",      doc = "See [`<*mut _>::expose_provenance`](pointer::expose_provenance).")]
	#[cfg_attr(not(feature = "unstable_docs"), doc = "See `<*mut _>::expose_provenance`.")]
	#[must_use]
	fn expose_provenance(self) -> Simd<usize, N>
	where
		SimdLayout<usize, N>: ValidLayout;
}