numpy 0.10.0

Rust binding of NumPy C-API
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

//! Defines error types.
use crate::types::DataType;
use pyo3::{exceptions as exc, PyErr, PyErrArguments, PyErrValue, PyObject, Python, ToPyObject};
use std::fmt;

/// Represents a dimension and dtype of numpy array.
///
/// Only for error formatting.
#[derive(Debug)]
pub(crate) struct ArrayDim {
    dim: Option<usize>,
    dtype: Option<DataType>,
}

impl fmt::Display for ArrayDim {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        let ArrayDim { dim, dtype } = self;
        match (dim, dtype) {
            (Some(dim), Some(dtype)) => write!(f, "dim={:?}, dtype={:?}", dim, dtype),
            (None, Some(dtype)) => write!(f, "dim=_, dtype={:?}", dtype),
            (Some(dim), None) => write!(f, "dim={:?}, dtype=Unknown", dim),
            (None, None) => write!(f, "dim=_, dtype=Unknown"),
        }
    }
}

/// Represents that shapes of the given arrays don't match.
#[derive(Debug)]
pub struct ShapeError {
    from: ArrayDim,
    to: ArrayDim,
}

impl ShapeError {
    pub(crate) fn new(
        from_type: i32,
        from_dim: usize,
        to_type: DataType,
        to_dim: Option<usize>,
    ) -> Self {
        ShapeError {
            from: ArrayDim {
                dim: Some(from_dim),
                dtype: DataType::from_i32(from_type),
            },
            to: ArrayDim {
                dim: to_dim,
                dtype: Some(to_type),
            },
        }
    }
}

impl fmt::Display for ShapeError {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        let ShapeError { from, to } = self;
        write!(f, "Shape Mismatch:\n from=({}), to=({})", from, to)
    }
}

macro_rules! impl_pyerr {
    ($err_type: ty) => {
        impl std::error::Error for $err_type {}

        impl PyErrArguments for $err_type {
            fn arguments(&self, py: Python) -> PyObject {
                format!("{}", self).to_object(py)
            }
        }

        impl std::convert::From<$err_type> for PyErr {
            fn from(err: $err_type) -> PyErr {
                PyErr::from_value::<exc::TypeError>(PyErrValue::from_err_args(err))
            }
        }
    };
}

impl_pyerr!(ShapeError);

/// Represents that given vec cannot be treated as array.
#[derive(Debug)]
pub struct FromVecError {
    len1: usize,
    len2: usize,
}

impl FromVecError {
    pub(crate) fn new(len1: usize, len2: usize) -> Self {
        FromVecError { len1, len2 }
    }
}

impl fmt::Display for FromVecError {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        let FromVecError { len1, len2 } = self;
        write!(
            f,
            "Invalid lenension as an array\n Expected the same length {}, but found {}",
            len1, len2
        )
    }
}

impl_pyerr!(FromVecError);

/// Represents that the array is not contiguous.
#[derive(Debug)]
pub struct NotContiguousError;

impl fmt::Display for NotContiguousError {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "The given array is not contiguous",)
    }
}

impl_pyerr!(NotContiguousError);