custos 0.7.0

A minimal OpenCL, WGPU, CUDA and host CPU array manipulation engine.
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

//! Exposes an API for static devices.
//! The usage is similiar to pytorch as `Buffer`s are moved to the gpu or another compute device via `.to_gpu`, `.to_cl`, ...
//! # Example
#![cfg_attr(any(feature = "cuda", feature = "opencl"), doc = "```")]
#![cfg_attr(not(any(feature = "cuda", feature = "opencl")), doc = "```ignore")]
//! use custos::buf;
//!
//! let buf = buf![2f32, 5., 1.].to_gpu();
//! assert_eq!(buf.read(), vec![2., 5., 1.]);
//!
//! ```

mod impl_buffer;
mod iter;
mod macros;
mod static_devices;
mod to_device;

pub use macros::*;
pub use static_devices::*;

use crate::Device;

/// A trait that returns a device's respective static device.
pub trait StaticDevice: Device {
    /// Returns the static device. You can select the index of a static [`OpenCL`](crate::OpenCL) or [`CUDA`](crate::CUDA) device
    /// by setting the `CUSTOS_CL_DEVICE_IDX` or `CUSTOS_CU_DEVICE_IDX` environment variable.
    /// # Example
    #[cfg_attr(feature = "cpu", doc = "```")]
    #[cfg_attr(not(feature = "cpu"), doc = "```ignore")]
    /// use custos::{CPU, static_api::StaticDevice};
    ///
    /// let _static_cpu = CPU::as_static();
    ///
    /// ```
    fn as_static() -> &'static Self;
}

impl StaticDevice for crate::CPU {
    #[inline]
    fn as_static() -> &'static Self {
        static_cpu()
    }
}

#[cfg(feature = "stack")]
impl StaticDevice for crate::Stack {
    #[inline]
    fn as_static() -> &'static Self {
        &crate::Stack
    }
}

#[cfg(feature = "opencl")]
impl StaticDevice for crate::OpenCL {
    #[inline]
    fn as_static() -> &'static Self {
        static_opencl()
    }
}
#[cfg(feature = "cuda")]
impl StaticDevice for crate::CUDA {
    #[inline]
    fn as_static() -> &'static Self {
        static_cuda()
    }
}