[][src]Crate numeric_array

numeric-array is a wrapper around generic-array that adds efficient numeric trait implementations, often times making use of SIMD instructions and compile-time evaluations.

All stable core::ops traits are implemented for NumericArray itself, plus the thin NumericConstant type, which is required to differeniate constant values from NumericArray itself.

Additionally, most of num_traits are implemented, including Num itself. So you can even use a whole array as a generic number.


extern crate num_traits;
extern crate generic_array;
extern crate numeric_array;

use num_traits::Float;
use numeric_array::NumericArray;

fn main() {
    let a = narr![f32; 1, 2, 3, 4];
    let b = narr![f32; 5, 6, 7, 8];
    let c = narr![f32; 9, 1, 2, 3];

    // Compiles to a single vfmadd213ps instruction on my machine
    let d = a.mul_add(b, c);

    assert_eq!(d, narr![f32; 14, 13, 23, 35]);

When used with RUSTFLAGS = "-C opt-level=3 -C target-cpu=native", then Rust and LLVM are smart enough to turn almost all operations into SIMD instructions, or even just evaluate them at compile time. The above example is actually evaluated at compile time, so if you were to view the assembly it would show the result only. Rust is pretty smart.

Therefore, this is ideal for situations where simple component-wise operations are required for arrays.


pub use generic_array::typenum;



Implementation notes


Context-sensitive SIMD operations



Sugar for NumericArray::new(arr![...])


Creates a new NumericConstant from the given expression.



A numeric wrapper for a GenericArray, allowing for easy numerical operations on the whole sequence.


This is required to allow NumericArray to be operated on by both other NumericArray instances and constants, with generic types, because some type U supercedes NumericArray<U, N>



Trait making GenericArray work, marking types to be used as length of an array