microgemm 0.2.0-alpha

General matrix multiplication with custom configuration in Rust. Supports no_std and no_alloc environments.
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

#[cfg(target_arch = "aarch64")]
mod f32_4x4;

use core::marker::PhantomData;

/// Available only for the `aarch64` target.
#[derive(Debug, Clone, Copy)]
pub struct NeonKernel4x4<T> {
    marker: PhantomData<T>,
}

impl<T> NeonKernel4x4<T> {
    /// # Safety
    ///
    /// The caller must ensure that the created kernel will only be used in an
    /// environment with `neon` support.
    ///
    /// # Examples
    ///
    /// ```
    /// use microgemm::kernels::NeonKernel4x4;
    ///
    /// let kernel = if cfg!(target_feature = "neon") {
    ///     unsafe { NeonKernel4x4::<f32>::new() }
    /// } else {
    ///     panic!("neon target feature is not enabled");
    /// };
    /// ```
    #[cfg(not(doctest))]
    pub const unsafe fn new() -> Self {
        Self {
            marker: PhantomData,
        }
    }
}

#[cfg(test)]
mod tests {
    fn _check_new_neon() {
        use crate::kernels::NeonKernel4x4;

        let _kernel = if cfg!(target_feature = "neon") {
            unsafe { NeonKernel4x4::<f32>::new() }
        } else {
            panic!("neon target feature is not enabled");
        };
    }
}