mlx-rs 0.33.0

Unofficial rust wrapper for Apple's mlx machine learning library.
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

use crate::error::{Exception, Result};
use crate::utils::guard::Guarded;
use crate::{Array, Stream};

fn checked_length(n: usize) -> Result<i32> {
    i32::try_from(n).map_err(|_| Exception::custom("FFT length exceeds i32::MAX"))
}

/// Returns the discrete Fourier transform sample frequencies for a transform of length `n`.
///
/// The sample spacing is `d`.
///
/// # Example
///
/// ```rust
/// use mlx_rs::{fft::fftfreq, Device, Dtype};
///
/// Device::set_default(&Device::cpu());
/// let frequencies = fftfreq(4, 1.0).unwrap();
/// assert_eq!(frequencies.shape(), &[4]);
/// assert_eq!(frequencies.dtype(), Dtype::Float32);
/// ```
pub fn fftfreq(n: usize, d: f64) -> Result<Array> {
    let n = checked_length(n)?;
    let stream = Stream::thread_local_or_default();
    Array::try_from_op(|res| unsafe { mlx_sys::mlx_fft_fftfreq(res, n, d, stream.as_ptr()) })
}

/// Returns the nonnegative discrete Fourier transform sample frequencies for a real transform.
///
/// The transform length is `n` and the sample spacing is `d`.
///
/// # Example
///
/// ```rust
/// use mlx_rs::{fft::rfftfreq, Device, Dtype};
///
/// Device::set_default(&Device::cpu());
/// let frequencies = rfftfreq(4, 0.5).unwrap();
/// assert_eq!(frequencies.shape(), &[3]);
/// assert_eq!(frequencies.dtype(), Dtype::Float32);
/// ```
pub fn rfftfreq(n: usize, d: f64) -> Result<Array> {
    let n = checked_length(n)?;
    let stream = Stream::thread_local_or_default();
    Array::try_from_op(|res| unsafe { mlx_sys::mlx_fft_rfftfreq(res, n, d, stream.as_ptr()) })
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn rejects_lengths_above_i32_max() {
        assert!(fftfreq(usize::MAX, 1.0).is_err());
        assert!(rfftfreq(usize::MAX, 1.0).is_err());
    }
}