The numpy-file-format Reference Manual

This is the numpy-file-format Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 17:27:30 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

The main system appears first, followed by any subsystem dependency.


2.1 numpy-file-format

Read and write Numpy .npy and .npz files.

Author

Marco Heisig <>

License

MIT

Dependencies
  • ieee-floats (system).
  • trivial-features (system).
Source

numpy-file-format.asd.

Child Components

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.


3.1 Lisp


3.1.1 numpy-file-format/numpy-file-format.asd

Source

numpy-file-format.asd.

Parent Component

numpy-file-format (system).

ASDF Systems

numpy-file-format.


3.1.2 numpy-file-format/packages.lisp

Source

numpy-file-format.asd.

Parent Component

numpy-file-format (system).

Packages

numpy-file-format.


3.1.3 numpy-file-format/dtypes.lisp

Source

numpy-file-format.asd.

Parent Component

numpy-file-format (system).

Public Interface

print-object (method).

Internals

3.1.4 numpy-file-format/python-parser.lisp

Source

numpy-file-format.asd.

Parent Component

numpy-file-format (system).

Internals

3.1.5 numpy-file-format/load-array.lisp

Source

numpy-file-format.asd.

Parent Component

numpy-file-format (system).

Public Interface

load-array (function).

Internals

load-array-metadata (function).


3.1.6 numpy-file-format/store-array.lisp

Source

numpy-file-format.asd.

Parent Component

numpy-file-format (system).

Public Interface

store-array (function).

Internals

array-metadata-string (function).


4 Packages

Packages are listed by definition order.


4.1 numpy-file-format

Source

packages.lisp.

Use List

common-lisp.

Public Interface
Internals

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


5.1 Public Interface


5.1.1 Ordinary functions

Function: load-array (filename)
Package

numpy-file-format.

Source

load-array.lisp.

Function: store-array (array filename)
Package

numpy-file-format.

Source

store-array.lisp.


5.1.2 Standalone methods

Method: print-object ((dtype dtype) stream)
Source

dtypes.lisp.


5.2 Internals


5.2.1 Constants

Constant: +endianness+
Package

numpy-file-format.

Source

dtypes.lisp.


5.2.2 Special variables

Special Variable: *dtypes*
Package

numpy-file-format.

Source

dtypes.lisp.


5.2.3 Ordinary functions

Function: array-metadata-string (array)
Package

numpy-file-format.

Source

store-array.lisp.

Function: define-dtype (code type size &optional endianness)
Package

numpy-file-format.

Source

dtypes.lisp.

Function: define-multibyte-dtype (code type size)
Package

numpy-file-format.

Source

dtypes.lisp.

Function: dtype-from-code (code)
Package

numpy-file-format.

Source

dtypes.lisp.

Function: dtype-from-type (type)
Package

numpy-file-format.

Source

dtypes.lisp.

Function: load-array-metadata (filename)
Package

numpy-file-format.

Source

load-array.lisp.

Function: read-python-boolean (stream)
Package

numpy-file-format.

Source

python-parser.lisp.

Function: read-python-dict (stream)
Package

numpy-file-format.

Source

python-parser.lisp.

Function: read-python-integer (stream)
Package

numpy-file-format.

Source

python-parser.lisp.

Function: read-python-list (stream)
Package

numpy-file-format.

Source

python-parser.lisp.

Function: read-python-object (stream &optional skip stop)
Package

numpy-file-format.

Source

python-parser.lisp.

Function: read-python-object-from-string (string)
Package

numpy-file-format.

Source

python-parser.lisp.

Function: read-python-string (delimiter stream)
Package

numpy-file-format.

Source

python-parser.lisp.

Function: read-python-tuple (stream)
Package

numpy-file-format.

Source

python-parser.lisp.


5.2.4 Generic functions

Generic Reader: dtype-code (dtype)
Package

numpy-file-format.

Source

dtypes.lisp.

Methods
Reader Method: dtype-code ((dtype dtype))

automatically generated reader method

Target Slot

%code.

Generic Reader: dtype-endianness (dtype)
Package

numpy-file-format.

Source

dtypes.lisp.

Methods
Reader Method: dtype-endianness ((dtype dtype))

automatically generated reader method

Target Slot

%endianness.

Generic Function: dtype-name (dtype)
Package

numpy-file-format.

Source

dtypes.lisp.

Generic Reader: dtype-size (dtype)
Package

numpy-file-format.

Source

dtypes.lisp.

Methods
Reader Method: dtype-size ((dtype dtype))

automatically generated reader method

Target Slot

%size.

Generic Reader: dtype-type (dtype)
Package

numpy-file-format.

Source

dtypes.lisp.

Methods
Reader Method: dtype-type ((dtype dtype))

automatically generated reader method

Target Slot

%type.


5.2.5 Classes

Class: dtype
Package

numpy-file-format.

Source

dtypes.lisp.

Direct methods
Direct slots
Slot: %type
Initargs

:type

Readers

dtype-type.

Writers

This slot is read-only.

Slot: %code
Initargs

:code

Readers

dtype-code.

Writers

This slot is read-only.

Slot: %size
Initargs

:size

Readers

dtype-size.

Writers

This slot is read-only.

Slot: %endianness
Initargs

:endianness

Readers

dtype-endianness.

Writers

This slot is read-only.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   A   D   F   G   L   M   P   R   S  
Index Entry  Section

A
array-metadata-string: Private ordinary functions

D
define-dtype: Private ordinary functions
define-multibyte-dtype: Private ordinary functions
dtype-code: Private generic functions
dtype-code: Private generic functions
dtype-endianness: Private generic functions
dtype-endianness: Private generic functions
dtype-from-code: Private ordinary functions
dtype-from-type: Private ordinary functions
dtype-name: Private generic functions
dtype-size: Private generic functions
dtype-size: Private generic functions
dtype-type: Private generic functions
dtype-type: Private generic functions

F
Function, array-metadata-string: Private ordinary functions
Function, define-dtype: Private ordinary functions
Function, define-multibyte-dtype: Private ordinary functions
Function, dtype-from-code: Private ordinary functions
Function, dtype-from-type: Private ordinary functions
Function, load-array: Public ordinary functions
Function, load-array-metadata: Private ordinary functions
Function, read-python-boolean: Private ordinary functions
Function, read-python-dict: Private ordinary functions
Function, read-python-integer: Private ordinary functions
Function, read-python-list: Private ordinary functions
Function, read-python-object: Private ordinary functions
Function, read-python-object-from-string: Private ordinary functions
Function, read-python-string: Private ordinary functions
Function, read-python-tuple: Private ordinary functions
Function, store-array: Public ordinary functions

G
Generic Function, dtype-code: Private generic functions
Generic Function, dtype-endianness: Private generic functions
Generic Function, dtype-name: Private generic functions
Generic Function, dtype-size: Private generic functions
Generic Function, dtype-type: Private generic functions

L
load-array: Public ordinary functions
load-array-metadata: Private ordinary functions

M
Method, dtype-code: Private generic functions
Method, dtype-endianness: Private generic functions
Method, dtype-size: Private generic functions
Method, dtype-type: Private generic functions
Method, print-object: Public standalone methods

P
print-object: Public standalone methods

R
read-python-boolean: Private ordinary functions
read-python-dict: Private ordinary functions
read-python-integer: Private ordinary functions
read-python-list: Private ordinary functions
read-python-object: Private ordinary functions
read-python-object-from-string: Private ordinary functions
read-python-string: Private ordinary functions
read-python-tuple: Private ordinary functions

S
store-array: Public ordinary functions