Struct OutOfCoreArray 

pub struct OutOfCoreArray<A, D>
where
    A: Clone + Serialize + for<'de> Deserialize<'de>,
    D: Dimension + Serialize + for<'de> Deserialize<'de>,
{
    pub shape: Vec<usize>,
    pub file_path: PathBuf,
    pub strategy: ChunkingStrategy,
    pub size: usize,
    /* private fields */
}

An array that stores data on disk to reduce memory usage

Fields

shape: Vec<usize>

The shape of the array

file_path: PathBuf

The path to the file containing the data

strategy: ChunkingStrategy

The chunking strategy used for reading/writing

size: usize

The total number of elements

Implementations

impl<A, D> OutOfCoreArray<A, D>

where A: Clone + Serialize + for<'de> Deserialize<'de>, D: Dimension + Serialize + for<'de> Deserialize<'de>,

pub fn new<S>( data: &ArrayBase<S, D>, file_path: &Path, strategy: ChunkingStrategy, ) -> Result<Self, CoreError>

where S: Data<Elem = A>,

Create a new out-of-core array with the given data and file path

pub fn new_temp<S>( data: &ArrayBase<S, D>, strategy: ChunkingStrategy, ) -> Result<Self, CoreError>

where S: Data<Elem = A>,

Create a new out-of-core array with a temporary file

pub fn load(&self) -> Result<Array<A, D>, CoreError>

Load the entire array into memory

pub fn load_chunk(&self, chunkindex: usize) -> Result<Array<A, D>, CoreError>

Load a chunk of the array into memory

pub fn num_chunks(&self) -> usize

Get the number of chunks

pub fn is_temp(&self) -> bool

Check if the array is temporary

pub fn map<F, B, R>(&self, f: F) -> Result<R, CoreError>

where F: FnMut(Array<A, D>) -> B, R: FromIterator<B>,

Apply a function to each chunk of the array

pub fn par_map<F, B, R>(&self, f: F) -> Result<R, CoreError>

where F: Fn(Array<A, D>) -> B + Send + Sync, B: Send, R: FromIterator<B> + Send, A: Send + Sync,

Apply a function to each chunk of the array in parallel

Trait Implementations

impl<A, D> Debug for OutOfCoreArray<A, D>

where A: Clone + Serialize + for<'de> Deserialize<'de> + Debug, D: Dimension + Serialize + for<'de> Deserialize<'de> + Debug,

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<A, D> Drop for OutOfCoreArray<A, D>

where A: Clone + Serialize + for<'de> Deserialize<'de>, D: Dimension + Serialize + for<'de> Deserialize<'de>,

fn drop(&mut self)

Executes the destructor for this type.