The sb-vector-io Reference Manual

Table of Contents

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

The sb-vector-io Reference Manual

This is the sb-vector-io Reference Manual, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 12:32:52 2018 GMT+0.


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

1 Introduction

Writing and reading raw vector data in SBCL.

Works with vectors -- both non-simple and simple, if the element type
of the vector is such that it conforms to "normal" way of representing
such data on the platform. Endianness is unspecified, floating points
use the IEEE format.

NOTE: The package nickname VECTOR-IO is deprecated, and will be deleted.


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 sb-vector-io

Author

Nikodemus Siivola <nikodemus@sb-studio.net>

License

0-clause MIT

Description

Raw vector IO for SBCL.

Source

sb-vector-io.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 sb-vector-io.asd

Location

sb-vector-io.asd

Systems

sb-vector-io (system)


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

3.1.2 sb-vector-io/package.lisp

Parent

sb-vector-io (system)

Location

package.lisp

Packages
Exported Definitions
Internal Definitions

*notified* (special variable)


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

3.1.3 sb-vector-io/vector-io.lisp

Dependency

package.lisp (file)

Parent

sb-vector-io (system)

Location

vector-io.lisp

Exported Definitions
Internal Definitions

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

4 Packages

Packages are listed by definition order.


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

4.1 vector-io

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

*notified* (special variable)


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

4.2 sb-vector-io

Source

package.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


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

5.1.1 Compiler macros

Compiler Macro: read-vector-data &rest ARGS
Package

vector-io

Source

package.lisp (file)

Compiler Macro: write-vector-data &rest ARGS
Package

vector-io

Source

package.lisp (file)


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

5.1.2 Generic functions

Generic Function: read-vector-data VECTOR STREAM &key START END
Package

vector-io

Source

package.lisp (file)

Methods
Method: read-vector-data VECTOR STREAM &key START END
Generic Function: read-vector-data VECTOR STREAM &key START END

Destructively modifies VECTOR by replacing elements of the subsequence bounded by START and AND with raw data from STREAM.

VECTOR must have ARRAY-ELEMENT-TYPE of DOUBLE-FLOAT, SINGLE-FLOAT, (UNSIGNED-BYTE X), or (SIGNED-BYTE X). Floating point values are
read using the IEEE formats, and SIGNED-BYTE and UNSIGNED-BYTE values
are read as raw bytes using the native endianness of the host
platform. FIXNUMs are read in the implementation internal
representation.

Primary return value is the number of elements read.

If element type of VECTOR is other than (UNSIGNED-BYTE 8) or (SIGNED-BYTE 8), and END-OF-FILE occurs before all the requested elements have been read, the last element read may be incomplete. In such a case the secondary return value is the number of bytes missing from the last element – NIL if the last element is complete.

Package

sb-vector-io

Source

vector-io.lisp (file)

Methods
Method: read-vector-data (VECTOR vector) (STREAM ansi-stream) &key START END
Generic Function: write-vector-data VECTOR STREAM &key START END
Package

vector-io

Source

package.lisp (file)

Methods
Method: write-vector-data VECTOR STREAM &key START END
Generic Function: write-vector-data VECTOR STREAM &key START END

Writes elements of the subsequence of VECTOR bounded by START and END to STREAM.

VECTOR must have ARRAY-ELEMENT-TYPE of FIXNUM, DOUBLE-FLOAT, SINGLE-FLOAT, (UNSIGNED-BYTE X), or (SIGNED-BYTE X). Floating point values are written using the IEEE formats, and SIGNED-BYTE and UNSIGNED-BYTE values are written as raw bytes using the native endianness of the host platform. FIXNUMs are written in the implementation internal representation.

STREAM must be a binary output stream.

Returns the number of elements written.

Package

sb-vector-io

Source

vector-io.lisp (file)

Methods
Method: write-vector-data (VECTOR vector) (STREAM ansi-stream) &key START END

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

5.2 Internal definitions


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

5.2.1 Special variables

Special Variable: *notified*
Package

vector-io

Source

package.lisp (file)


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

5.2.2 Functions

Function: check-stream-element-type STREAM CONTEXT
Package

sb-vector-io

Source

vector-io.lisp (file)

Function: vector-element-bytes VECTOR
Package

sb-vector-io

Source

vector-io.lisp (file)

Function: wait-for-vector-write STREAM FD DATA START BYTES
Package

sb-vector-io

Source

vector-io.lisp (file)


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

5.2.3 Generic functions

Generic Function: stream-fd STREAM DIRECTION

Returns the underlying file-descriptor of STREAM in DIRECTION. DIRECTION must be either :INPUT or :OUTPUT.

Package

sb-vector-io

Source

vector-io.lisp (file)

Methods
Method: stream-fd (STREAM fd-stream) DIRECTION
Method: stream-fd (STREAM synonym-stream) DIRECTION
Method: stream-fd (STREAM two-way-stream) DIRECTION
Generic Function: stream-timeout STREAM DIRECTION

Returns the underlying timeout of STREAM in DIRECTION. DIRECTION must be either :INPUT or :OUTPUT.

Package

sb-vector-io

Source

vector-io.lisp (file)

Methods
Method: stream-timeout (STREAM fd-stream) DIRECTION
Method: stream-timeout (STREAM synonym-stream) DIRECTION
Method: stream-timeout (STREAM two-way-stream) DIRECTION

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

Appendix A Indexes


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

A.1 Concepts

Jump to:   F   L   S  
Index Entry  Section

F
File, Lisp, sb-vector-io.asd: The sb-vector-io<dot>asd file
File, Lisp, sb-vector-io/package.lisp: The sb-vector-io/package<dot>lisp file
File, Lisp, sb-vector-io/vector-io.lisp: The sb-vector-io/vector-io<dot>lisp file

L
Lisp File, sb-vector-io.asd: The sb-vector-io<dot>asd file
Lisp File, sb-vector-io/package.lisp: The sb-vector-io/package<dot>lisp file
Lisp File, sb-vector-io/vector-io.lisp: The sb-vector-io/vector-io<dot>lisp file

S
sb-vector-io.asd: The sb-vector-io<dot>asd file
sb-vector-io/package.lisp: The sb-vector-io/package<dot>lisp file
sb-vector-io/vector-io.lisp: The sb-vector-io/vector-io<dot>lisp file

Jump to:   F   L   S  

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

A.2 Functions

Jump to:   C   F   G   M   R   S   V   W  
Index Entry  Section

C
check-stream-element-type: Internal functions
Compiler Macro, read-vector-data: Exported compiler macros
Compiler Macro, write-vector-data: Exported compiler macros

F
Function, check-stream-element-type: Internal functions
Function, vector-element-bytes: Internal functions
Function, wait-for-vector-write: Internal functions

G
Generic Function, read-vector-data: Exported generic functions
Generic Function, read-vector-data: Exported generic functions
Generic Function, stream-fd: Internal generic functions
Generic Function, stream-timeout: Internal generic functions
Generic Function, write-vector-data: Exported generic functions
Generic Function, write-vector-data: Exported generic functions

M
Method, read-vector-data: Exported generic functions
Method, read-vector-data: Exported generic functions
Method, stream-fd: Internal generic functions
Method, stream-fd: Internal generic functions
Method, stream-fd: Internal generic functions
Method, stream-timeout: Internal generic functions
Method, stream-timeout: Internal generic functions
Method, stream-timeout: Internal generic functions
Method, write-vector-data: Exported generic functions
Method, write-vector-data: Exported generic functions

R
read-vector-data: Exported compiler macros
read-vector-data: Exported generic functions
read-vector-data: Exported generic functions
read-vector-data: Exported generic functions
read-vector-data: Exported generic functions

S
stream-fd: Internal generic functions
stream-fd: Internal generic functions
stream-fd: Internal generic functions
stream-fd: Internal generic functions
stream-timeout: Internal generic functions
stream-timeout: Internal generic functions
stream-timeout: Internal generic functions
stream-timeout: Internal generic functions

V
vector-element-bytes: Internal functions

W
wait-for-vector-write: Internal functions
write-vector-data: Exported compiler macros
write-vector-data: Exported generic functions
write-vector-data: Exported generic functions
write-vector-data: Exported generic functions
write-vector-data: Exported generic functions

Jump to:   C   F   G   M   R   S   V   W  

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

A.3 Variables

Jump to:   *  
S  
Index Entry  Section

*
*notified*: Internal special variables

S
Special Variable, *notified*: Internal special variables

Jump to:   *  
S  

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

A.4 Data types

Jump to:   P   S   V  
Index Entry  Section

P
Package, sb-vector-io: The sb-vector-io package
Package, vector-io: The vector-io package

S
sb-vector-io: The sb-vector-io system
sb-vector-io: The sb-vector-io package
System, sb-vector-io: The sb-vector-io system

V
vector-io: The vector-io package

Jump to:   P   S   V