Skip to content

Introduce new Layout type for clarity #96

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jturner314 merged 1 commit into from
Dec 8, 2025
Merged

Introduce new Layout type for clarity #96

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 33 additions & 10 deletions src/npy/header.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -316,10 +316,26 @@ impl From<FormatHeaderError> for WriteHeaderError {
}
}

#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
pub enum Layout {
/// Standard layout (C order).
Standard,
/// Fortran layout.
Fortran,
}

impl Layout {
/// Returns `true` if the layout is [`Fortran`](Self::Fortran).
#[inline]
pub fn is_fortran(&self) -> bool {
matches!(*self, Layout::Fortran)
}
}

#[derive(Clone, Debug)]
pub struct Header {
pub type_descriptor: PyValue,
pub fortran_order: bool,
pub layout: Layout,
pub shape: Vec<usize>,
}

Expand All @@ -333,7 +349,7 @@ impl Header {
fn from_py_value(value: PyValue) -> Result<Self, ParseHeaderError> {
if let PyValue::Dict(dict) = value {
let mut type_descriptor: Option<PyValue> = None;
let mut fortran_order: Option<bool> = None;
let mut is_fortran: Option<bool> = None;
let mut shape: Option<Vec<usize>> = None;
for (key, value) in dict {
match key {
Expand All @@ -342,7 +358,7 @@ impl Header {
}
PyValue::String(ref k) if k == "fortran_order" => {
if let PyValue::Boolean(b) = value {
fortran_order = Some(b);
is_fortran = Some(b);
} else {
return Err(ParseHeaderError::IllegalValue {
key: "fortran_order".to_owned(),
Expand Down Expand Up @@ -370,12 +386,19 @@ impl Header {
k => return Err(ParseHeaderError::UnknownKey(k)),
}
}
match (type_descriptor, fortran_order, shape) {
(Some(type_descriptor), Some(fortran_order), Some(shape)) => Ok(Header {
type_descriptor,
fortran_order,
shape,
}),
match (type_descriptor, is_fortran, shape) {
(Some(type_descriptor), Some(is_fortran), Some(shape)) => {
let layout = if is_fortran {
Layout::Fortran
} else {
Layout::Standard
};
Ok(Header {
type_descriptor,
layout,
shape,
})
}
(None, _, _) => Err(ParseHeaderError::MissingKey("descr".to_owned())),
(_, None, _) => Err(ParseHeaderError::MissingKey("fortran_order".to_owned())),
(_, _, None) => Err(ParseHeaderError::MissingKey("shaper".to_owned())),
Expand Down Expand Up @@ -433,7 +456,7 @@ impl Header {
),
(
PyValue::String("fortran_order".into()),
PyValue::Boolean(self.fortran_order),
PyValue::Boolean(self.layout.is_fortran()),
),
(
PyValue::String("shape".into()),
Expand Down
20 changes: 10 additions & 10 deletions src/npy/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ mod elements;
pub mod header;

use self::header::{
FormatHeaderError, Header, ParseHeaderError, ReadHeaderError, WriteHeaderError,
FormatHeaderError, Header, Layout, ParseHeaderError, ReadHeaderError, WriteHeaderError,
};
use ndarray::prelude::*;
use ndarray::{Data, DataOwned, IntoDimension};
Expand Down Expand Up @@ -170,7 +170,7 @@ where
.expect("overflow converting length of data to u64");
Header {
type_descriptor: A::type_descriptor(),
fortran_order: false,
layout: Layout::Standard,
shape: dim.as_array_view().to_vec(),
}
.write(file)?;
Expand Down Expand Up @@ -329,10 +329,10 @@ where
D: Dimension,
{
fn write_npy<W: io::Write>(&self, mut writer: W) -> Result<(), WriteNpyError> {
let write_contiguous = |mut writer: W, fortran_order: bool| {
let write_contiguous = |mut writer: W, layout: Layout| {
Header {
type_descriptor: A::type_descriptor(),
fortran_order,
layout,
shape: self.shape().to_owned(),
}
.write(&mut writer)?;
Expand All @@ -341,13 +341,13 @@ where
Ok(())
};
if self.is_standard_layout() {
write_contiguous(writer, false)
write_contiguous(writer, Layout::Standard)
} else if self.view().reversed_axes().is_standard_layout() {
write_contiguous(writer, true)
write_contiguous(writer, Layout::Fortran)
} else {
Header {
type_descriptor: A::type_descriptor(),
fortran_order: false,
layout: Layout::Standard,
shape: self.shape().to_owned(),
}
.write(&mut writer)?;
Expand Down Expand Up @@ -577,7 +577,7 @@ where
let ndim = shape.ndim();
let len = shape_length_checked::<A>(&shape).ok_or(ReadNpyError::LengthOverflow)?;
let data = A::read_to_end_exact_vec(&mut reader, &header.type_descriptor, len)?;
ArrayBase::from_shape_vec(shape.set_f(header.fortran_order), data)
ArrayBase::from_shape_vec(shape.set_f(header.layout.is_fortran()), data)
.unwrap()
.into_dimensionality()
.map_err(|_| ReadNpyError::WrongNdim(D::NDIM, ndim))
Expand Down Expand Up @@ -821,7 +821,7 @@ where
let ndim = shape.ndim();
let len = shape_length_checked::<A>(&shape).ok_or(ViewNpyError::LengthOverflow)?;
let data = A::bytes_as_slice(reader, &header.type_descriptor, len)?;
ArrayView::from_shape(shape.set_f(header.fortran_order), data)
ArrayView::from_shape(shape.set_f(header.layout.is_fortran()), data)
.unwrap()
.into_dimensionality()
.map_err(|_| ViewNpyError::WrongNdim(D::NDIM, ndim))
Expand All @@ -841,7 +841,7 @@ where
let len = shape_length_checked::<A>(&shape).ok_or(ViewNpyError::LengthOverflow)?;
let mid = buf.len() - reader.len();
let data = A::bytes_as_mut_slice(&mut buf[mid..], &header.type_descriptor, len)?;
ArrayViewMut::from_shape(shape.set_f(header.fortran_order), data)
ArrayViewMut::from_shape(shape.set_f(header.layout.is_fortran()), data)
.unwrap()
.into_dimensionality()
.map_err(|_| ViewNpyError::WrongNdim(D::NDIM, ndim))
Expand Down