mirtal 0.1.0

Native, explicit-stream Rust API for Apple Metal
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

use crate::{Error, Result};

#[derive(Debug, Clone, PartialEq, Eq, Hash)]
/// A validated list of array dimensions.
pub struct Shape(Vec<usize>);

impl Shape {
    /// Creates a shape and rejects an overflowing element count.
    pub fn new(dimensions: impl IntoIterator<Item = usize>) -> Result<Self> {
        let shape = Self(dimensions.into_iter().collect());
        shape.elements()?;
        Ok(shape)
    }

    /// Returns the total number of elements described by this shape.
    pub fn elements(&self) -> Result<usize> {
        self.0.iter().try_fold(1_usize, |total, dimension| {
            total.checked_mul(*dimension).ok_or(Error::ShapeOverflow)
        })
    }

    #[must_use]
    /// Returns the dimensions in axis order.
    pub fn dimensions(&self) -> &[usize] {
        &self.0
    }

    pub(crate) fn native(&self) -> Result<Vec<i32>> {
        let native = self
            .0
            .iter()
            .copied()
            .map(i32::try_from)
            .collect::<std::result::Result<_, _>>()?;
        Ok(native)
    }
}

impl<const N: usize> TryFrom<[usize; N]> for Shape {
    type Error = Error;

    fn try_from(value: [usize; N]) -> Result<Self> {
        Self::new(value)
    }
}

impl TryFrom<&[usize]> for Shape {
    type Error = Error;

    fn try_from(value: &[usize]) -> Result<Self> {
        Self::new(value.iter().copied())
    }
}