Adding `dimension_shiftable_buffer` library as a dependency

Run this command in a terminal, in your project's directory:

cargo add dimension_shiftable_buffer

To add it manually, edit your project's Cargo.toml file and add to the [dependencies] section:

dimension_shiftable_buffer = "1.0.0"

The dimension_shiftable_buffer library will be automatically available globally. Read the dimension_shiftable_buffer library documentation.

Back to the crate overview.

Readme

Dimension shiftable buffer

The DimensionShiftableBuffer by this crate presents a dimension shiftable buffer feature.

What's the "dimension shiftable buffer"?

First, a dimension "un-shiftable" buffer is a common buffer types such as:
- [T;3] = One datum, 3-fixed-dimension, buffer is allocated a single heap, elements placed on a sequential memory addresses.
- [[T;3]] = 0..* data, 3-fixed-dimension, buffer is allocated a single heap, elements placed on a sequential memory addresses.
- Vec<T> = 0..* data, 1-fiexed-dimension, buffer is allocated a single heap, elements placed on a sequential memory addresses.
- Vec<[T;3]> = 0..* data, 3-fixed-dimension, buffer is allocated a single heap, elements placed on a sequential memory addresses.
- Vec<Vec<T>> = 0..* data, 1..*-any-dimension, buffer is allocated a multiple heap, elements placed on a dispersed memory addresses.
Then, a dimension "shiftable" buffer is:
- DimensionShiftableBuffer<T> = 0..* data, N-shiftable-dimension, buffer is allocated a single heap, elements places on a sequential memory addresses.
  - Has one buffer heap.
  - Can access as N=1..* dimension view such as like a [&[T;3]], [&mut [T;3]], [&[T;127]].
  - With only safe implementation.

Example

[dependencies]
dimension_shiftable_buffer = "*"

Example-1

A simple usages.

// make a 2d-empty DimensionShiftableBuffer
let mut dsb = DimensionShiftableBuffer::<u8>::new(vec![], 2).unwrap();
// push a 2d-datum
dsb.push(&[0u8, 1]).unwrap();
// push a 2d-datum
dsb.push(&[2u8, 3]).unwrap();
// append a 2d-datum sequence
dsb.append(&[4u8, 5, 6, 7, 8, 9, 10, 11]).unwrap();
for index in 0..dsb.len().unwrap()
{
 // get a 2d slice
 assert_eq!(dsb.get(index).unwrap(), &[index as u8 * 2, index as u8 * 2 + 1]);
}
// shift dimension to 3 from 2
dsb.shift_dimension(3).unwrap();
// push a 3d-datum
dsb.push(&[12u8, 13, 14]).unwrap();
// get a 3d-datum
assert_eq!(dsb.get(0).unwrap(), &[0u8, 1, 2]);
assert_eq!(dsb.get(1).unwrap(), &[3u8, 4, 5]);
assert_eq!(dsb.get(2).unwrap(), &[6u8, 7, 8]);
assert_eq!(dsb.get(3).unwrap(), &[9u8, 10, 11]);
assert_eq!(dsb.get(4).unwrap(), &[12u8, 13, 14]);
// get a linear slice
let linear_slice = dsb.as_slice();
assert_eq!(linear_slice, &[0u8, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14]);

Example-2

With an error handling.

use dimension_shiftable_buffer::DimensionShiftableBuffer

 // Index of 1D =>           0      |1   |2   |3   |4   |5   |6   |7   |8   |
 // Index of 2D =>           0,0     0,1 |1,0  1,1 |2,0  2,1 |3,0  3,1 |4,0  4,1 |
 // Index of 3D =>           0,0     0,1  0,2 |1,0  1,1  1,2 |2,0  2,1  2,2 |
 // Index of 7D =>           0,0     0,1  0,2  0,3  0,4  0,5  0,6 |1,0  1,1  1,2  1,3  1,4  1,5  1,6 |
 let entity = vec![1.1f32, 1.2, 1.3, 2.1, 2.2, 2.3, 3.1, 3.2, 3.3];
 let dimension = 1;

 let mut dsb = DimensionShiftableBuffer::<f32>::new(entity, dimension).unwrap();

 let d1_i3 = dsb.get(3).unwrap();
 assert_eq!(d1_i3, [2.1f32]);

 dsb.shift_dimension(3).unwrap();

 let d3_i2 = dsb.get(2).unwrap();
 assert_eq!(d3_i2, [3.1f32, 3.2, 3.3]);

 match dsb.shift_dimension(2)
 {
  Ok(_) => panic!("Detect an unexpected false-ok."),
  Err(_) => eprintln!("Expected err.")
 }

 dsb.shift_dimension_truncate(2).unwrap();

 let d2_i1 = dsb.get(1).unwrap();
 assert_eq!(d2_i1, [1.3f32, 2.1]);

 dsb.shift_dimension_padding(7, std::f32::NAN).unwrap();
 let d7_i1 = dsb.get(1).unwrap();
 assert_eq!(
  // rounding, just easily
  format!("{:?}", d7_i1),
  format!("{:?}", &[
   // [0] of 7-d
   3.2f32,
   // [1] of 7-d, truncated at .shift_dimension.truncate(2) -> padding at .shift_dimension_padding(7)
   std::f32::NAN,
   // [2] of 7-d, padding at .shift_dimension_padding(7)
   std::f32::NAN,
   std::f32::NAN,
   std::f32::NAN,
   std::f32::NAN,
   std::f32::NAN
  ])
 )

Example-3

Additional feature="csv" (default).; CSV=Character-Separated-Values, also known as DSV or TSV.

let delimiter = " ";
let source = "0.0 1.0 2.0 3.0 4.0 5.0 6.0 7.0 8.0 9.0 10.0 11.0 12.0 13.0 14.0 15.0 16.0 17.0";
let dimension = 3;
// construct
let mut dsb = DimensionShiftableBuffer::<f32>::from_csv(source, dimension, delimiter).unwrap();
// modify-1
dsb.for_each(|v| *v += 0.1);
// modify-2
for n in 0..dsb.len().unwrap()
{
 for v in dsb.get_mut(n).unwrap()
 {
  *v *= *v;
 }
}
// show
eprintln!("{:?}", dsb);
// enumerate
for i in 0..18
// maybe, 0..5 will ok, 6..18 will err
{
 match dsb.get(i)
 {
  Ok(dimensional_elements) =>
  {
   for (i_sub, actual) in dimensional_elements.iter().enumerate()
   {
    let i_flatten = i * dimension as usize + i_sub;
    let expected = (i_flatten as f32 + 0.1) * (i_flatten as f32 + 0.1);
    assert_eq!(actual, &expected);
   }
  },
  Err(e) =>
  {
   match e
   {
    DimensionShiftableBufferError::OutOfRange {
     limit: _,
     requested: _
    } => (),
    _ => panic!("unexpected err: {:?}", e)
   }
  },
 }
}
println!("<<print CSV, as a sequential slice>>\n{}", dsb.to_csv(", "));
println!(
 "<<print CSV, as a dimmensional slices>>\n{}",
 dsb.to_csv_dimensional(", ", "\n").unwrap()
);

<<print CSV, as a sequential slice>>
0.010000001, 1.21, 4.4099994, 9.61, 16.81, 26.009998, 37.21, 50.41, 65.61001, 82.810005, 102.01001, 123.21001, 146.41, 171.61002, 198.81001, 228.01001, 259.21002, 292.41
<<print CSV, as a dimmensional slices>>
0.010000001, 1.21, 4.4099994
9.61, 16.81, 26.009998
37.21, 50.41, 65.61001
82.810005, 102.01001, 123.21001
146.41, 171.61002, 198.81001
228.01001, 259.21002, 292.41

License

Author

USAGI.NETWORK / Usagi Ito

Adding dimension_shiftable_buffer library as a dependency

Adding `dimension_shiftable_buffer` library as a dependency