The dynamic-array Reference Manual

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

The dynamic-array Reference Manual

This is the dynamic-array Reference Manual, version 0.1.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Tue Nov 15 05:38:31 2022 GMT+0.

Table of Contents

Next: , Previous: , Up: The dynamic-array Reference Manual   [Contents][Index]

1 Introduction

dynamic-array

An optimized 1-dimensional array of fixnums that automatically re-adjusts in size.

Overview

An optimized 1-dimensional array type that can only store fixnums, and which is able to automatically grow when pushing new elements to the end. It is not very useful in most situations, as it doesn't implement the Common Lisp sequences protocol, nor does it conform to the usual interface of Common Lisp arrays for PUSH and POP.

Install

(ql:quickload :dynamic-array)

License

Copyright © 2019-2022 Michael Fiano mail@mfiano.net

Licensed under the MIT License.

Next: , Previous: , Up: The dynamic-array Reference Manual   [Contents][Index]

2 Systems

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

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

2.1 dynamic-array

An optimized 1-dimensional array of fixnums that automatically re-adjusts in size.

Author

Michael Fiano <mail@mfiano.net>

Home Page

https://git.mfiano.net/mfiano/dynamic-array

License

MIT

Version

0.1.0

Dependency

mfiano-utils (system).

Source

dynamic-array.asd.

Child Components

Next: , Previous: , Up: The dynamic-array Reference Manual   [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   [Contents][Index]

3.1.1 dynamic-array/dynamic-array.asd

Source

dynamic-array.asd.

Parent Component

dynamic-array (system).

ASDF Systems

dynamic-array.

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

3.1.2 dynamic-array/package.lisp

Source

dynamic-array.asd.

Parent Component

dynamic-array (system).

Packages

dynamic-array.

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

3.1.3 dynamic-array/dynamic-array.lisp

Dependency

package.lisp (file).

Source

dynamic-array.asd.

Parent Component

dynamic-array (system).

Public Interface
Internals

Next: , Previous: , Up: The dynamic-array Reference Manual   [Contents][Index]

4 Packages

Packages are listed by definition order.

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

4.1 dynamic-array

Source

package.lisp.

Use List

common-lisp.

Public Interface
Internals

Next: , Previous: , Up: The dynamic-array Reference Manual   [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 Public Interface

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

5.1.1 Ordinary functions

Function: aref (dynamic-array index)
Package

dynamic-array.

Source

dynamic-array.lisp.

Function: (setf aref) (dynamic-array index)
Package

dynamic-array.

Source

dynamic-array.lisp.

Function: copy (dynamic-array)
Package

dynamic-array.

Source

dynamic-array.lisp.

Function: find (dynamic-array item &key test key)
Package

dynamic-array.

Source

dynamic-array.lisp.

Function: length (dynamic-array)
Package

dynamic-array.

Source

dynamic-array.lisp.

Function: make-array (&key size capacity element-type initial-element)
Package

dynamic-array.

Source

dynamic-array.lisp.

Function: map (dynamic-array func)
Package

dynamic-array.

Source

dynamic-array.lisp.

Function: pop (dynamic-array &optional delete-p)
Package

dynamic-array.

Source

dynamic-array.lisp.

Function: push (dynamic-array value)
Package

dynamic-array.

Source

dynamic-array.lisp.

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

5.1.2 Standalone methods

Method: print-object ((dynamic-array dynamic-array) stream)
Source

dynamic-array.lisp.

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

5.1.3 Structures

Structure: dynamic-array
Package

dynamic-array.

Source

dynamic-array.lisp.

Direct superclasses

structure-object.

Direct methods

print-object.

Direct slots
Slot: data
Type

simple-vector

Initform

(make-array 0 :element-type t)

Readers

data.

Writers

(setf data).

Slot: initial-element
Initform

0

Readers

initial-element.

Writers

(setf initial-element).

Slot: fill-pointer
Type

fixnum

Initform

0

Readers

fill-pointer.

Writers

(setf fill-pointer).

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

5.2 Internals

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

5.2.1 Ordinary functions

Function: %make-array (&key data initial-element fill-pointer)
Package

dynamic-array.

Source

dynamic-array.lisp.

Reader: data (instance)
Writer: (setf data) (instance)
Package

dynamic-array.

Source

dynamic-array.lisp.

Target Slot

data.

Reader: fill-pointer (instance)
Writer: (setf fill-pointer) (instance)
Package

dynamic-array.

Source

dynamic-array.lisp.

Target Slot

fill-pointer.

Reader: initial-element (instance)
Writer: (setf initial-element) (instance)
Package

dynamic-array.

Source

dynamic-array.lisp.

Target Slot

initial-element.

Previous: , Up: The dynamic-array Reference Manual   [Contents][Index]

Appendix A Indexes

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

A.1 Concepts

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

A.2 Functions

Jump to:   %   (  
A   C   D   F   I   L   M   P  
Index Entry  Section
%
%make-array: Private ordinary functions
(
(setf aref): Public ordinary functions
(setf data): Private ordinary functions
(setf fill-pointer): Private ordinary functions
(setf initial-element): Private ordinary functions
A
aref: Public ordinary functions
C
copy: Public ordinary functions
D
data: Private ordinary functions
F
fill-pointer: Private ordinary functions
find: Public ordinary functions
Function, %make-array: Private ordinary functions
Function, (setf aref): Public ordinary functions
Function, (setf data): Private ordinary functions
Function, (setf fill-pointer): Private ordinary functions
Function, (setf initial-element): Private ordinary functions
Function, aref: Public ordinary functions
Function, copy: Public ordinary functions
Function, data: Private ordinary functions
Function, fill-pointer: Private ordinary functions
Function, find: Public ordinary functions
Function, initial-element: Private ordinary functions
Function, length: Public ordinary functions
Function, make-array: Public ordinary functions
Function, map: Public ordinary functions
Function, pop: Public ordinary functions
Function, push: Public ordinary functions
I
initial-element: Private ordinary functions
L
length: Public ordinary functions
M
make-array: Public ordinary functions
map: Public ordinary functions
Method, print-object: Public standalone methods
P
pop: Public ordinary functions
print-object: Public standalone methods
push: Public ordinary functions
Jump to:   %   (  
A   C   D   F   I   L   M   P  

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

A.3 Variables

Jump to:   D   F   I   S  
Index Entry  Section
D
data: Public structures
F
fill-pointer: Public structures
I
initial-element: Public structures
S
Slot, data: Public structures
Slot, fill-pointer: Public structures
Slot, initial-element: Public structures
Jump to:   D   F   I   S