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 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353
use rayon::iter::{IntoParallelIterator, ParallelIterator};
use crate::{array::ArrayBytes, array_subset::ArraySubset, storage::ReadableWritableStorageTraits};
use super::{
array_bytes::update_array_bytes, codec::options::CodecOptions,
concurrency::concurrency_chunks_and_codec, Array, ArrayError, Element,
};
impl<TStorage: ?Sized + ReadableWritableStorageTraits + 'static> Array<TStorage> {
/// Encode `chunk_subset_bytes` and store in `chunk_subset` of the chunk at `chunk_indices` with default codec options.
///
/// Use [`store_chunk_subset_opt`](Array::store_chunk_subset_opt) to control codec options.
/// Prefer to use [`store_chunk`](Array::store_chunk) where possible, since this function may decode the chunk before updating it and reencoding it.
///
/// # Errors
/// Returns an [`ArrayError`] if
/// - `chunk_subset` is invalid or out of bounds of the chunk,
/// - there is a codec encoding error, or
/// - an underlying store error.
///
/// # Panics
/// Panics if attempting to reference a byte beyond `usize::MAX`.
#[allow(clippy::missing_errors_doc, clippy::missing_panics_doc)]
pub fn store_chunk_subset<'a>(
&self,
chunk_indices: &[u64],
chunk_subset: &ArraySubset,
chunk_subset_bytes: impl Into<ArrayBytes<'a>>,
) -> Result<(), ArrayError> {
self.store_chunk_subset_opt(
chunk_indices,
chunk_subset,
chunk_subset_bytes,
&CodecOptions::default(),
)
}
/// Encode `chunk_subset_elements` and store in `chunk_subset` of the chunk at `chunk_indices` with default codec options.
///
/// Use [`store_chunk_subset_elements_opt`](Array::store_chunk_subset_elements_opt) to control codec options.
/// Prefer to use [`store_chunk_elements`](Array::store_chunk_elements) where possible, since this will decode the chunk before updating it and reencoding it.
///
/// # Errors
/// Returns an [`ArrayError`] if
/// - the size of `T` does not match the data type size, or
/// - a [`store_chunk_subset`](Array::store_chunk_subset) error condition is met.
#[allow(clippy::missing_errors_doc, clippy::missing_panics_doc)]
pub fn store_chunk_subset_elements<T: Element>(
&self,
chunk_indices: &[u64],
chunk_subset: &ArraySubset,
chunk_subset_elements: &[T],
) -> Result<(), ArrayError> {
self.store_chunk_subset_elements_opt(
chunk_indices,
chunk_subset,
chunk_subset_elements,
&CodecOptions::default(),
)
}
#[cfg(feature = "ndarray")]
/// Encode `chunk_subset_array` and store in `chunk_subset` of the chunk in the subset starting at `chunk_subset_start`.
///
/// Use [`store_chunk_subset_ndarray_opt`](Array::store_chunk_subset_ndarray_opt) to control codec options.
/// Prefer to use [`store_chunk_ndarray`](Array::store_chunk_ndarray) where possible, since this will decode the chunk before updating it and reencoding it.
///
/// # Errors
/// Returns an [`ArrayError`] if a [`store_chunk_subset_elements`](Array::store_chunk_subset_elements) error condition is met.
pub fn store_chunk_subset_ndarray<T: Element, D: ndarray::Dimension>(
&self,
chunk_indices: &[u64],
chunk_subset_start: &[u64],
chunk_subset_array: impl Into<ndarray::Array<T, D>>,
) -> Result<(), ArrayError> {
self.store_chunk_subset_ndarray_opt(
chunk_indices,
chunk_subset_start,
chunk_subset_array,
&CodecOptions::default(),
)
}
/// Encode `subset_bytes` and store in `array_subset`.
///
/// Use [`store_array_subset_opt`](Array::store_array_subset_opt) to control codec options.
/// Prefer to use [`store_chunk`](Array::store_chunk) or [`store_chunks`](Array::store_chunks) where possible, since this will decode and encode each chunk intersecting `array_subset`.
///
/// # Errors
/// Returns an [`ArrayError`] if
/// - the dimensionality of `array_subset` does not match the chunk grid dimensionality
/// - the length of `subset_bytes` does not match the expected length governed by the shape of the array subset and the data type size,
/// - there is a codec encoding error, or
/// - an underlying store error.
#[allow(clippy::missing_errors_doc, clippy::missing_panics_doc)]
pub fn store_array_subset<'a>(
&self,
array_subset: &ArraySubset,
subset_bytes: impl Into<ArrayBytes<'a>>,
) -> Result<(), ArrayError> {
self.store_array_subset_opt(array_subset, subset_bytes, &CodecOptions::default())
}
/// Encode `subset_elements` and store in `array_subset`.
///
/// Use [`store_array_subset_elements_opt`](Array::store_array_subset_elements_opt) to control codec options.
/// Prefer to use [`store_chunk_elements`](Array::store_chunk_elements) or [`store_chunks_elements`](Array::store_chunks_elements) where possible, since this will decode and encode each chunk intersecting `array_subset`.
///
/// # Errors
/// Returns an [`ArrayError`] if
/// - the size of `T` does not match the data type size, or
/// - a [`store_array_subset`](Array::store_array_subset) error condition is met.
#[allow(clippy::missing_errors_doc, clippy::missing_panics_doc)]
pub fn store_array_subset_elements<T: Element>(
&self,
array_subset: &ArraySubset,
subset_elements: &[T],
) -> Result<(), ArrayError> {
self.store_array_subset_elements_opt(
array_subset,
subset_elements,
&CodecOptions::default(),
)
}
#[cfg(feature = "ndarray")]
/// Encode `subset_array` and store in the array subset starting at `subset_start`.
///
/// Use [`store_array_subset_ndarray_opt`](Array::store_array_subset_ndarray_opt) to control codec options.
/// Prefer to use [`store_chunk_ndarray`](Array::store_chunk_ndarray) or [`store_chunks_ndarray`](Array::store_chunks_ndarray) where possible, since this will decode and encode each chunk intersecting `array_subset`.
///
/// # Errors
/// Returns an [`ArrayError`] if a [`store_array_subset_elements`](Array::store_array_subset_elements) error condition is met.
#[allow(clippy::missing_errors_doc, clippy::missing_panics_doc)]
pub fn store_array_subset_ndarray<T: Element, D: ndarray::Dimension>(
&self,
subset_start: &[u64],
subset_array: impl Into<ndarray::Array<T, D>>,
) -> Result<(), ArrayError> {
self.store_array_subset_ndarray_opt(subset_start, subset_array, &CodecOptions::default())
}
/////////////////////////////////////////////////////////////////////////////
// Advanced methods
/////////////////////////////////////////////////////////////////////////////
/// Explicit options version of [`store_chunk_subset`](Array::store_chunk_subset).
#[allow(clippy::missing_errors_doc, clippy::missing_panics_doc)]
pub fn store_chunk_subset_opt<'a>(
&self,
chunk_indices: &[u64],
chunk_subset: &ArraySubset,
chunk_subset_bytes: impl Into<ArrayBytes<'a>>,
options: &CodecOptions,
) -> Result<(), ArrayError> {
let chunk_shape = self
.chunk_grid()
.chunk_shape_u64(chunk_indices, self.shape())?
.ok_or_else(|| ArrayError::InvalidChunkGridIndicesError(chunk_indices.to_vec()))?;
if std::iter::zip(chunk_subset.end_exc(), &chunk_shape)
.any(|(end_exc, shape)| end_exc > *shape)
{
return Err(ArrayError::InvalidChunkSubset(
chunk_subset.clone(),
chunk_indices.to_vec(),
chunk_shape,
));
}
if chunk_subset.shape() == chunk_shape && chunk_subset.start().iter().all(|&x| x == 0) {
// The subset spans the whole chunk, so store the bytes directly and skip decoding
self.store_chunk_opt(chunk_indices, chunk_subset_bytes, options)
} else {
let chunk_subset_bytes = chunk_subset_bytes.into();
chunk_subset_bytes.validate(chunk_subset.num_elements(), self.data_type().size())?;
// Lock the chunk
// let key = self.chunk_key(chunk_indices);
// let mutex = self.storage.mutex(&key)?;
// let _lock = mutex.lock();
// Decode the entire chunk
let chunk_bytes_old = self.retrieve_chunk_opt(chunk_indices, options)?;
chunk_bytes_old.validate(chunk_shape.iter().product(), self.data_type().size())?;
// Update the chunk
let chunk_bytes_new = update_array_bytes(
chunk_bytes_old,
chunk_shape,
chunk_subset_bytes,
chunk_subset,
self.data_type().size(),
);
// Store the updated chunk
self.store_chunk_opt(chunk_indices, chunk_bytes_new, options)
}
}
/// Explicit options version of [`store_chunk_subset_elements`](Array::store_chunk_subset_elements).
#[allow(clippy::missing_errors_doc, clippy::missing_panics_doc)]
pub fn store_chunk_subset_elements_opt<T: Element>(
&self,
chunk_indices: &[u64],
chunk_subset: &ArraySubset,
chunk_subset_elements: &[T],
options: &CodecOptions,
) -> Result<(), ArrayError> {
let chunk_subset_bytes = T::into_array_bytes(self.data_type(), chunk_subset_elements)?;
self.store_chunk_subset_opt(chunk_indices, chunk_subset, chunk_subset_bytes, options)
}
#[cfg(feature = "ndarray")]
/// Explicit options version of [`store_chunk_subset_ndarray`](Array::store_chunk_subset_ndarray).
#[allow(clippy::missing_errors_doc, clippy::missing_panics_doc)]
pub fn store_chunk_subset_ndarray_opt<T: Element, D: ndarray::Dimension>(
&self,
chunk_indices: &[u64],
chunk_subset_start: &[u64],
chunk_subset_array: impl Into<ndarray::Array<T, D>>,
options: &CodecOptions,
) -> Result<(), ArrayError> {
let chunk_subset_array: ndarray::Array<T, D> = chunk_subset_array.into();
let subset = ArraySubset::new_with_start_shape(
chunk_subset_start.to_vec(),
chunk_subset_array
.shape()
.iter()
.map(|u| *u as u64)
.collect(),
)?;
let chunk_subset_array = super::ndarray_into_vec(chunk_subset_array);
self.store_chunk_subset_elements_opt(chunk_indices, &subset, &chunk_subset_array, options)
}
/// Explicit options version of [`store_array_subset`](Array::store_array_subset).
#[allow(clippy::missing_errors_doc, clippy::missing_panics_doc)]
#[allow(clippy::too_many_lines)]
pub fn store_array_subset_opt<'a>(
&self,
array_subset: &ArraySubset,
subset_bytes: impl Into<ArrayBytes<'a>>,
options: &CodecOptions,
) -> Result<(), ArrayError> {
// Validation
if array_subset.dimensionality() != self.shape().len() {
return Err(ArrayError::InvalidArraySubset(
array_subset.clone(),
self.shape().to_vec(),
));
}
// Find the chunks intersecting this array subset
let chunks = self.chunks_in_array_subset(array_subset)?;
let Some(chunks) = chunks else {
return Err(ArrayError::InvalidArraySubset(
array_subset.clone(),
self.shape().to_vec(),
));
};
let num_chunks = chunks.num_elements_usize();
if num_chunks == 1 {
let chunk_indices = chunks.start();
let chunk_subset = self.chunk_subset(chunk_indices)?;
if array_subset == &chunk_subset {
// A fast path if the array subset matches the chunk subset
// This skips the internal decoding occurring in store_chunk_subset
self.store_chunk_opt(chunk_indices, subset_bytes, options)?;
} else {
// Store the chunk subset
self.store_chunk_subset_opt(
chunk_indices,
&array_subset.relative_to(chunk_subset.start())?,
subset_bytes,
options,
)?;
}
} else {
let subset_bytes = subset_bytes.into();
subset_bytes.validate(array_subset.num_elements(), self.data_type().size())?;
// Calculate chunk/codec concurrency
let chunk_representation =
self.chunk_array_representation(&vec![0; self.dimensionality()])?;
let codec_concurrency = self.recommended_codec_concurrency(&chunk_representation)?;
let (chunk_concurrent_limit, options) = concurrency_chunks_and_codec(
options.concurrent_target(),
num_chunks,
options,
&codec_concurrency,
);
let store_chunk = |chunk_indices: Vec<u64>| -> Result<(), ArrayError> {
let chunk_subset_in_array = self.chunk_subset(&chunk_indices)?;
let overlap = unsafe { array_subset.overlap_unchecked(&chunk_subset_in_array) };
let chunk_subset_in_array_subset =
unsafe { overlap.relative_to_unchecked(array_subset.start()) };
let chunk_subset_bytes = subset_bytes.extract_array_subset(
&chunk_subset_in_array_subset,
array_subset.shape(),
self.data_type(),
)?;
let array_subset_in_chunk_subset =
unsafe { overlap.relative_to_unchecked(chunk_subset_in_array.start()) };
self.store_chunk_subset_opt(
&chunk_indices,
&array_subset_in_chunk_subset,
chunk_subset_bytes,
&options,
)
};
let indices = chunks.indices();
rayon_iter_concurrent_limit::iter_concurrent_limit!(
chunk_concurrent_limit,
indices,
try_for_each,
store_chunk
)?;
}
Ok(())
}
/// Explicit options version of [`store_array_subset_elements`](Array::store_array_subset_elements).
#[allow(clippy::missing_errors_doc, clippy::missing_panics_doc)]
pub fn store_array_subset_elements_opt<T: Element>(
&self,
array_subset: &ArraySubset,
subset_elements: &[T],
options: &CodecOptions,
) -> Result<(), ArrayError> {
let subset_bytes = T::into_array_bytes(self.data_type(), subset_elements)?;
self.store_array_subset_opt(array_subset, subset_bytes, options)
}
#[cfg(feature = "ndarray")]
/// Explicit options version of [`store_array_subset_ndarray`](Array::store_array_subset_ndarray).
#[allow(clippy::missing_errors_doc, clippy::missing_panics_doc)]
pub fn store_array_subset_ndarray_opt<T: Element, D: ndarray::Dimension>(
&self,
subset_start: &[u64],
subset_array: impl Into<ndarray::Array<T, D>>,
options: &CodecOptions,
) -> Result<(), ArrayError> {
let subset_array: ndarray::Array<T, D> = subset_array.into();
let subset = ArraySubset::new_with_start_shape(
subset_start.to_vec(),
subset_array.shape().iter().map(|u| *u as u64).collect(),
)?;
let subset_array = super::ndarray_into_vec(subset_array);
self.store_array_subset_elements_opt(&subset, &subset_array, options)
}
}