The big-string Reference Manual

This is the big-string Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Jan 15 04:23:24 2023 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 big-string

Big strings, similar to Java’s StringBuilder.

Author

Robert Smith <>

License

BSD 3-clause (see LICENSE)

Source

big-string.asd.

Child Components

3 Files

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


3.1 Lisp


3.1.1 big-string/big-string.asd

Source

big-string.asd.

Parent Component

big-string (system).

ASDF Systems

big-string.


3.1.2 big-string/package.lisp

Source

big-string.asd.

Parent Component

big-string (system).

Packages

big-string.


3.1.3 big-string/big-string.lisp

Dependency

package.lisp (file).

Source

big-string.asd.

Parent Component

big-string (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 big-string

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.


5.1 Public Interface


5.1.1 Ordinary functions

Function: big-string-append (bs string)

Destructively append the string STRING to the big string BS.

Time complexity: O(1) [amortized]

Package

big-string.

Source

big-string.lisp.

Function: big-string-char (bs n)

Find the Nth char in the big string BS.

Time complexity: O(log n)

Package

big-string.

Source

big-string.lisp.

Function: big-string-length (bs)

Return the total length of the big string BS.

Time complexity: O(1)

Package

big-string.

Source

big-string.lisp.

Function: big-string-p (object)
Package

big-string.

Source

big-string.lisp.

Function: big-string-substring (bs start &optional end)

Compute the substring from the big string BS from the index START to before the index END.

Time complexity: with n = end - start, O(n log n)

Package

big-string.

Source

big-string.lisp.

Function: copy-big-string (instance)
Package

big-string.

Source

big-string.lisp.

Function: make-big-string ()
Package

big-string.

Source

big-string.lisp.

Function: string-of-big-string (bs)

Build a string from the big string BS.

Time complexity: O(size(bs))

Package

big-string.

Source

big-string.lisp.


5.1.2 Standalone methods

Method: print-object ((object big-string) stream)
Source

big-string.lisp.


5.1.3 Structures

Structure: big-string
Package

big-string.

Source

big-string.lisp.

Direct superclasses

structure-object.

Direct methods

print-object.

Direct slots
Slot: tracked-length
Type

big-string::big-string-size

Initform

0

Readers

big-string-tracked-length.

Writers

(setf big-string-tracked-length).

Slot: cumulative-lengths
Type

(and (vector big-string::big-string-size) (not simple-array))

Initform

(make-array 10 :element-type (quote big-string::big-string-size) :initial-element 0 :adjustable t :fill-pointer 0)

Readers

big-string-cumulative-lengths.

Writers

(setf big-string-cumulative-lengths).

Slot: strings
Type

(and (vector simple-string) (not simple-array))

Initform

(make-array 10 :element-type (quote simple-string) :initial-element "" :adjustable t :fill-pointer 0)

Readers

big-string-strings.

Writers

(setf big-string-strings).


5.2 Internals


5.2.1 Ordinary functions

Reader: big-string-cumulative-lengths (instance)
Writer: (setf big-string-cumulative-lengths) (instance)
Package

big-string.

Source

big-string.lisp.

Target Slot

cumulative-lengths.

Reader: big-string-strings (instance)
Writer: (setf big-string-strings) (instance)
Package

big-string.

Source

big-string.lisp.

Target Slot

strings.

Reader: big-string-tracked-length (instance)
Writer: (setf big-string-tracked-length) (instance)
Package

big-string.

Source

big-string.lisp.

Target Slot

tracked-length.

Function: binary-search (n array)

Find the least value in the array ARRAY greater than N. Return NIL if N is negative or no such number is found.

Package

big-string.

Source

big-string.lisp.


5.2.2 Types

Type: array-size ()

Possible size of an array.

Package

big-string.

Source

big-string.lisp.

Type: big-string-size ()

Possible size of a big string.

Package

big-string.

Source

big-string.lisp.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   (  
B   C   F   M   P   S  
Index Entry  Section

(
(setf big-string-cumulative-lengths): Private ordinary functions
(setf big-string-strings): Private ordinary functions
(setf big-string-tracked-length): Private ordinary functions

B
big-string-append: Public ordinary functions
big-string-char: Public ordinary functions
big-string-cumulative-lengths: Private ordinary functions
big-string-length: Public ordinary functions
big-string-p: Public ordinary functions
big-string-strings: Private ordinary functions
big-string-substring: Public ordinary functions
big-string-tracked-length: Private ordinary functions
binary-search: Private ordinary functions

C
copy-big-string: Public ordinary functions

F
Function, (setf big-string-cumulative-lengths): Private ordinary functions
Function, (setf big-string-strings): Private ordinary functions
Function, (setf big-string-tracked-length): Private ordinary functions
Function, big-string-append: Public ordinary functions
Function, big-string-char: Public ordinary functions
Function, big-string-cumulative-lengths: Private ordinary functions
Function, big-string-length: Public ordinary functions
Function, big-string-p: Public ordinary functions
Function, big-string-strings: Private ordinary functions
Function, big-string-substring: Public ordinary functions
Function, big-string-tracked-length: Private ordinary functions
Function, binary-search: Private ordinary functions
Function, copy-big-string: Public ordinary functions
Function, make-big-string: Public ordinary functions
Function, string-of-big-string: Public ordinary functions

M
make-big-string: Public ordinary functions
Method, print-object: Public standalone methods

P
print-object: Public standalone methods

S
string-of-big-string: Public ordinary functions