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
// SPDX-License-Identifier: AGPL-3.0-or-later
//! Real spherical harmonics `Y_l^m(theta`, phi) for multipole expansion - Pure WGSL
//!
//! Deep Debt Principles:
//! - Self-knowledge: Operation knows its computation
//! - Zero hardcoding: Hardware-agnostic implementation
//! - Modern idiomatic Rust: Safe, zero unsafe code
//! - Complete implementation: Production-ready, no mocks
//! - Hardware-agnostic: Pure WGSL for universal compute
use crate::device::DeviceCapabilities;
use crate::error::Result;
use crate::tensor::Tensor;
/// Real spherical harmonics `Y_l^m(theta`, phi).
/// `theta_phi`: interleaved [theta0, phi0, theta1, phi1, ...]
/// l: degree (0..6), m: order (can be negative)
pub struct SphericalHarmonics {
theta_phi: Tensor,
l: u32,
m: i32,
}
impl SphericalHarmonics {
/// Create spherical harmonics `Y_l^m` evaluation for (θ, φ) angle pairs.
#[must_use]
pub fn new(theta_phi: Tensor, l: u32, m: i32) -> Self {
Self { theta_phi, l, m }
}
fn wgsl_shader() -> &'static str {
include_str!("../shaders/special/spherical_harmonics.wgsl")
}
/// Evaluate `Y_l^m(θ`, φ) for all (θ, φ) pairs in the input.
/// # Panics
/// Panics if `theta_phi` has odd length (must be even for theta/phi pairs).
/// # Errors
/// Returns [`Err`] if buffer allocation, GPU dispatch, or buffer
/// readback fails (e.g. device lost or out of memory).
pub fn execute(self) -> Result<Tensor> {
let device = self.theta_phi.device();
let total_elements: usize = self.theta_phi.shape().iter().product();
assert!(
total_elements.is_multiple_of(2),
"theta_phi must have even length (theta, phi pairs)"
);
let size = total_elements / 2;
if size == 0 {
return Ok(Tensor::new(vec![], vec![0], device.clone()));
}
let output_buffer = device.create_buffer_f32(size)?;
let abs_m = self.m.unsigned_abs();
let m_is_positive = u32::from(self.m > 0);
#[repr(C)]
#[derive(Copy, Clone, bytemuck::Pod, bytemuck::Zeroable)]
struct Params {
size: u32,
l: u32,
abs_m: u32,
m_is_positive: u32,
}
let params = Params {
size: size as u32,
l: self.l,
abs_m,
m_is_positive,
};
let params_buffer = device
.device
.create_buffer_init(&wgpu::util::BufferInitDescriptor {
label: Some("SphericalHarmonics Params"),
contents: bytemuck::cast_slice(&[params]),
usage: wgpu::BufferUsages::UNIFORM,
});
let bind_group_layout =
device
.device
.create_bind_group_layout(&wgpu::BindGroupLayoutDescriptor {
label: Some("SphericalHarmonics Bind Group Layout"),
entries: &[
wgpu::BindGroupLayoutEntry {
binding: 0,
visibility: wgpu::ShaderStages::COMPUTE,
ty: wgpu::BindingType::Buffer {
ty: wgpu::BufferBindingType::Storage { read_only: true },
has_dynamic_offset: false,
min_binding_size: None,
},
count: None,
},
wgpu::BindGroupLayoutEntry {
binding: 1,
visibility: wgpu::ShaderStages::COMPUTE,
ty: wgpu::BindingType::Buffer {
ty: wgpu::BufferBindingType::Storage { read_only: false },
has_dynamic_offset: false,
min_binding_size: None,
},
count: None,
},
wgpu::BindGroupLayoutEntry {
binding: 2,
visibility: wgpu::ShaderStages::COMPUTE,
ty: wgpu::BindingType::Buffer {
ty: wgpu::BufferBindingType::Uniform,
has_dynamic_offset: false,
min_binding_size: None,
},
count: None,
},
],
});
let bind_group = device.device.create_bind_group(&wgpu::BindGroupDescriptor {
label: Some("SphericalHarmonics Bind Group"),
layout: &bind_group_layout,
entries: &[
wgpu::BindGroupEntry {
binding: 0,
resource: self.theta_phi.buffer().as_entire_binding(),
},
wgpu::BindGroupEntry {
binding: 1,
resource: output_buffer.as_entire_binding(),
},
wgpu::BindGroupEntry {
binding: 2,
resource: params_buffer.as_entire_binding(),
},
],
});
let shader = device.compile_shader(Self::wgsl_shader(), Some("SphericalHarmonics"));
let pipeline_layout =
device
.device
.create_pipeline_layout(&wgpu::PipelineLayoutDescriptor {
label: Some("SphericalHarmonics Pipeline Layout"),
bind_group_layouts: &[&bind_group_layout],
immediate_size: 0,
});
let pipeline = device
.device
.create_compute_pipeline(&wgpu::ComputePipelineDescriptor {
label: Some("SphericalHarmonics Pipeline"),
layout: Some(&pipeline_layout),
module: &shader,
entry_point: Some("main"),
cache: None,
compilation_options: Default::default(),
});
let mut encoder = device.create_encoder_guarded(&wgpu::CommandEncoderDescriptor {
label: Some("SphericalHarmonics Encoder"),
});
{
let mut pass = encoder.begin_compute_pass(&wgpu::ComputePassDescriptor {
label: Some("SphericalHarmonics Pass"),
timestamp_writes: None,
});
pass.set_pipeline(&pipeline);
pass.set_bind_group(0, Some(&bind_group), &[]);
let caps = DeviceCapabilities::from_device(device);
let workgroups = caps.dispatch_1d(size as u32);
pass.dispatch_workgroups(workgroups, 1, 1);
}
device.submit_commands(Some(encoder.finish()));
Ok(Tensor::from_buffer(
output_buffer,
vec![size],
device.clone(),
))
}
}
impl Tensor {
/// Compute real spherical harmonic `Y_l^m` at (theta, phi) points.
/// `theta_phi`: interleaved [theta0, phi0, theta1, phi1, ...]
/// # Errors
/// Returns [`Err`] if buffer allocation, GPU dispatch, or buffer
/// readback fails (e.g. device lost or out of memory).
pub fn spherical_harmonics(self, l: u32, m: i32) -> Result<Self> {
SphericalHarmonics::new(self, l, m).execute()
}
}
#[cfg(test)]
mod tests {
use super::*;
#[tokio::test]
async fn test_spherical_harmonics_y00() {
let device = crate::device::test_pool::get_test_device().await;
// Y_0^0 = 1/(2*sqrt(pi)) = 0.282094...
let theta_phi = vec![0.0f32, 0.0, 1.0, 2.0]; // two points
let input = Tensor::new(theta_phi, vec![4], device);
let output = input.spherical_harmonics(0, 0).unwrap();
let result = output.to_vec().unwrap();
let expected = 0.5 / std::f32::consts::PI.sqrt(); // Y_0^0 = 1/sqrt(4*pi)
assert!((result[0] - expected).abs() < 1e-5);
assert!((result[1] - expected).abs() < 1e-5);
}
}