The sb-vector-io Reference Manual

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 4.0 beta 2 "William Riker" on Mon Aug 15 05:48:40 2022 GMT+0.

Table of Contents


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.


2 Systems

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


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

2.1 sb-vector-io

Raw vector IO for SBCL.

Author

Nikodemus Siivola <nikodemus@sb-studio.net>

License

0-clause MIT

Source

sb-vector-io.asd.

Child Components

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   [Contents][Index]

3.1.1 sb-vector-io/sb-vector-io.asd

Source

sb-vector-io.asd.

Parent Component

sb-vector-io (system).

ASDF Systems

sb-vector-io.


3.1.2 sb-vector-io/package.lisp

Source

sb-vector-io.asd.

Parent Component

sb-vector-io (system).

Packages
Public Interface
Internals

*notified* (special variable).


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

Dependency

package.lisp (file).

Source

sb-vector-io.asd.

Parent Component

sb-vector-io (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


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

4.1 vector-io

Source

package.lisp.

Use List

common-lisp.

Public Interface
Internals

*notified* (special variable).


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

4.2 sb-vector-io

Source

package.lisp.

Use List

common-lisp.

Public Interface
Internals

5 Definitions

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


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

5.1 Public Interface


5.1.1 Compiler macros

Compiler Macro: read-vector-data (&rest args)
Package

vector-io.

Source

package.lisp.

Compiler Macro: write-vector-data (&rest args)
Package

vector-io.

Source

package.lisp.


5.1.2 Generic functions

Generic Function: read-vector-data (vector stream &key start end)
Package

vector-io.

Source

package.lisp.

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.

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.

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.

Methods
Method: write-vector-data ((vector vector) (stream ansi-stream) &key start end)

5.2 Internals


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

5.2.1 Special variables

Special Variable: *notified*
Package

vector-io.

Source

package.lisp.


5.2.2 Ordinary functions

Function: check-stream-element-type (stream context)
Package

sb-vector-io.

Source

vector-io.lisp.

Function: vector-element-bytes (vector)
Package

sb-vector-io.

Source

vector-io.lisp.

Function: wait-for-vector-write (stream fd data start bytes)
Package

sb-vector-io.

Source

vector-io.lisp.


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.

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.

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

Appendix A Indexes


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

A.1 Concepts


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: Private ordinary functions
Compiler Macro, read-vector-data: Public compiler macros
Compiler Macro, write-vector-data: Public compiler macros

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

G
Generic Function, read-vector-data: Public generic functions
Generic Function, read-vector-data: Public generic functions
Generic Function, stream-fd: Private generic functions
Generic Function, stream-timeout: Private generic functions
Generic Function, write-vector-data: Public generic functions
Generic Function, write-vector-data: Public generic functions

M
Method, read-vector-data: Public generic functions
Method, read-vector-data: Public generic functions
Method, stream-fd: Private generic functions
Method, stream-fd: Private generic functions
Method, stream-fd: Private generic functions
Method, stream-timeout: Private generic functions
Method, stream-timeout: Private generic functions
Method, stream-timeout: Private generic functions
Method, write-vector-data: Public generic functions
Method, write-vector-data: Public generic functions

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

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

V
vector-element-bytes: Private ordinary functions

W
wait-for-vector-write: Private ordinary functions
write-vector-data: Public compiler macros
write-vector-data: Public generic functions
write-vector-data: Public generic functions
write-vector-data: Public generic functions
write-vector-data: Public 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*: Private special variables

S
Special Variable, *notified*: Private special variables

Jump to:   *  
S