apple-accelerate 0.3.1

Safe Rust bindings for Apple's Accelerate framework on macOS with exhaustive optional raw C FFI
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

#![doc = include_str!("../README.md")]
#![cfg_attr(docsrs, feature(doc_cfg))]
#![allow(clippy::missing_const_for_fn)]
#![allow(clippy::missing_errors_doc)]
#![allow(clippy::module_name_repetitions)]
#![allow(clippy::must_use_candidate)]

mod bridge;
#[path = "ffi/mod.rs"]
mod raw_ffi;

/// Safe wrappers for BLAS routines in Accelerate.
pub mod blas;
/// Safe wrappers for BNNS routines in Accelerate.
pub mod bnns;
/// Error types returned by the Accelerate wrappers.
pub mod error;
/// Safe wrappers for LAPACK routines in Accelerate.
pub mod lapack;
/// Safe wrappers for Accelerate quadrature integrators.
pub mod quadrature;
/// Safe wrappers for four-lane SIMD helpers backed by Apple SIMD types.
pub mod simd;
/// Safe wrappers for sparse linear algebra routines in Accelerate.
pub mod sparse;
/// Safe wrappers for vDSP routines in Accelerate.
pub mod vdsp;
/// Safe wrappers for vForce vector functions in Accelerate.
pub mod vforce;
/// Safe wrappers for vImage routines in Accelerate.
pub mod vimage;

/// Raw FFI re-exports for Accelerate declarations behind the `raw-ffi` feature.
#[cfg(feature = "raw-ffi")]
#[cfg_attr(docsrs, doc(cfg(feature = "raw-ffi")))]
pub mod ffi {
    pub use crate::raw_ffi::*;
}

pub use crate::blas::{blas_order, blas_transpose, sdot, sgemm_row_major, sgemv_row_major};
pub use crate::bnns::{
    graph_optimization_preference as bnns_graph_optimization_preference, relu_f32 as bnns_relu_f32,
    sigmoid_f32 as bnns_sigmoid_f32, Filter as BnnsFilter,
    GraphCompileOptions as BnnsGraphCompileOptions,
};
pub use crate::error::{Error, Result};
pub use crate::lapack::{lu_decompose_f32, solve_linear_system_f32, LuDecompositionF32};
pub use crate::quadrature::{
    integrate, Integrator as QuadratureIntegrator, Options as QuadratureOptions, QuadratureOutput,
};
pub use crate::simd::{add_f32x4, dot_f32x4, length_f32x4, normalize_f32x4, Float4};
pub use crate::sparse::{
    add_to_dense_f32 as sparse_add_to_dense_f32, dot_dense_f32 as sparse_dot_dense_f32,
    dot_sparse_f32 as sparse_dot_sparse_f32, sparse_matrix_property, sparse_status, SparseIndex,
    SparseMatrixF32,
};
pub use crate::vdsp::{
    add_f32, add_f64, blackman_window, blackman_window_f64, dot_f32, dot_f64, fft_direction,
    fft_radix, hamming_window, hamming_window_f64, max_f32, max_f64, mean_f32, mean_f64, min_f32,
    min_f64, sub_f32, sub_f64, sum_f32, sum_f64, window_flags, BiquadSetup, FftSetup,
};
pub use crate::vforce::{cos_f32, exp_f32, log_f32, sin_f32, sqrt_f32};
pub use crate::vimage::{
    alpha_blend_argb8888, box_convolve_argb8888, clip_to_alpha_argb8888, contrast_stretch_planar8,
    convert_argb8888_to_planar8, convert_planar8_to_argb8888, premultiply_argb8888,
    rotate_argb8888, scale_argb8888, unpremultiply_argb8888, vimage_flags, ImageBuffer,
};