rlst 0.10.0

A Rust native linear algebra library.
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

//! Container representing multiplication with a scalar

use std::ops::Mul;

use crate::ContainerType;
use crate::{
    dense::array::{Array, Shape, UnsafeRandomAccessByValue},
    traits::{accessors::UnsafeRandom1DAccessByValue, base_operations::BaseItem},
};

/// Scalar multiplication of array
pub struct ArrayScalarMult<Scalar, ArrayImpl, const NDIM: usize> {
    arr: Array<ArrayImpl, NDIM>,
    scalar: Scalar,
}

impl<Scalar, ArrayImpl, const NDIM: usize> ArrayScalarMult<Scalar, ArrayImpl, NDIM> {
    /// Create new
    pub fn new(scalar: Scalar, arr: Array<ArrayImpl, NDIM>) -> Self {
        Self { arr, scalar }
    }
}

impl<Scalar, ArrayImpl, const NDIM: usize> ContainerType
    for ArrayScalarMult<Scalar, ArrayImpl, NDIM>
where
    ArrayImpl: ContainerType,
{
    type Type = ArrayImpl::Type;
}

impl<Scalar, ArrayImpl, const NDIM: usize> BaseItem for ArrayScalarMult<Scalar, ArrayImpl, NDIM>
where
    ArrayImpl: BaseItem<Item = Scalar>,
    Scalar: Copy + Default,
{
    type Item = Scalar;
}

impl<Scalar, ArrayImpl, const NDIM: usize> UnsafeRandomAccessByValue<NDIM>
    for ArrayScalarMult<Scalar, ArrayImpl, NDIM>
where
    ArrayImpl: UnsafeRandomAccessByValue<NDIM> + BaseItem<Item = Scalar>,
    Scalar: Mul<ArrayImpl::Item, Output = Scalar>,
    Scalar: Copy + Default,
{
    #[inline(always)]
    unsafe fn get_value_unchecked(&self, multi_index: [usize; NDIM]) -> Self::Item {
        unsafe { self.scalar * self.arr.get_value_unchecked(multi_index) }
    }
}

impl<Scalar, ArrayImpl, const NDIM: usize> UnsafeRandom1DAccessByValue
    for ArrayScalarMult<Scalar, ArrayImpl, NDIM>
where
    ArrayImpl: UnsafeRandom1DAccessByValue + BaseItem<Item = Scalar>,
    Scalar: Mul<ArrayImpl::Item, Output = Scalar>,
    Scalar: Copy + Default,
{
    #[inline(always)]
    unsafe fn get_value_1d_unchecked(&self, index: usize) -> Self::Item {
        unsafe { self.scalar * self.arr.imp().get_value_1d_unchecked(index) }
    }
}

impl<Scalar, ArrayImpl: Shape<NDIM>, const NDIM: usize> Shape<NDIM>
    for ArrayScalarMult<Scalar, ArrayImpl, NDIM>
{
    #[inline(always)]
    fn shape(&self) -> [usize; NDIM] {
        self.arr.shape()
    }
}