format_tools 0.6.0

Collection of mechanisms for formatting and serialization into string.
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
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110

//! Multidimensional math utilities.
//!
//! Provides functionality for converting multidimensional indices into flat offsets,
//! useful for operations involving multidimensional arrays or grids.

// xxx : use crate mdmath

/// Define a private namespace for all its items.
mod private
{
  use core::
  {
    fmt,
    ops::{ Add, Mul },
    cmp::PartialOrd,
  };

  /// Trait for converting a multidimensional index into a flat offset.
  ///
  /// This trait is implemented for 3-dimensional arrays, allowing conversion of a
  /// 3D index into a single linear offset. It is useful for mapping coordinates in
  /// a 3D space to a flat array.
  pub trait MdOffset< T >
  {
    /// Converts a 3D index into a flat offset.
    ///
    /// # Arguments
    ///
    /// - `md_index`: A 3-element array representing the multidimensional index.
    ///
    /// # Returns
    ///
    /// A value of type `T` representing the flat offset.
    fn md_offset( & self, md_index : Self ) -> T;
  }

  impl< T > MdOffset< T > for [ T ; 2 ]
  where
    T : Mul< T, Output = T > + Add< T, Output = T > + PartialOrd + Copy + fmt::Debug,
  {
    fn md_offset( & self, md_index : [ T ; 2 ] ) -> T
    {
      debug_assert!( md_index[ 0 ] < self[ 0 ], "md_index : {md_index:?} | md_size : {self:?}" );
      debug_assert!( md_index[ 1 ] < self[ 1 ], "md_index : {md_index:?} | md_size : {self:?}" );
      let m1 = self[ 0 ];
      md_index[ 0 ] + m1 * md_index[ 1 ]
    }
  }

  impl< T > MdOffset< T > for [ T ; 3 ]
  where
    T : Mul< T, Output = T > + Add< T, Output = T > + PartialOrd + Copy + fmt::Debug,
  {
    fn md_offset( & self, md_index : [ T ; 3 ] ) -> T
    {
      debug_assert!( md_index[ 0 ] < self[ 0 ], "md_index : {md_index:?} | md_size : {self:?}" );
      debug_assert!( md_index[ 1 ] < self[ 1 ], "md_index : {md_index:?} | md_size : {self:?}" );
      debug_assert!( md_index[ 2 ] < self[ 2 ], "md_index : {md_index:?} | md_size : {self:?}" );
      let m1 = self[ 0 ];
      let m2 = m1 * self[ 1 ];
      md_index[ 0 ] + m1 * md_index[ 1 ] + m2 * md_index[ 2 ]
    }
  }

}

#[ allow( unused_imports ) ]
pub use own::*;

/// Own namespace of the module.
#[ allow( unused_imports ) ]
pub mod own
{
  use super::*;
  #[ doc( inline ) ]
  pub use orphan::*;

  #[ doc( inline ) ]
  pub use private::
  {
    MdOffset,
  };

}

/// Orphan namespace of the module.
#[ allow( unused_imports ) ]
pub mod orphan
{
  use super::*;
  #[ doc( inline ) ]
  pub use exposed::*;
}

/// Exposed namespace of the module.
#[ allow( unused_imports ) ]
pub mod exposed
{
  use super::*;
  pub use super::super::md_math;

}

/// Prelude to use essentials: `use my_module::prelude::*`.
#[ allow( unused_imports ) ]
pub mod prelude
{
  use super::*;
}