slut 0.2.1

Static Linear Untiful Tensors. Library for Vectors and Matrices with Physical Dimensions. Basically `uom` but in a vector space.
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

use crate::tensor::*;
use crate::units::*;
use crate::tensor::element::*;
use std::marker::PhantomData;

pub type Scalar<E: TensorElement, D> = Tensor<E, D, 1, 1, 1>;

impl<E: TensorElement, D> Scalar<E, D> {
    // Require TensorElement to provide an EPSILON constant.
    pub const EPSILON: Scalar<E, D> = Scalar::default([E::EPSILON]);

    // Construct a Scalar from a basic f64 value.
    pub fn from<U: Unit<Dimension = D>>(value: E) -> Self {
        Scalar::new::<U>([value])
    }

    // Return the raw underlying element.
    pub fn raw(&self) -> E {
        self.data()[0]
    }

    // Convert the raw element into any type implementing From<E>.
    pub fn raw_as<T: From<E>>(&self) -> T {
        T::from(self.raw())
    }

    // Return a scalar containing the magnitude.
    pub fn mag(&self) -> Scalar<f64, D> {
        Scalar::default([self.raw().mag()])
    }
}

impl<E: TensorElement, D> Scalar<E, D> {
    pub fn epsilon(&self) -> Self {
        Self::EPSILON
    }
}

/// A trait to convert a value into a Scalar tensor.
pub trait ToScalar<E: TensorElement> {
    fn scalar<U: Unit>(&self) -> Scalar<E, U::Dimension>;
}

impl<E: TensorElement> ToScalar<E> for E {
    fn scalar<U: Unit>(&self) -> Scalar<E, U::Dimension> {
        Scalar::new::<U>([*self])
    }
}