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

use crate::arrays::Array;
use crate::traits::{
    errors::ArrayError,
    types::numeric::Numeric,
};

/// ArrayTrait - Array Math functions
pub trait ArrayMath<N: Numeric> where Self: Sized + Clone {

    /// Computes power of array elements
    ///
    /// # Examples
    ///
    /// ```
    /// use arr_rs::prelude::*;
    ///
    /// let arr = Array::flat(vec![1,2,3,4]).unwrap();
    /// let multiplied = arr.power(2).unwrap();
    /// assert_eq!(Array::flat(vec![1, 4, 9, 16]).unwrap(), multiplied);
    /// ```
    fn power(&self, value: N) -> Result<Array<N>, ArrayError>;

    /// Multiplication of array elements
    ///
    /// # Examples
    ///
    /// ```
    /// use arr_rs::prelude::*;
    ///
    /// let arr = Array::flat(vec![1,2,3,4]);
    /// let multiplied = arr.product().unwrap();
    /// assert_eq!(24, multiplied);
    /// ```
    fn product(&self) -> Result<N, ArrayError>;

    /// Sum of array elements
    ///
    /// # Examples
    ///
    /// ```
    /// use arr_rs::prelude::*;
    ///
    /// let arr = Array::flat(vec![1,2,3,4]);
    /// let sum = arr.sum().unwrap();
    /// assert_eq!(10, sum);
    /// ```
    fn sum(&self) -> Result<N, ArrayError>;

    /// Cumulative sum of array elements
    ///
    /// # Examples
    ///
    /// ```
    /// use arr_rs::prelude::*;
    ///
    /// let arr = Array::flat(vec![1,2,3,4]).unwrap();
    /// let sum = arr.cumsum().unwrap();
    /// assert_eq!(Array::flat(vec![1, 3, 6, 10]).unwrap(), sum);
    /// ```
    fn cumsum(&self) -> Result<Array<N>, ArrayError>;
}