Struct matfile::Array

pub struct Array { /* fields omitted */ }

A numeric array (the only type supported at the moment).

You can access the arrays of a MatFile either by name or by iterating through all of them:

if let Some(array_a) = mat_file.find_by_name("A") {
    println!("Array \"A\": {:#?}", array_a);
}
 
for array in mat_file.arrays() {
    println!("Found array named {} of size {:?}", array.name(), array.size());
}

Methods

impl Array

pub fn name(&self) -> &str

The name of this array.

pub fn size(&self) -> &Vec<usize>

The size of this array.

The number of entries in this vector is equal to the number of dimensions of this array. Each array has at least two dimensions. For two-dimensional arrays the first dimension is the number of rows while the second dimension is the number of columns.

pub fn ndims(&self) -> usize

The number of dimensions of this array. Is at least two.

pub fn data(&self) -> &NumericData

The actual numerical data stored in this array.

if let matfile::NumericData::Double { real: real, imag: _ } = array.data() {
    println!("Real part of the data: {:?}", real);
}

For a more convenient access to the data, consider using the matfile-ndarray crate.

Trait Implementations

impl Clone for Array

fn clone(&self) -> Array

Returns a copy of the value.

default fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Array

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

Formats the value using the given formatter.