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
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


#[cfg(not(feature = "no-std"))]
use crate::ToCLSource;

use super::{Combiner, Eval};

/// Resolves to either a mathematical expression as string or a computed value.
/// This is used to create generic kernels / operations over `OpenCL`, `CUDA` and `CPU`.
///
/// # Example
#[cfg_attr(not(feature = "no-std"), doc = "```")]
#[cfg_attr(feature = "no-std", doc = "```ignore")]
/// use custos::{Resolve, Eval, Combiner, ToCLSource};
///
/// let val = Resolve::with_val(1.5);
/// let out = val.mul(val).add(2.);
///
/// assert_eq!(out.eval(), 4.25);
///  
/// let mark = Resolve::<f32>::with_marker("x");
/// let out = mark.mul(mark).add(2.);
///
/// assert_eq!(out.to_cl_source(), "((x * x) + 2)");
/// ```
#[derive(Debug, Clone, Copy)]
pub struct Resolve<T> {
    /// Acts as the seed value.
    pub val: T,
    /// Acts as the variable name for the expression.
    pub marker: &'static str,
}

/// Converts a &'static str to a [`Resolve`].
pub trait ToMarker<T, R> {
    /// Converts a &'static str to a [`Resolve`].
    /// # Example
    #[cfg_attr(not(feature = "no-std"), doc = "```")]
    #[cfg_attr(feature = "no-std", doc = "```ignore")]
    /// use custos::{Resolve, ToMarker, ToCLSource};
    ///
    /// let resolve = ToMarker::<f32, Resolve<f32>>::to_marker("x");;
    /// assert_eq!(resolve.to_cl_source(), "x");
    /// ```
    fn to_marker(self) -> R;
}

impl<T: Default> ToMarker<T, Resolve<T>> for &'static str {
    #[inline]
    fn to_marker(self) -> Resolve<T> {
        Resolve::with_marker(self)
    }
}

impl<T: Default> ToMarker<T, (Resolve<T>, Resolve<T>)> for (&'static str, &'static str) {
    #[inline]
    fn to_marker(self) -> (Resolve<T>, Resolve<T>) {
        (Resolve::with_marker(self.0), Resolve::with_marker(self.1))
    }
}

/// Converts a value to a [`Resolve`].
pub trait ToVal<T = Self> {
    /// Converts a value to a [`Resolve`].
    /// # Example
    /// ```
    /// use custos::{Resolve, ToVal, Eval};
    ///
    /// let resolve: Resolve<f32> = 1.5.to_val();
    ///
    /// assert_eq!(<Resolve<f32> as Eval<f32>>::eval(resolve), 1.5);
    /// ```
    fn to_val(self) -> Resolve<T>;
}

impl<T> ToVal<T> for T {
    #[inline]
    fn to_val(self) -> Resolve<T> {
        Resolve::with_val(self)
    }
}

impl<T: Default> Default for Resolve<T> {
    #[inline]
    fn default() -> Self {
        Self {
            val: T::default(),
            marker: "x",
        }
    }
}

impl<T> Resolve<T> {
    /// Creates a `Resolve` with a value.
    /// # Example
    #[cfg_attr(not(feature = "no-std"), doc = "```")]
    #[cfg_attr(feature = "no-std", doc = "```ignore")]
    /// use custos::{Resolve, Eval, Combiner};
    ///
    /// let val = Resolve::with_val(1.5);
    /// let out = val.mul(val).add(2.);
    ///
    /// assert_eq!(out.eval(), 4.25);
    /// ```
    #[inline]
    pub fn with_val(val: T) -> Self {
        Resolve { val, marker: "x" }
    }

    /// Creates a `Resolve` with a marker.
    /// # Example
    #[cfg_attr(not(feature = "no-std"), doc = "```")]
    #[cfg_attr(feature = "no-std", doc = "```ignore")]
    /// use custos::{Resolve, Eval, Combiner, ToCLSource};
    ///
    /// let mark = Resolve::<f32>::with_marker("x");
    /// let out = mark.add(mark).mul(2.);
    ///
    /// assert_eq!(out.to_cl_source(), "((x + x) * 2)");
    /// ```
    #[inline]
    pub fn with_marker(marker: &'static str) -> Self
    where
        T: Default,
    {
        Resolve {
            val: T::default(),
            marker,
        }
    }
}

impl<T> Eval<T> for Resolve<T> {
    #[inline]
    fn eval(self) -> T {
        self.val
    }
}

#[cfg(not(feature = "no-std"))]
impl<T> ToCLSource for Resolve<T> {
    #[inline]
    fn to_cl_source(&self) -> String {
        self.marker.to_string()
    }
}

impl<T> Combiner for Resolve<T> {}