Crate ndarray_npy[−][src]
Expand description
This crate provides methods to read/write ndarray
’s
ArrayBase
type from/to .npy
and .npz
files.
See the repository for information about the default features and how to use this crate with Cargo.
.npy Files
- Reading
ReadNpyExt
extension traitread_npy
convenience function
- Writing
WriteNpyExt
extension traitwrite_npy
convenience functionwrite_zeroed_npy
to write an.npy
file (sparse if possible) of zeroed data
- Readonly viewing (primarily for use with memory-mapped files)
ViewNpyExt
extension trait
- Mutable viewing (primarily for use with memory-mapped files)
ViewMutNpyExt
extension trait
It’s possible to create .npy
files larger than the available memory with
write_zeroed_npy
and then modify them by memory-mapping and using
ViewMutNpyExt
.
.npz Files
Limitations
-
Parsing of
.npy
files is currently limited to files where thedescr
field of the header dictionary is a Python string literal of the form'string'
,"string"
,'''string'''
, or"""string"""
. -
The element traits (
WritableElement
,ReadableElement
,ViewElement
, andViewMutElement
) are currently implemented only for fixed-size integers up to 64 bits, floating point numbers, complex floating point numbers (if enabled with the crate feature), andbool
.
The plan is to add support for more element types (including custom user-defined structs) in the future.
Structs
Enums
An error reading array data.
An error reading a .npy
file.
An error reading a .npz
file.
An error viewing array data.
An error viewing a .npy
file.
An error writing array data.
An error writing a .npy
file.
An error writing a .npz
file.
Traits
Extension trait for reading Array
from .npy
files.
An array element type that can be read from an .npy
or .npz
file.
An array element type that can be viewed (without copying) in an .npy
file.
An array element type that can be mutably viewed (without copying) in an
.npy
file.
Extension trait for creating an ArrayViewMut
from a mutable buffer
containing an .npy
file.
Extension trait for creating an ArrayView
from a buffer containing an
.npy
file.
An array element type that can be written to an .npy
or .npz
file.
Extension trait for writing ArrayBase
to .npy
files.
Functions
Read an .npy
file located at the specified path.
Writes an array to an .npy
file at the specified path.
Writes an .npy
file (sparse if possible) with bitwise-zero-filled data.