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
//! Provides a generic one-dimensional [`Array`] which wraps [`arrayfire::Array`] and supports //! all [`number_general::NumberType`] variants. `Array` and `ArrayExt` support basic math like //! `Add`, `Sub`, `Mul`, `Div`, and `Rem`, with hardware acceleration on systems which support CUDA //! or OpenCL. `ArrayExt<bool>` supports common logical operations `and`, `not`, `or`, and `xor`. //! //! N-dimensional array functionality can be implemented using `Coords` and `Offsets`, which //! provide methods for indexing a one-dimensional `Array` or `ArrayExt` as an n-dimensional //! tensor. //! //! `Array` supports (de)serialization without type hinting. `ArrayExt<T>` supports serialization //! for `T: Serialize` and deserialization for `T: Deserialize`. //! //! Example usage: //! ``` //! # use std::iter::FromIterator; //! # use afarray::Array; //! # use number_general::Number; //! let a = [1, 2, 3]; //! let b = [5]; //! //! let product = &Array::from(&a[..]) * &Array::from(&b[..]); //! assert_eq!(product, Array::from_iter(vec![5, 10, 15])); //! assert_eq!(product.sum(), Number::from(30)) //! ``` //! //! This crate depends on ArrayFire version 3.8. You will have to install ArrayFire separately by //! following the instructions at //! [https://arrayfire.org/docs/installing.htm](https://arrayfire.org/docs/installing.htm) //! in order to build this crate. //! //! You can find detailed instructions for building the Rust `arrayfire` crate from crates.io at //! [https://crates.io/crates/arrayfire](https://crates.io/crates/arrayfire). use std::fmt; pub use array::*; pub use coords::*; pub use ext::*; mod array; mod coords; mod ext; pub type Complex<T> = num_complex::Complex<T>; /// The error type used for Array which may fail recoverably. pub struct ArrayError { message: String, } impl fmt::Debug for ArrayError { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { fmt::Display::fmt(self, f) } } impl fmt::Display for ArrayError { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { write!(f, "{}", self.message) } } /// The result of an `Array` operation which may fail recoverably. pub type Result<T> = std::result::Result<T, ArrayError>; /// Call [`arrayfire::info`]. pub fn print_af_info() { arrayfire::info() } fn error<I: fmt::Display>(message: I) -> ArrayError { ArrayError { message: message.to_string(), } } #[inline] fn dim4(size: usize) -> arrayfire::Dim4 { arrayfire::Dim4::new(&[size as u64, 1, 1, 1]) } #[inline] fn coord_bounds(shape: &[u64]) -> Vec<u64> { (0..shape.len()) .map(|axis| shape[axis + 1..].iter().product()) .collect() }