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

The static-vectors Reference Manual

This is the static-vectors Reference Manual, version 1.9.3, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 15 07:46:50 2024 GMT+0.

1 Introduction
2 Systems
- 2.1 static-vectors
3 Files
- 3.1 Lisp
4 Packages
- 4.1 static-vectors
5 Definitions
- 5.1 Public Interface
  - 5.1.1 Macros
  - 5.1.2 Ordinary functions
- 5.2 Internals
  - 5.2.1 Constants
  - 5.2.2 Ordinary functions
Appendix A Indexes

Next: Systems, Previous: The static-vectors Reference Manual, Up: The static-vectors Reference Manual [Contents][Index]

1 Introduction

Next: Files, Previous: Introduction, Up: The static-vectors Reference Manual [Contents][Index]

2 Systems

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

static-vectors

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

2.1 `static-vectors`

Create vectors allocated in static memory.

Author

Stelian Ionescu <sionescu@cddr.org>

License

MIT

Version

1.9.3

Dependencies

alexandria (system).
cffi (system).

Source

static-vectors.asd.

Child Components

pkgdcl.lisp (file).
constantp.lisp (file).
impl-abcl.lisp (file).
impl-allegro.lisp (file).
impl-clasp.lisp (file).
impl-clozure.lisp (file).
impl-cmucl.lisp (file).
impl-ecl.lisp (file).
impl-lispworks.lisp (file).
impl-sbcl.lisp (file).
constructor.lisp (file).
cffi-type-translator.lisp (file).

Next: Packages, Previous: Systems, Up: The static-vectors Reference Manual [Contents][Index]

3 Files

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

Lisp

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

3.1 Lisp

static-vectors/static-vectors.asd
static-vectors/pkgdcl.lisp
static-vectors/constantp.lisp
static-vectors/impl-abcl.lisp
static-vectors/impl-allegro.lisp
static-vectors/impl-clasp.lisp
static-vectors/impl-clozure.lisp
static-vectors/impl-cmucl.lisp
static-vectors/impl-ecl.lisp
static-vectors/impl-lispworks.lisp
static-vectors/impl-sbcl.lisp
static-vectors/constructor.lisp
static-vectors/cffi-type-translator.lisp

Next: static-vectors/pkgdcl.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

3.1.1 `static-vectors/static-vectors.asd`

Source: static-vectors.asd.
Parent Component: static-vectors (system).
ASDF Systems: static-vectors.

Next: static-vectors/constantp.lisp, Previous: static-vectors/static-vectors.asd, Up: Lisp [Contents][Index]

3.1.2 `static-vectors/pkgdcl.lisp`

Source: static-vectors.asd.
Parent Component: static-vectors (system).
Packages: static-vectors.

Next: static-vectors/impl-abcl.lisp, Previous: static-vectors/pkgdcl.lisp, Up: Lisp [Contents][Index]

3.1.3 `static-vectors/constantp.lisp`

Dependency

pkgdcl.lisp (file).

Source

static-vectors.asd.

Parent Component

static-vectors (system).

Internals

canonicalize-args (function).
constantp (function).
eval-constant (function).
quotedp (function).

Next: static-vectors/impl-allegro.lisp, Previous: static-vectors/constantp.lisp, Up: Lisp [Contents][Index]

3.1.4 `static-vectors/impl-abcl.lisp`

If Feature: :abcl
Dependency: constantp.lisp (file).
Source: static-vectors.asd.
Parent Component: static-vectors (system).

Next: static-vectors/impl-clasp.lisp, Previous: static-vectors/impl-abcl.lisp, Up: Lisp [Contents][Index]

3.1.5 `static-vectors/impl-allegro.lisp`

If Feature

:allegro

Dependencies

impl-abcl.lisp (file).
constantp.lisp (file).

Source

static-vectors.asd.

Parent Component

static-vectors (system).

Next: static-vectors/impl-clozure.lisp, Previous: static-vectors/impl-allegro.lisp, Up: Lisp [Contents][Index]

3.1.6 `static-vectors/impl-clasp.lisp`

If Feature

:clasp

Dependencies

impl-allegro.lisp (file).
impl-abcl.lisp (file).
constantp.lisp (file).

Source

static-vectors.asd.

Parent Component

static-vectors (system).

Next: static-vectors/impl-cmucl.lisp, Previous: static-vectors/impl-clasp.lisp, Up: Lisp [Contents][Index]

3.1.7 `static-vectors/impl-clozure.lisp`

If Feature

:ccl

Dependencies

impl-clasp.lisp (file).
impl-allegro.lisp (file).
impl-abcl.lisp (file).
constantp.lisp (file).

Source

static-vectors.asd.

Parent Component

static-vectors (system).

Next: static-vectors/impl-ecl.lisp, Previous: static-vectors/impl-clozure.lisp, Up: Lisp [Contents][Index]

3.1.8 `static-vectors/impl-cmucl.lisp`

If Feature

:cmu

Dependencies

impl-clozure.lisp (file).
impl-clasp.lisp (file).
impl-allegro.lisp (file).
impl-abcl.lisp (file).
constantp.lisp (file).

Source

static-vectors.asd.

Parent Component

static-vectors (system).

Next: static-vectors/impl-lispworks.lisp, Previous: static-vectors/impl-cmucl.lisp, Up: Lisp [Contents][Index]

3.1.9 `static-vectors/impl-ecl.lisp`

If Feature

:ecl

Dependencies

impl-cmucl.lisp (file).
impl-clozure.lisp (file).
impl-clasp.lisp (file).
impl-allegro.lisp (file).
impl-abcl.lisp (file).
constantp.lisp (file).

Source

static-vectors.asd.

Parent Component

static-vectors (system).

Next: static-vectors/impl-sbcl.lisp, Previous: static-vectors/impl-ecl.lisp, Up: Lisp [Contents][Index]

3.1.10 `static-vectors/impl-lispworks.lisp`

If Feature

:lispworks

Dependencies

impl-ecl.lisp (file).
impl-cmucl.lisp (file).
impl-clozure.lisp (file).
impl-clasp.lisp (file).
impl-allegro.lisp (file).
impl-abcl.lisp (file).
constantp.lisp (file).

Source

static-vectors.asd.

Parent Component

static-vectors (system).

Next: static-vectors/constructor.lisp, Previous: static-vectors/impl-lispworks.lisp, Up: Lisp [Contents][Index]

3.1.11 `static-vectors/impl-sbcl.lisp`

If Feature

:sbcl

Dependencies

impl-lispworks.lisp (file).
impl-ecl.lisp (file).
impl-cmucl.lisp (file).
impl-clozure.lisp (file).
impl-clasp.lisp (file).
impl-allegro.lisp (file).
impl-abcl.lisp (file).
constantp.lisp (file).

Source

static-vectors.asd.

Parent Component

static-vectors (system).

Public Interface

fill-foreign-memory (function).
free-static-vector (function).
replace-foreign-memory (function).
static-vector-pointer (function).
with-static-vector (macro).

Internals

%allocate-static-vector (function).
%memalign (function).
+array-header-size+ (constant).
align (function).
static-vector-address (function).
vector-widetag-and-n-bytes (function).

Next: static-vectors/cffi-type-translator.lisp, Previous: static-vectors/impl-sbcl.lisp, Up: Lisp [Contents][Index]

3.1.12 `static-vectors/constructor.lisp`

Dependencies

impl-sbcl.lisp (file).
impl-lispworks.lisp (file).
impl-ecl.lisp (file).
impl-cmucl.lisp (file).
impl-clozure.lisp (file).
impl-clasp.lisp (file).
impl-allegro.lisp (file).
impl-abcl.lisp (file).
constantp.lisp (file).

Source

static-vectors.asd.

Parent Component

static-vectors (system).

Public Interface

make-static-vector (function).
with-static-vectors (macro).

Internals

+default-alignment+ (constant).
+max-alignment+ (constant).
check-arguments (function).
check-initial-contents (function).
check-initial-element (function).
check-initialization-arguments (function).

Previous: static-vectors/constructor.lisp, Up: Lisp [Contents][Index]

3.1.13 `static-vectors/cffi-type-translator.lisp`

Dependency: constructor.lisp (file).
Source: static-vectors.asd.
Parent Component: static-vectors (system).

Next: Definitions, Previous: Files, Up: The static-vectors Reference Manual [Contents][Index]

4 Packages

Packages are listed by definition order.

static-vectors

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

4.1 `static-vectors`

Source

pkgdcl.lisp.

Use List

alexandria.
cffi.
common-lisp.

Public Interface

fill-foreign-memory (function).
free-static-vector (function).
make-static-vector (function).
replace-foreign-memory (function).
static-vector-pointer (function).
with-static-vector (macro).
with-static-vectors (macro).

Internals

%allocate-static-vector (function).
%memalign (function).
+array-header-size+ (constant).
+default-alignment+ (constant).
+max-alignment+ (constant).
align (function).
canonicalize-args (function).
check-arguments (function).
check-initial-contents (function).
check-initial-element (function).
check-initialization-arguments (function).
constantp (function).
eval-constant (function).
quotedp (function).
static-vector-address (function).
vector-widetag-and-n-bytes (function).

Next: Indexes, Previous: Packages, Up: The static-vectors Reference Manual [Contents][Index]

5 Definitions

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

Public Interface
Internals

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

Next: Ordinary functions, Previous: Public Interface, Up: Public Interface [Contents][Index]

5.1.1 Macros

Macro: with-static-vector ((var length &rest args &key element-type initial-contents initial-element) &body body) ¶

Bind PTR-VAR to a static vector of length LENGTH and execute BODY within its dynamic extent. The vector is freed upon exit.

Package: static-vectors.
Source: impl-sbcl.lisp.

Macro: with-static-vectors (((var length &rest args) &rest more-clauses) &body body) ¶

Allocate multiple static vectors at once.

Package: static-vectors.
Source: constructor.lisp.

Previous: Macros, Up: Public Interface [Contents][Index]

5.1.2 Ordinary functions

Function: fill-foreign-memory (pointer length value) ¶

Fill LENGTH octets in foreign memory area POINTER with VALUE.

Package: static-vectors.
Source: impl-sbcl.lisp.

Function: free-static-vector (vector) ¶

Free VECTOR, which must be a vector created by MAKE-STATIC-VECTOR.

Package: static-vectors.
Source: impl-sbcl.lisp.

Function: make-static-vector (length &key element-type initial-element initial-contents alignment) ¶

Create a simple vector of length LENGTH and type ELEMENT-TYPE which will not be moved by the garbage collector. The vector might be allocated in foreign memory so you must always call FREE-STATIC-VECTOR to free it.

Package: static-vectors.
Source: constructor.lisp.

Function: replace-foreign-memory (dst-ptr src-ptr length) ¶

Copy LENGTH octets from foreign memory area SRC-PTR to DST-PTR.

Package: static-vectors.
Source: impl-sbcl.lisp.

Function: static-vector-pointer (vector &key offset) ¶

Return a foreign pointer to the beginning of VECTOR + OFFSET octets. VECTOR must be a vector created by MAKE-STATIC-VECTOR.

Package: static-vectors.
Source: impl-sbcl.lisp.

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

5.2 Internals

Constants
Ordinary functions

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

5.2.1 Constants

Constant: +array-header-size+ ¶

Package: static-vectors.
Source: impl-sbcl.lisp.

Constant: +default-alignment+ ¶

Package: static-vectors.
Source: constructor.lisp.

Constant: +max-alignment+ ¶

Package: static-vectors.
Source: constructor.lisp.

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

5.2.2 Ordinary functions

Function: %allocate-static-vector (length element-type alignment) ¶

Package: static-vectors.
Source: impl-sbcl.lisp.

Function: %memalign (size alignment) ¶

Package: static-vectors.
Source: impl-sbcl.lisp.

Function: align (size boundary) ¶

Package: static-vectors.
Source: impl-sbcl.lisp.

Function: canonicalize-args (env element-type length) ¶

Package: static-vectors.
Source: constantp.lisp.

Function: check-arguments (length element-type initial-element initial-element-p initial-contents initial-contents-p) ¶

Package: static-vectors.
Source: constructor.lisp.

Function: check-initial-contents (length initial-contents) ¶

Package: static-vectors.
Source: constructor.lisp.

Function: check-initial-element (element-type initial-element) ¶

Package: static-vectors.
Source: constructor.lisp.

Function: check-initialization-arguments (initial-element-p initial-contents-p) ¶

Package: static-vectors.
Source: constructor.lisp.

Function: constantp (form &optional env) ¶

Package: static-vectors.
Source: constantp.lisp.

Function: eval-constant (form &optional env) ¶

Package: static-vectors.
Source: constantp.lisp.

Function: quotedp (form) ¶

Package: static-vectors.
Source: constantp.lisp.

Function: static-vector-address (vector) ¶

Return a foreign pointer to start of the Lisp VECTOR(including its header). VECTOR must be a vector created by MAKE-STATIC-VECTOR.

Package: static-vectors.
Source: impl-sbcl.lisp.

Function: vector-widetag-and-n-bytes (type) ¶

Returns the widetag and octet size of the upgraded array element type for a given type specifier.

Package: static-vectors.
Source: impl-sbcl.lisp.

Previous: Definitions, Up: The static-vectors Reference Manual [Contents][Index]

Appendix A Indexes

Concepts
Functions
Variables
Data types

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

A.1 Concepts

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

A.2 Functions

Jump to:	% A C E F M Q R S V W

	Index Entry	Section

%
	`%allocate-static-vector`:	Private ordinary functions
	`%memalign`:	Private ordinary functions

A
	`align`:	Private ordinary functions

C
	`canonicalize-args`:	Private ordinary functions
	`check-arguments`:	Private ordinary functions
	`check-initial-contents`:	Private ordinary functions
	`check-initial-element`:	Private ordinary functions
	`check-initialization-arguments`:	Private ordinary functions
	`constantp`:	Private ordinary functions

E
	`eval-constant`:	Private ordinary functions

F
	`fill-foreign-memory`:	Public ordinary functions
	`free-static-vector`:	Public ordinary functions
	`Function, %allocate-static-vector`:	Private ordinary functions
	`Function, %memalign`:	Private ordinary functions
	`Function, align`:	Private ordinary functions
	`Function, canonicalize-args`:	Private ordinary functions
	`Function, check-arguments`:	Private ordinary functions
	`Function, check-initial-contents`:	Private ordinary functions
	`Function, check-initial-element`:	Private ordinary functions
	`Function, check-initialization-arguments`:	Private ordinary functions
	`Function, constantp`:	Private ordinary functions
	`Function, eval-constant`:	Private ordinary functions
	`Function, fill-foreign-memory`:	Public ordinary functions
	`Function, free-static-vector`:	Public ordinary functions
	`Function, make-static-vector`:	Public ordinary functions
	`Function, quotedp`:	Private ordinary functions
	`Function, replace-foreign-memory`:	Public ordinary functions
	`Function, static-vector-address`:	Private ordinary functions
	`Function, static-vector-pointer`:	Public ordinary functions
	`Function, vector-widetag-and-n-bytes`:	Private ordinary functions

M
	`Macro, with-static-vector`:	Public macros
	`Macro, with-static-vectors`:	Public macros
	`make-static-vector`:	Public ordinary functions

Q
	`quotedp`:	Private ordinary functions

R
	`replace-foreign-memory`:	Public ordinary functions

S
	`static-vector-address`:	Private ordinary functions
	`static-vector-pointer`:	Public ordinary functions

V
	`vector-widetag-and-n-bytes`:	Private ordinary functions

W
	`with-static-vector`:	Public macros
	`with-static-vectors`:	Public macros

Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]

A.3 Variables

Jump to:	+ C

	Index Entry	Section

+
	`+array-header-size+`:	Private constants
	`+default-alignment+`:	Private constants
	`+max-alignment+`:	Private constants

C
	`Constant, +array-header-size+`:	Private constants
	`Constant, +default-alignment+`:	Private constants
	`Constant, +max-alignment+`:	Private constants

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

A.4 Data types

Jump to:	C F I P S

	Index Entry	Section

C
	`cffi-type-translator.lisp`:	The static-vectors/cffi-type-translator․lisp file
	`constantp.lisp`:	The static-vectors/constantp․lisp file
	`constructor.lisp`:	The static-vectors/constructor․lisp file

F
	`File, cffi-type-translator.lisp`:	The static-vectors/cffi-type-translator․lisp file
	`File, constantp.lisp`:	The static-vectors/constantp․lisp file
	`File, constructor.lisp`:	The static-vectors/constructor․lisp file
	`File, impl-abcl.lisp`:	The static-vectors/impl-abcl․lisp file
	`File, impl-allegro.lisp`:	The static-vectors/impl-allegro․lisp file
	`File, impl-clasp.lisp`:	The static-vectors/impl-clasp․lisp file
	`File, impl-clozure.lisp`:	The static-vectors/impl-clozure․lisp file
	`File, impl-cmucl.lisp`:	The static-vectors/impl-cmucl․lisp file
	`File, impl-ecl.lisp`:	The static-vectors/impl-ecl․lisp file
	`File, impl-lispworks.lisp`:	The static-vectors/impl-lispworks․lisp file
	`File, impl-sbcl.lisp`:	The static-vectors/impl-sbcl․lisp file
	`File, pkgdcl.lisp`:	The static-vectors/pkgdcl․lisp file
	`File, static-vectors.asd`:	The static-vectors/static-vectors․asd file

I
	`impl-abcl.lisp`:	The static-vectors/impl-abcl․lisp file
	`impl-allegro.lisp`:	The static-vectors/impl-allegro․lisp file
	`impl-clasp.lisp`:	The static-vectors/impl-clasp․lisp file
	`impl-clozure.lisp`:	The static-vectors/impl-clozure․lisp file
	`impl-cmucl.lisp`:	The static-vectors/impl-cmucl․lisp file
	`impl-ecl.lisp`:	The static-vectors/impl-ecl․lisp file
	`impl-lispworks.lisp`:	The static-vectors/impl-lispworks․lisp file
	`impl-sbcl.lisp`:	The static-vectors/impl-sbcl․lisp file

P
	`Package, static-vectors`:	The static-vectors package
	`pkgdcl.lisp`:	The static-vectors/pkgdcl․lisp file

S
	`static-vectors`:	The static-vectors system
	`static-vectors`:	The static-vectors package
	`static-vectors.asd`:	The static-vectors/static-vectors․asd file
	`System, static-vectors`:	The static-vectors system

The static-vectors Reference Manual

Table of Contents

1 Introduction

2 Systems

2.1 static-vectors

3 Files

3.1 Lisp

3.1.1 static-vectors/static-vectors.asd

3.1.2 static-vectors/pkgdcl.lisp

3.1.3 static-vectors/constantp.lisp

3.1.4 static-vectors/impl-abcl.lisp

3.1.5 static-vectors/impl-allegro.lisp

3.1.6 static-vectors/impl-clasp.lisp

3.1.7 static-vectors/impl-clozure.lisp

3.1.8 static-vectors/impl-cmucl.lisp

3.1.9 static-vectors/impl-ecl.lisp

3.1.10 static-vectors/impl-lispworks.lisp

3.1.11 static-vectors/impl-sbcl.lisp

3.1.12 static-vectors/constructor.lisp

3.1.13 static-vectors/cffi-type-translator.lisp

4 Packages

4.1 static-vectors

5 Definitions

5.1 Public Interface

5.1.1 Macros

5.1.2 Ordinary functions

5.2 Internals

5.2.1 Constants

5.2.2 Ordinary functions

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `static-vectors`

3.1.1 `static-vectors/static-vectors.asd`

3.1.2 `static-vectors/pkgdcl.lisp`

3.1.3 `static-vectors/constantp.lisp`

3.1.4 `static-vectors/impl-abcl.lisp`

3.1.5 `static-vectors/impl-allegro.lisp`

3.1.6 `static-vectors/impl-clasp.lisp`

3.1.7 `static-vectors/impl-clozure.lisp`

3.1.8 `static-vectors/impl-cmucl.lisp`

3.1.9 `static-vectors/impl-ecl.lisp`

3.1.10 `static-vectors/impl-lispworks.lisp`

3.1.11 `static-vectors/impl-sbcl.lisp`

3.1.12 `static-vectors/constructor.lisp`

3.1.13 `static-vectors/cffi-type-translator.lisp`

4.1 `static-vectors`