The numpy-file-format Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The numpy-file-format Reference Manual

This is the numpy-file-format Reference Manual, generated automatically by Declt version 2.4 patchlevel 1 "Will Decker" on Mon Jul 29 16:19:51 2019 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

#+TITLE: Numpy File Format

This library allows Lisp programs to read and write arrays in the Numpy
file format.

The API is deliberately simple and consists of two functions - =load-array=
and =store-array=.


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

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


Previous: , Up: Systems   [Contents][Index]

2.1 numpy-file-format

Author

Marco Heisig <marco.heisig@fau.de>

License

MIT

Description

Read and write Numpy .npy and .npz files.

Dependency

ieee-floats

Source

numpy-file-format.asd (file)

Components

Next: , Previous: , Up: Top   [Contents][Index]

3 Files

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


Previous: , Up: Files   [Contents][Index]

3.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.1 numpy-file-format.asd

Location

numpy-file-format.asd

Systems

numpy-file-format (system)


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.2 numpy-file-format/packages.lisp

Parent

numpy-file-format (system)

Location

packages.lisp

Packages

numpy-file-format


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.3 numpy-file-format/dtypes.lisp

Parent

numpy-file-format (system)

Location

dtypes.lisp

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

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

Parent

numpy-file-format (system)

Location

python-parser.lisp

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

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

Parent

numpy-file-format (system)

Location

load-array.lisp

Exported Definitions

load-array (function)

Internal Definitions

load-array-metadata (function)


Previous: , Up: Lisp files   [Contents][Index]

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

Parent

numpy-file-format (system)

Location

store-array.lisp

Exported Definitions

store-array (function)

Internal Definitions

array-metadata-string (function)


Next: , Previous: , Up: Top   [Contents][Index]

4 Packages

Packages are listed by definition order.


Previous: , Up: Packages   [Contents][Index]

4.1 numpy-file-format

Source

packages.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Definitions

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


Next: , Previous: , Up: Definitions   [Contents][Index]

5.1 Exported definitions


Previous: , Up: Exported definitions   [Contents][Index]

5.1.1 Functions

Function: load-array FILENAME
Package

numpy-file-format

Source

load-array.lisp (file)

Function: store-array ARRAY FILENAME
Package

numpy-file-format

Source

store-array.lisp (file)


Previous: , Up: Definitions   [Contents][Index]

5.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.1 Constants

Constant: +endianness+
Package

numpy-file-format

Source

dtypes.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.2 Special variables

Special Variable: *dtypes*
Package

numpy-file-format

Source

dtypes.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.3 Functions

Function: array-metadata-string ARRAY
Package

numpy-file-format

Source

store-array.lisp (file)

Function: define-dtype CODE TYPE SIZE &optional ENDIANNESS
Package

numpy-file-format

Source

dtypes.lisp (file)

Function: define-multibyte-dtype CODE TYPE SIZE
Package

numpy-file-format

Source

dtypes.lisp (file)

Function: dtype-from-code CODE
Package

numpy-file-format

Source

dtypes.lisp (file)

Function: dtype-from-type TYPE
Package

numpy-file-format

Source

dtypes.lisp (file)

Function: load-array-metadata FILENAME
Package

numpy-file-format

Source

load-array.lisp (file)

Function: read-python-boolean STREAM
Package

numpy-file-format

Source

python-parser.lisp (file)

Function: read-python-dict STREAM
Package

numpy-file-format

Source

python-parser.lisp (file)

Function: read-python-integer STREAM
Package

numpy-file-format

Source

python-parser.lisp (file)

Function: read-python-list STREAM
Package

numpy-file-format

Source

python-parser.lisp (file)

Function: read-python-object STREAM &optional SKIP STOP
Package

numpy-file-format

Source

python-parser.lisp (file)

Function: read-python-object-from-string STRING
Package

numpy-file-format

Source

python-parser.lisp (file)

Function: read-python-string DELIMITER STREAM
Package

numpy-file-format

Source

python-parser.lisp (file)

Function: read-python-tuple STREAM
Package

numpy-file-format

Source

python-parser.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.4 Generic functions

Generic Function: dtype-code DTYPE
Package

numpy-file-format

Source

dtypes.lisp (file)

Methods
Method: dtype-code (DTYPE dtype)

automatically generated reader method

Generic Function: dtype-endianness DTYPE
Package

numpy-file-format

Source

dtypes.lisp (file)

Methods
Method: dtype-endianness (DTYPE dtype)

automatically generated reader method

Generic Function: dtype-name DTYPE
Package

numpy-file-format

Source

dtypes.lisp (file)

Generic Function: dtype-size DTYPE
Package

numpy-file-format

Source

dtypes.lisp (file)

Methods
Method: dtype-size (DTYPE dtype)

automatically generated reader method

Generic Function: dtype-type DTYPE
Package

numpy-file-format

Source

dtypes.lisp (file)

Methods
Method: dtype-type (DTYPE dtype)

automatically generated reader method


Previous: , Up: Internal definitions   [Contents][Index]

5.2.5 Classes

Class: dtype ()
Package

numpy-file-format

Source

dtypes.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: %type
Initargs

:type

Readers

dtype-type (generic function)

Slot: %code
Initargs

:code

Readers

dtype-code (generic function)

Slot: %size
Initargs

:size

Readers

dtype-size (generic function)

Slot: %endianness
Initargs

:endianness

Readers

dtype-endianness (generic function)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   F   L   N  
Index Entry  Section

F
File, Lisp, numpy-file-format.asd: The numpy-file-format<dot>asd file
File, Lisp, numpy-file-format/dtypes.lisp: The numpy-file-format/dtypes<dot>lisp file
File, Lisp, numpy-file-format/load-array.lisp: The numpy-file-format/load-array<dot>lisp file
File, Lisp, numpy-file-format/packages.lisp: The numpy-file-format/packages<dot>lisp file
File, Lisp, numpy-file-format/python-parser.lisp: The numpy-file-format/python-parser<dot>lisp file
File, Lisp, numpy-file-format/store-array.lisp: The numpy-file-format/store-array<dot>lisp file

L
Lisp File, numpy-file-format.asd: The numpy-file-format<dot>asd file
Lisp File, numpy-file-format/dtypes.lisp: The numpy-file-format/dtypes<dot>lisp file
Lisp File, numpy-file-format/load-array.lisp: The numpy-file-format/load-array<dot>lisp file
Lisp File, numpy-file-format/packages.lisp: The numpy-file-format/packages<dot>lisp file
Lisp File, numpy-file-format/python-parser.lisp: The numpy-file-format/python-parser<dot>lisp file
Lisp File, numpy-file-format/store-array.lisp: The numpy-file-format/store-array<dot>lisp file

N
numpy-file-format.asd: The numpy-file-format<dot>asd file
numpy-file-format/dtypes.lisp: The numpy-file-format/dtypes<dot>lisp file
numpy-file-format/load-array.lisp: The numpy-file-format/load-array<dot>lisp file
numpy-file-format/packages.lisp: The numpy-file-format/packages<dot>lisp file
numpy-file-format/python-parser.lisp: The numpy-file-format/python-parser<dot>lisp file
numpy-file-format/store-array.lisp: The numpy-file-format/store-array<dot>lisp file

Jump to:   F   L   N  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

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

A
array-metadata-string: Internal functions

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

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

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

L
load-array: Exported functions
load-array-metadata: Internal functions

M
Method, dtype-code: Internal generic functions
Method, dtype-endianness: Internal generic functions
Method, dtype-size: Internal generic functions
Method, dtype-type: Internal generic functions

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

S
store-array: Exported functions

Jump to:   A   D   F   G   L   M   R   S  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   %   *   +  
C   S  
Index Entry  Section

%
%code: Internal classes
%endianness: Internal classes
%size: Internal classes
%type: Internal classes

*
*dtypes*: Internal special variables

+
+endianness+: Internal constants

C
Constant, +endianness+: Internal constants

S
Slot, %code: Internal classes
Slot, %endianness: Internal classes
Slot, %size: Internal classes
Slot, %type: Internal classes
Special Variable, *dtypes*: Internal special variables

Jump to:   %   *   +  
C   S  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   C   D   N   P   S  
Index Entry  Section

C
Class, dtype: Internal classes

D
dtype: Internal classes

N
numpy-file-format: The numpy-file-format system
numpy-file-format: The numpy-file-format package

P
Package, numpy-file-format: The numpy-file-format package

S
System, numpy-file-format: The numpy-file-format system

Jump to:   C   D   N   P   S