Add ArraySubset::new_with_ranges

CHANGELOG.md

@@ -15,6 +15,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
    - Adds generic `StoreLocks`, `StoreKeyMutex`, and `StoreKeyMutexGuard` with associated traits and async variants
    - Includes `DefaultStoreLocks` and `DisabledStoreLocks` implementations
  - Readable and writable stores include a `new_with_locks` method to choose the store lock implementation
+ - Added `ArraySubset::new_with_ranges`
 
 ### Changed
  - **Breaking**  `ReadableStorageTraits` is no longer a supertrait of `WritableStorageTraits`

examples/array_write_read.rs

@@ -75,13 +75,13 @@ fn array_write_read() -> Result<(), Box<dyn std::error::Error>> {
 
     // Write a subset spanning multiple chunks, including updating chunks already written
     array.store_array_subset_elements::<f32>(
-        &ArraySubset::new_with_start_shape(vec![3, 3], vec![3, 3]).unwrap(),
+        &ArraySubset::new_with_ranges(&[3..6, 3..6]),
         vec![0.1, 0.2, 0.3, 0.4, 0.5, 0.6, 0.7, 0.8, 0.9],
     )?;
 
     // Store elements directly, in this case set the 7th column to 123.0
     array.store_array_subset_elements::<f32>(
-        &ArraySubset::new_with_start_shape(vec![0, 6], vec![8, 1])?,
+        &ArraySubset::new_with_ranges(&[0..8, 6..7]),
         vec![123.0; 8],
     )?;
 
@@ -90,15 +90,15 @@ fn array_write_read() -> Result<(), Box<dyn std::error::Error>> {
         // chunk indices
         &[1, 1],
         // subset within chunk
-        &ArraySubset::new_with_start_shape(vec![3, 0], vec![1, 4])?,
+        &ArraySubset::new_with_ranges(&[3..4, 0..4]),
         vec![-4.0; 4],
     )?;
 
     // Erase a chunk
     array.erase_chunk(&[0, 1])?;
 
     // Read the whole array
-    let subset_all = ArraySubset::new_with_start_shape(vec![0, 0], array.shape().to_vec())?;
+    let subset_all = ArraySubset::new_with_shape(array.shape().to_vec());
     let data_all = array.retrieve_array_subset_ndarray::<f32>(&subset_all)?;
     println!("The whole array is:\n{:?}\n", data_all);
 
@@ -108,7 +108,7 @@ fn array_write_read() -> Result<(), Box<dyn std::error::Error>> {
     println!("Chunk [1,0] is:\n{data_chunk:?}\n");
 
     // Read the central 4x2 subset of the array
-    let subset_4x2 = ArraySubset::new_with_start_shape(vec![2, 3], vec![4, 2])?; // the center 4x2 region
+    let subset_4x2 = ArraySubset::new_with_ranges(&[2..6, 3..5]); // the center 4x2 region
     let data_4x2 = array.retrieve_array_subset_ndarray::<f32>(&subset_4x2)?;
     println!("The middle 4x2 subset is:\n{:?}\n", data_4x2);
 

examples/async_array_write_read.rs

@@ -83,15 +83,15 @@ async fn async_array_write_read() -> Result<(), Box<dyn std::error::Error>> {
     // Write a subset spanning multiple chunks, including updating chunks already written
     array
         .async_store_array_subset_elements::<f32>(
-            &ArraySubset::new_with_start_shape(vec![3, 3], vec![3, 3]).unwrap(),
+            &ArraySubset::new_with_ranges(&[3..6, 3..6]),
             vec![0.1, 0.2, 0.3, 0.4, 0.5, 0.6, 0.7, 0.8, 0.9],
         )
         .await?;
 
     // Store elements directly, in this case set the 7th column to 123.0
     array
         .async_store_array_subset_elements::<f32>(
-            &ArraySubset::new_with_start_shape(vec![0, 6], vec![8, 1])?,
+            &ArraySubset::new_with_ranges(&[0..8, 6..7]),
             vec![123.0; 8],
         )
         .await?;
@@ -102,7 +102,7 @@ async fn async_array_write_read() -> Result<(), Box<dyn std::error::Error>> {
             // chunk indices
             &[1, 1],
             // subset within chunk
-            &ArraySubset::new_with_start_shape(vec![3, 0], vec![1, 4])?,
+            &ArraySubset::new_with_ranges(&[3..4, 0..4]),
             vec![-4.0; 4],
         )
         .await?;
@@ -111,7 +111,7 @@ async fn async_array_write_read() -> Result<(), Box<dyn std::error::Error>> {
     array.async_erase_chunk(&[0, 1]).await?;
 
     // Read the whole array
-    let subset_all = ArraySubset::new_with_start_shape(vec![0, 0], array.shape().to_vec())?;
+    let subset_all = ArraySubset::new_with_shape(array.shape().to_vec());
     let data_all = array
         .async_retrieve_array_subset_ndarray::<f32>(&subset_all)
         .await?;
@@ -125,7 +125,7 @@ async fn async_array_write_read() -> Result<(), Box<dyn std::error::Error>> {
     println!("Chunk [1,0] is:\n{data_chunk:?}\n");
 
     // Read the central 4x2 subset of the array
-    let subset_4x2 = ArraySubset::new_with_start_shape(vec![2, 3], vec![4, 2])?; // the center 4x2 region
+    let subset_4x2 = ArraySubset::new_with_ranges(&[2..6, 3..5]); // the center 4x2 region
     let data_4x2 = array
         .async_retrieve_array_subset_ndarray::<f32>(&subset_4x2)
         .await?;

examples/async_http_array_read.rs

@@ -34,7 +34,7 @@ async fn http_array_read() -> Result<(), Box<dyn std::error::Error>> {
     );
 
     // Read the whole array
-    let subset_all = ArraySubset::new_with_start_shape(vec![0, 0], array.shape().to_vec())?;
+    let subset_all = ArraySubset::new_with_shape(array.shape().to_vec());
     let data_all = array
         .async_retrieve_array_subset_ndarray::<f32>(&subset_all)
         .await?;
@@ -48,7 +48,7 @@ async fn http_array_read() -> Result<(), Box<dyn std::error::Error>> {
     println!("Chunk [1,0] is:\n{data_chunk:?}\n");
 
     // Read the central 4x2 subset of the array
-    let subset_4x2 = ArraySubset::new_with_start_shape(vec![2, 3], vec![4, 2])?; // the center 4x2 region
+    let subset_4x2 = ArraySubset::new_with_ranges(&[2..6, 3..5]); // the center 4x2 region
     let data_4x2 = array
         .async_retrieve_array_subset_ndarray::<f32>(&subset_4x2)
         .await?;

examples/http_array_read.rs

@@ -34,7 +34,7 @@ fn http_array_read() -> Result<(), Box<dyn std::error::Error>> {
     );
 
     // Read the whole array
-    let subset_all = ArraySubset::new_with_start_shape(vec![0, 0], array.shape().to_vec())?;
+    let subset_all = ArraySubset::new_with_shape(array.shape().to_vec());
     let data_all = array.retrieve_array_subset_ndarray::<f32>(&subset_all)?;
     println!("The whole array is:\n{:?}\n", data_all);
 
@@ -44,7 +44,7 @@ fn http_array_read() -> Result<(), Box<dyn std::error::Error>> {
     println!("Chunk [1,0] is:\n{data_chunk:?}\n");
 
     // Read the central 4x2 subset of the array
-    let subset_4x2 = ArraySubset::new_with_start_shape(vec![2, 3], vec![4, 2])?; // the center 4x2 region
+    let subset_4x2 = ArraySubset::new_with_ranges(&[2..6, 3..5]); // the center 4x2 region
     let data_4x2 = array.retrieve_array_subset_ndarray::<f32>(&subset_4x2)?;
     println!("The middle 4x2 subset is:\n{:?}\n", data_4x2);
 

examples/rectangular_array_write_read.rs

@@ -86,7 +86,7 @@ fn rectangular_array_write_read() -> Result<(), Box<dyn std::error::Error>> {
 
     // Store elements directly, in this case set the 7th column to 123.0
     array.store_array_subset_elements::<f32>(
-        &ArraySubset::new_with_start_shape(vec![0, 6], vec![8, 1])?,
+        &ArraySubset::new_with_ranges(&[0..8, 6..7]),
         vec![123.0; 8],
     )?;
 
@@ -95,12 +95,12 @@ fn rectangular_array_write_read() -> Result<(), Box<dyn std::error::Error>> {
         // chunk indices
         &[3, 1],
         // subset within chunk
-        &ArraySubset::new_with_start_shape(vec![1, 0], vec![1, 4])?,
+        &ArraySubset::new_with_ranges(&[1..2, 0..4]),
         vec![-4.0; 4],
     )?;
 
     // Read the whole array
-    let subset_all = ArraySubset::new_with_start_shape(vec![0, 0], array.shape().to_vec())?;
+    let subset_all = ArraySubset::new_with_shape(array.shape().to_vec());
     let data_all = array.retrieve_array_subset_ndarray::<f32>(&subset_all)?;
     println!("The whole array is:\n{:?}\n", data_all);
 
@@ -110,7 +110,7 @@ fn rectangular_array_write_read() -> Result<(), Box<dyn std::error::Error>> {
     println!("Chunk [1,0] is:\n{data_chunk:?}\n");
 
     // Read the central 4x2 subset of the array
-    let subset_4x2 = ArraySubset::new_with_start_shape(vec![2, 3], vec![4, 2])?; // the center 4x2 region
+    let subset_4x2 = ArraySubset::new_with_ranges(&[2..6, 3..5]); // the center 4x2 region
     let data_4x2 = array.retrieve_array_subset_ndarray::<f32>(&subset_4x2)?;
     println!("The middle 4x2 subset is:\n{:?}\n", data_4x2);
 

examples/sharded_array_write_read.rs

@@ -94,7 +94,7 @@ fn sharded_array_write_read() -> Result<(), Box<dyn std::error::Error>> {
     })?;
 
     // Read the whole array
-    let subset_all = ArraySubset::new_with_start_shape(vec![0, 0], array.shape().to_vec())?; // the center 4x2 region
+    let subset_all = ArraySubset::new_with_shape(array.shape().to_vec()); // the center 4x2 region
     let data_all = array.retrieve_array_subset_ndarray::<u16>(&subset_all)?;
     println!("The whole array is:\n{:?}\n", data_all);
 
@@ -104,12 +104,12 @@ fn sharded_array_write_read() -> Result<(), Box<dyn std::error::Error>> {
     println!("Shard [1,0] is:\n{data_shard:?}\n");
 
     // Read an inner chunk from the store
-    let subset_chunk_1_0 = ArraySubset::new_with_start_shape(vec![4, 0], vec![4, 4])?;
+    let subset_chunk_1_0 = ArraySubset::new_with_ranges(&[4..8, 0..4]);
     let data_chunk = array.retrieve_array_subset_ndarray::<u16>(&subset_chunk_1_0)?;
     println!("Chunk [1,0] is:\n{data_chunk:?}\n");
 
     // Read the central 4x2 subset of the array
-    let subset_4x2 = ArraySubset::new_with_start_shape(vec![2, 3], vec![4, 2])?; // the center 4x2 region
+    let subset_4x2 = ArraySubset::new_with_ranges(&[2..6, 3..5]); // the center 4x2 region
     let data_4x2 = array.retrieve_array_subset_ndarray::<u16>(&subset_4x2)?;
     println!("The middle 4x2 subset is:\n{:?}\n", data_4x2);
 

examples/zip_array_write_read.rs

@@ -65,13 +65,13 @@ fn write_array_to_storage<TStorage: ReadableWritableStorageTraits>(
 
     // Write a subset spanning multiple chunks, including updating chunks already written
     array.store_array_subset_elements::<f32>(
-        &ArraySubset::new_with_start_shape(vec![3, 3], vec![3, 3]).unwrap(),
+        &ArraySubset::new_with_ranges(&[3..6, 3..6]),
         vec![0.1, 0.2, 0.3, 0.4, 0.5, 0.6, 0.7, 0.8, 0.9],
     )?;
 
     // Store elements directly, in this case set the 7th column to 123.0
     array.store_array_subset_elements::<f32>(
-        &ArraySubset::new_with_start_shape(vec![0, 6], vec![8, 1])?,
+        &ArraySubset::new_with_ranges(&[0..8, 6..7]),
         vec![123.0; 8],
     )?;
 
@@ -80,7 +80,7 @@ fn write_array_to_storage<TStorage: ReadableWritableStorageTraits>(
         // chunk indices
         &[1, 1],
         // subset within chunk
-        &ArraySubset::new_with_start_shape(vec![3, 0], vec![1, 4])?,
+        &ArraySubset::new_with_ranges(&[3..4, 0..4]),
         vec![-4.0; 4],
     )?;
 
@@ -91,7 +91,7 @@ fn read_array_from_store<TStorage: ReadableStorageTraits>(
     array: Array<TStorage>,
 ) -> Result<(), Box<dyn std::error::Error>> {
     // Read the whole array
-    let subset_all = ArraySubset::new_with_start_shape(vec![0, 0], array.shape().to_vec())?;
+    let subset_all = ArraySubset::new_with_shape(array.shape().to_vec());
     let data_all = array.retrieve_array_subset_ndarray::<f32>(&subset_all)?;
     println!("The whole array is:\n{:?}\n", data_all);
 
@@ -101,7 +101,7 @@ fn read_array_from_store<TStorage: ReadableStorageTraits>(
     println!("Chunk [1,0] is:\n{data_chunk:?}\n");
 
     // Read the central 4x2 subset of the array
-    let subset_4x2 = ArraySubset::new_with_start_shape(vec![2, 3], vec![4, 2])?; // the center 4x2 region
+    let subset_4x2 = ArraySubset::new_with_ranges(&[2..6, 3..5]); // the center 4x2 region
     let data_4x2 = array.retrieve_array_subset_ndarray::<f32>(&subset_4x2)?;
     println!("The middle 4x2 subset is:\n{:?}\n", data_4x2);
 

src/array.rs

@@ -706,13 +706,12 @@ mod tests {
 
         array
             .store_array_subset_elements::<f32>(
-                &ArraySubset::new_with_start_shape(vec![3, 3], vec![3, 3]).unwrap(),
+                &ArraySubset::new_with_ranges(&[3..6, 3..6]),
                 vec![0.1, 0.2, 0.3, 0.4, 0.5, 0.6, 0.7, 0.8, 0.9],
             )
             .unwrap();
 
-        let subset_all =
-            ArraySubset::new_with_start_shape(vec![0, 0], array.shape().to_vec()).unwrap();
+        let subset_all = ArraySubset::new_with_shape(array.shape().to_vec());
         let data_all = array
             .retrieve_array_subset_elements::<f32>(&subset_all)
             .unwrap();
@@ -750,11 +749,10 @@ mod tests {
         let mut any_not_equal = false;
         for j in 1..10 {
             (0..100).into_par_iter().for_each(|i| {
-                let subset = ArraySubset::new_with_start_shape(vec![i, 0], vec![1, 4]).unwrap();
+                let subset = ArraySubset::new_with_ranges(&[i..i + 1, 0..4]);
                 array.store_array_subset(&subset, vec![j; 4]).unwrap();
             });
-            let subset_all =
-                ArraySubset::new_with_start_shape(vec![0, 0], array.shape().to_vec()).unwrap();
+            let subset_all = ArraySubset::new_with_shape(array.shape().to_vec());
             let data_all = array.retrieve_array_subset(&subset_all).unwrap();
             let all_equal = data_all.iter().all_equal_value() == Ok(&j);
             if expect_equal {

src/array/codec.rs

@@ -1091,7 +1091,7 @@ mod tests {
     #[test]
     fn test_array_subset_iterator1() {
         let array_shape = vec![2, 2];
-        let array_subset = ArraySubset::new_with_start_shape(vec![0, 0], vec![2, 1]).unwrap();
+        let array_subset = ArraySubset::new_with_shape(vec![2, 1]);
         let mut iter = array_subset.iter_contiguous_indices(&array_shape).unwrap();
 
         assert_eq!(iter.next().unwrap(), (vec![0, 0], 1));
@@ -1102,7 +1102,7 @@ mod tests {
     #[test]
     fn test_array_subset_iterator2() {
         let array_shape = vec![2, 2];
-        let array_subset = ArraySubset::new_with_start_shape(vec![1, 0], vec![1, 2]).unwrap();
+        let array_subset = ArraySubset::new_with_ranges(&[1..2, 0..2]);
         let mut iter = array_subset.iter_contiguous_indices(&array_shape).unwrap();
 
         assert_eq!(iter.next().unwrap(), (vec![1, 0], 2));
@@ -1112,7 +1112,7 @@ mod tests {
     #[test]
     fn test_array_subset_iterator3() {
         let array_shape = vec![2, 2];
-        let array_subset = ArraySubset::new_with_start_shape(vec![0, 0], vec![2, 2]).unwrap();
+        let array_subset = ArraySubset::new_with_shape(vec![2, 2]);
         let mut iter = array_subset.iter_contiguous_indices(&array_shape).unwrap();
 
         assert_eq!(iter.next().unwrap(), (vec![0, 0], 4));
@@ -1122,8 +1122,7 @@ mod tests {
     #[test]
     fn test_array_subset_iterator4() {
         let array_shape = vec![2, 2, 2, 3];
-        let array_subset =
-            ArraySubset::new_with_start_shape(vec![0, 0, 0, 0], vec![2, 1, 2, 3]).unwrap();
+        let array_subset = ArraySubset::new_with_shape(vec![2, 1, 2, 3]);
         let mut iter = array_subset.iter_contiguous_indices(&array_shape).unwrap();
 
         assert_eq!(iter.next().unwrap(), (vec![0, 0, 0, 0], 6));
@@ -1134,7 +1133,7 @@ mod tests {
     #[test]
     fn test_array_subset_iterator5() {
         let array_shape = vec![2, 2, 3];
-        let array_subset = ArraySubset::new_with_start_shape(vec![0, 0, 1], vec![2, 2, 2]).unwrap();
+        let array_subset = ArraySubset::new_with_ranges(&[0..2, 0..2, 1..3]);
         let mut iter = array_subset.iter_contiguous_indices(&array_shape).unwrap();
 
         assert_eq!(iter.next().unwrap(), (vec![0, 0, 1], 2));

src/array/codec/array_to_array/bitround.rs

@@ -248,8 +248,8 @@ mod tests {
 
         let encoded = codec.encode(bytes.clone(), &array_representation).unwrap();
         let decoded_regions = [
-            ArraySubset::new_with_start_shape(vec![3], vec![2]).unwrap(),
-            ArraySubset::new_with_start_shape(vec![17], vec![4]).unwrap(),
+            ArraySubset::new_with_ranges(&[3..5]),
+            ArraySubset::new_with_ranges(&[17..21]),
         ];
         let input_handle = Box::new(std::io::Cursor::new(encoded));
         let bytes_codec = BytesCodec::default();

src/array/codec/array_to_bytes/codec_chain.rs

@@ -707,8 +707,7 @@ mod tests {
         let codec = CodecChain::from_metadata(&codec_configurations).unwrap();
 
         let encoded = codec.encode(bytes, &array_representation).unwrap();
-        let decoded_regions =
-            [ArraySubset::new_with_start_shape(vec![0, 1, 0], vec![2, 1, 1]).unwrap()];
+        let decoded_regions = [ArraySubset::new_with_ranges(&[0..2, 1..2, 0..1])];
         let input_handle = Box::new(std::io::Cursor::new(encoded));
         let partial_decoder = codec
             .partial_decoder(input_handle, &array_representation)

src/array/codec/array_to_bytes/sharding.rs

@@ -270,7 +270,7 @@ mod tests {
         let codec = ShardingCodec::new_with_configuration(&codec_configuration).unwrap();
 
         let encoded = codec.encode(bytes, &array_representation).unwrap();
-        let decoded_regions = [ArraySubset::new_with_start_shape(vec![1, 0], vec![2, 1]).unwrap()];
+        let decoded_regions = [ArraySubset::new_with_ranges(&[1..3, 0..1])];
         let input_handle = Box::new(std::io::Cursor::new(encoded));
         let partial_decoder = codec
             .partial_decoder(input_handle, &array_representation)
@@ -305,8 +305,7 @@ mod tests {
         let codec = ShardingCodec::new_with_configuration(&codec_configuration).unwrap();
 
         let encoded = codec.encode(bytes, &array_representation).unwrap();
-        let decoded_regions =
-            [ArraySubset::new_with_start_shape(vec![1, 0, 0], vec![1, 2, 3]).unwrap()];
+        let decoded_regions = [ArraySubset::new_with_ranges(&[1..2, 0..2, 0..3])];
         let input_handle = Box::new(std::io::Cursor::new(encoded));
         let partial_decoder = codec
             .partial_decoder(input_handle, &array_representation)
@@ -337,7 +336,7 @@ mod tests {
         let codec = ShardingCodec::new_with_configuration(&codec_configuration).unwrap();
 
         let encoded = codec.encode(bytes, &array_representation).unwrap();
-        let decoded_regions = [ArraySubset::new_with_start_shape(vec![1, 0], vec![2, 1]).unwrap()];
+        let decoded_regions = [ArraySubset::new_with_ranges(&[1..3, 0..1])];
         let input_handle = Box::new(std::io::Cursor::new(encoded));
         let partial_decoder = codec
             .partial_decoder(input_handle, &array_representation)

src/array/codec/array_to_bytes/zfp.rs

@@ -179,10 +179,8 @@ mod tests {
 
         let encoded = codec.encode(bytes.clone(), &array_representation).unwrap();
         let decoded_regions = [
-            ArraySubset::new_with_start_shape((&[0, 0, 0]).to_vec(), (&[1, 2, 3]).to_vec())
-                .unwrap(),
-            ArraySubset::new_with_start_shape((&[0, 1, 2]).to_vec(), (&[3, 2, 1]).to_vec())
-                .unwrap(),
+            ArraySubset::new_with_shape(vec![1, 2, 3]),
+            ArraySubset::new_with_ranges(&[0..3, 1..3, 2..3]),
         ];
 
         let input_handle = Box::new(std::io::Cursor::new(encoded));

src/array/codec/bytes_to_bytes/blosc.rs

@@ -351,14 +351,12 @@ mod tests {
         let codec = BloscCodec::new_with_configuration(&codec_configuration).unwrap();
 
         let encoded = codec.encode(bytes).unwrap();
-        let decoded_regions: Vec<ByteRange> =
-            ArraySubset::new_with_start_shape(vec![0, 1, 0], vec![2, 1, 1])
-                .unwrap()
-                .byte_ranges(
-                    array_representation.shape(),
-                    array_representation.element_size(),
-                )
-                .unwrap();
+        let decoded_regions: Vec<ByteRange> = ArraySubset::new_with_ranges(&[0..2, 1..2, 0..1])
+            .byte_ranges(
+                array_representation.shape(),
+                array_representation.element_size(),
+            )
+            .unwrap();
         let input_handle = Box::new(std::io::Cursor::new(encoded));
         let partial_decoder = codec
             .partial_decoder(input_handle, &bytes_representation)