ndarray_cg 0.4.0

High-performance computer graphics mathematics library based on ndarray with vectors, matrices, and transformations
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

/// Internal namespace.
mod private
{
  // use crate::*;
  pub use ::num_traits::identities::Zero;
  pub use ::mdmath_core::Collection;

  /// Trait for objects that have an indexable dimension.
  ///
  /// This trait is used to define objects that have a specific dimensionality,
  /// allowing for operations that depend on the size and shape of the object.
  pub trait Indexable
  {
    /// The type representing the dimension of the object.
    type Index : ndarray::Dimension;

    /// Returns the dimension of the object.
    ///
    /// # Returns
    /// - `Self::Index`: The dimension of the object.
    fn dim( &self ) -> Self::Index;
  }

  /// Trait for objects that have a stride.
  ///
  /// This trait extends `Indexable` to include stride information, which is useful
  /// for operations that involve traversing or iterating over the object.
  pub trait StrideTrait : Indexable
  {
    /// Returns the stride of the object.
    ///
    /// # Returns
    /// - `<Self as Indexable>::Index`: The stride of the object.
    fn stride( &self ) -> <Self as Indexable>::Index;
  }
}

crate::mod_interface!
{
  exposed use
  {
    Zero,
    Collection,
    Indexable,
    StrideTrait,
  };
}