Version 15.17, X3J13/94-101. Version 15.17, X3J13/94-101.

Wed 11-May-1994 6:57pm EDT Wed 11-May-1994 6:57pm EDT

Programming Language|Common Lisp

15. Arrays

Arrays i ii Programming Language|Common Lisp

Version 15.17, X3J13/94-101. Version 15.17, X3J13/94-101.
Wed 11-May-1994 6:57pm EDT Wed 11-May-1994 6:57pm EDT

15.1 Array Concepts 15.1.1.3.1.1 Fill Pointers

A ll pointer is a non-negative integer no larger than the total number of elements in a vector .
Not all vectors have ll pointers . See the functions make-array and adjust-array .
15.1.1 Array Elements An element of a vector is said to be active if it has an index that is greater than or equal to
An array contains a set of objects called elements that can be referenced individually according to zero, but less than the ll pointer (if any). For an array that has no ll pointer , all elements are
a rectilinear coordinate system. considered active .
15.1.1.1 Array Indices Only vectors may have ll pointers ; multidimensional arrays may not. A multidimensional array
that is displaced to a vector that has a ll pointer can be created.
An array element is referred to by a (possibly empty) series of indices. The length of the series
must equal the rank of the array . Each index must be a non-negative xnum less than the 15.1.1.3.2 Multidimensional Arrays
corresponding array dimension . Array indexing is zero-origin.
15.1.1.3.2.1 Storage Layout for Multidimensional Arrays
15.1.1.2 Array Dimensions Multidimensional arrays store their components in row-major order; that is, internally a mul-
An axis of an array is called a dimension. tidimensional array is stored as a one-dimensional array , with the multidimensional index sets
Each dimension is a non-negative xnum ; if any dimension of an array is zero, the array has no ordered lexicographically, last index varying fastest.
elements. It is permissible for a dimension to be zero, in which case the array has no elements, 15.1.1.3.2.2 Implementation Limits on Array Rank
and any attempt to access an element is an error. However, other properties of the array , such as
the dimensions themselves, may be used. An implementation may impose a limit on the rank of an array , but there is a minimum require-
ment on that limit. See the variable array-rank-limit.
15.1.1.2.1 Implementation Limits on Individual Array Dimensions
An implementation may impose a limit on dimensions of an array , but there is a minimum 15.1.2 Specialized Arrays
requirement on that limit. See the variable array-dimension-limit. An array can be a general array , meaning each element may be any object , or it may be a
specialized array , meaning that each element must be of a restricted type .
15.1.1.3 Array Rank The phrasing \an array specialized to type hhtype ii" is sometimes used to emphasize the element
An array can have any number of dimensions (including zero). The number of dimensions is type of an array . This phrasing is tolerated even when the hhtype ii is t, even though an array
called the rank . specialized to type t is a general array , not a specialized array .
If the rank of an array is zero then the array is said to have no dimensions , and the product of Figure 15{1 lists some dened names that are applicable to array creation, access , and informa-
the dimensions (see array-total-size) is then 1; a zero-rank array therefore has a single element. tion operations.
15.1.1.3.1 Vectors adjust-array array-has-ll-pointer-p make-array
adjustable-array-p array-in-bounds-p svref
An array of rank one (i.e., a one-dimensional array ) is called a vector . aref array-rank upgraded-array-element-type
array-dimension array-rank-limit upgraded-complex-part-type
array-dimension-limit array-row-major-index vector
array-dimensions array-total-size vector-pop
array-displacement array-total-size-limit vector-push
array-element-type ll-pointer vector-push-extend
Figure 15{1. General Purpose Array-Related Dened Names

Arrays 15{1 15{2 Programming Language|Common Lisp

Version 15.17, X3J13/94-101. Version 15.17, X3J13/94-101.
Wed 11-May-1994 6:57pm EDT Wed 11-May-1994 6:57pm EDT

15.1.2.1 Array Upgrading

bit bit-ior bit-orc2
The upgraded array element type of a type T1 is a type T2 that is a supertype of T1 and that bit-and bit-nand bit-xor
is used instead of T1 whenever T1 is used as an array element type for object creation or type bit-andc1 bit-nor sbit
discrimination. bit-andc2 bit-not
During creation of an array , the element type that was requested is called the expressed array bit-eqv bit-orc1
element type . The upgraded array element type of the expressed array element type becomes the Figure 15{3. Operators that Manipulate Bit Arrays
actual array element type of the array that is created.
Type upgrading implies a movement upwards in the type hierarchy lattice. A type is always a
subtype of its upgraded array element type . Also, if a type Tx is a subtype of another type Ty , then
the upgraded array element type of Tx must be a subtype of the upgraded array element type of Ty .
Two disjoint types can be upgraded to the same type .
The upgraded array element type T2 of a type T1 is a function only of T1 itself; that is, it is inde-
pendent of any other property of the array for which T2 will be used, such as rank , adjustability ,
ll pointers , or displacement. The function upgraded-array-element-type can be used by con-
forming programs to predict how the implementation will upgrade a given type .
15.1.2.2 Required Kinds of Specialized Arrays
Vectors whose elements are restricted to type character or a subtype of character are called
strings. Strings are of type string. Figure 15{2 lists some dened names related to strings .
Strings are specialized arrays and might logically have been included in this chapter. However,
for purposes of readability most information about strings does not appear in this chapter; see
instead Chapter 16 (Strings).
char string-equal string-upcase
make-string string-greaterp string/=
nstring-capitalize string-left-trim string<
nstring-downcase string-lessp string<=
nstring-upcase string-not-equal string=
schar string-not-greaterp string>
string string-not-lessp string>=
string-capitalize string-right-trim
string-downcase string-trim
Figure 15{2. Operators that Manipulate Strings
Vectors whose elements are restricted to type bit are called bit vectors . Bit vectors are of type
bit-vector. Figure 15{3 lists some dened names for operations on bit arrays .

Arrays 15{3 15{4 Programming Language|Common Lisp

Version 15.17, X3J13/94-101. Version 15.17, X3J13/94-101.
Wed 11-May-1994 6:57pm EDT Wed 11-May-1994 6:57pm EDT

array System Class See Also:

*print-array*, aref , make-array , vector, Section 2.4.8.12 (Sharpsign A), Section 22.1.3.8 (Print-
ing Other Arrays)
Class Precedence List:
array , t Notes:
Note that the type (array t) is a proper subtype of the type (array *). The reason is that the
Description: type (array t) is the set of arrays that can hold any object (the elements are of type t, which
An array contains objects arranged according to a Cartesian coordinate system. An array pro- includes all objects ). On the other hand, the type (array *) is the set of all arrays whatsoever,
vides mappings from a set of xnums fi0 ; i1 ; : : :; ir 1 g to corresponding elements of the array , including for example arrays that can hold only characters . The type (array character) is not a
where 0  ij < dj , r is the rank of the array, and dj is the size of dimension j of the array. subtype of the type (array t); the two sets are disjoint because the type (array character) is not
the set of all arrays that can hold characters , but rather the set of arrays that are specialized to
When an array is created, the program requesting its creation may declare that all elements are hold precisely characters and no other objects .
of a particular type , called the expressed array element type . The implementation is permitted to
upgrade this type in order to produce the actual array element type , which is the element type for
the array is actually specialized . See the function upgraded-array-element-type.
Compound Type Specier Kind:
simple-array Type
Specializing. Supertypes:
Compound Type Specier Syntax: simple-array, array , t
(array [ felement-type j *g [dimension-spec ]]) Description:
The type of an array that is not displaced to another array , has no ll pointer , and is not ex-
dimension-spec::=rank j * j (fdimension j *g*) pressly adjustable is a subtype of type simple-array. The concept of a simple array exists to
allow the implementation to use a specialized representation and to allow the user to declare that
Compound Type Specier Arguments: certain values will always be simple arrays .
dimension|a valid array dimension . The types simple-vector, simple-string, and simple-bit-vector are disjoint subtypes of
element-type |a type specier . type simple-array, for they respectively mean (simple-array t (*)), the union of all
(simple-array c (*)) for any c being a subtype of type character , and (simple-array bit (*)).
rank |a non-negative xnum .
Compound Type Specier Kind:
Compound Type Specier Description: Specializing.
This denotes the set of arrays whose element type , rank , and dimensions match any given
element-type , rank , and dimensions . Specically: Compound Type Specier Syntax:
(simple-array [ felement-type j *g [dimension-spec ]])
If element-type is the symbol *, arrays are not excluded on the basis of their element type . Oth-
erwise, only those arrays are included whose actual array element type is the result of upgrading
element-type ; see Section 15.1.2.1 (Array Upgrading). dimension-spec::=rank j * j (fdimension j *g*)
If the dimension-spec is a rank , the set includes only those arrays having that rank . If the Compound Type Specier Arguments:
dimension-spec is a list of dimensions , the set includes only those arrays having a rank given
by the length of the dimensions , and having the indicated dimensions ; in this case, * matches dimension|a valid array dimension .
any value for the corresponding dimension . If the dimension-spec is the symbol *, the set is not element-type |a type specier .
restricted on the basis of rank or dimension .
rank |a non-negative xnum .

Arrays 15{5 15{6 Programming Language|Common Lisp

Version 15.17, X3J13/94-101. Version 15.17, X3J13/94-101.
Wed 11-May-1994 6:57pm EDT Wed 11-May-1994 6:57pm EDT

Compound Type Specier Description: If element-type is the symbol *, vectors are not excluded on the basis of their element type . Oth-
This compound type specier is treated exactly as the corresponding compound type specier for erwise, only those vectors are included whose actual array element type is the result of upgrading
type array would be treated, except that the set is further constrained to include only simple element-type ; see Section 15.1.2.1 (Array Upgrading).
arrays . If a size is specied, the set includes only those vectors whose only dimension is size . If the
Notes: symbol * is specied instead of a size , the set is not restricted on the basis of dimension .
It is implementation-dependent whether displaced arrays , vectors with ll pointers , or arrays that
are actually adjustable are simple arrays . See Also:
Section 15.1.2.2 (Required Kinds of Specialized Arrays), Section 2.4.8.3 (Sharpsign Left-
(simple-array *) refers to all simple arrays regardless of element type, (simple-array type- Parenthesis), Section 22.1.3.7 (Printing Other Vectors), Section 2.4.8.12 (Sharpsign A)
specier ) refers only to those simple arrays that can result from giving type-specier as the
:element-type argument to make-array . Notes:
The type (vector e s ) is equivalent to the type (array e (s )).
vector System Class The type (vector bit) has the name bit-vector.
The union of all types (vector C ), where C is any subtype of character, has the name string.
Class Precedence List: (vector *) refers to all vectors regardless of element type, (vector type-specier ) refers only
to those vectors that can result from giving type-specier as the :element-type argument to
vector, array , sequence, t make-array .
Description:
Any one-dimensional array is a vector .
The type vector is a subtype of type array ; for all types x, (vector x) is the same as (array x
simple-vector Type
(*)).

The type (vector t), the type string, and the type bit-vector are disjoint subtypes of type vector. Supertypes:
simple-vector, vector, simple-array, array , sequence, t
Compound Type Specier Kind: Description:
Specializing. The type of a vector that is not displaced to another array , has no ll pointer , is not expressly
Compound Type Specier Syntax: adjustable and is able to hold elements of any type is a subtype of type simple-vector.
(vector [felement-type j *g [fsize j *g]]) The type simple-vector is a subtype of type vector, and is a subtype of type (vector t).
Compound Type Specier Arguments: Compound Type Specier Kind:
Specializing.
size |a non-negative xnum .
element-type |a type specier . Compound Type Specier Syntax:
(simple-vector [ size ])
Compound Type Specier Description:
This denotes the set of specialized vectors whose element type and dimension match the specied Compound Type Specier Arguments:
values. Specically: size |a non-negative xnum , or the symbol *. The default is the symbol *.

Arrays 15{7 15{8 Programming Language|Common Lisp

Version 15.17, X3J13/94-101. Version 15.17, X3J13/94-101.
Wed 11-May-1994 6:57pm EDT Wed 11-May-1994 6:57pm EDT

Compound Type Specier Description:

This is the same as (simple-array t (size )).
simple-bit-vector Type

Supertypes:
bit-vector System Class simple-bit-vector, bit-vector, vector, simple-array, array , sequence, t
Description:
Class Precedence List: The type of a bit vector that is not displaced to another array , has no ll pointer , and is not
expressly adjustable is a subtype of type simple-bit-vector.
bit-vector, vector, array , sequence, t
Description: Compound Type Specier Kind:
A bit vector is a vector the element type of which is bit . Abbreviating.
The type bit-vector is a subtype of type vector, for bit-vector means (vector bit). Compound Type Specier Syntax:
(simple-bit-vector [ size ])
Compound Type Specier Kind:
Abbreviating. Compound Type Specier Arguments:
Compound Type Specier Syntax: size |a non-negative xnum , or the symbol *. The default is the symbol *.
(bit-vector [ size ]) Compound Type Specier Description:
This denotes the same type as the type (simple-array bit (size )); that is, the set of simple bit
Compound Type Specier Arguments: vectors of size size .
size |a non-negative xnum , or the symbol *.
Compound Type Specier Description:
This denotes the same type as the type (array bit (size )); that is, the set of bit vectors of size
make-array Function
size .
See Also: Syntax:
make-array dimensions &key element-type
Section 2.4.8.4 (Sharpsign Asterisk), Section 22.1.3.6 (Printing Bit Vectors), Section 15.1.2.2 initial-element
(Required Kinds of Specialized Arrays) initial-contents
adjustable
ll-pointer
displaced-to
displaced-index-oset
! new-array
Arguments and Values:
dimensions |a designator for a list of valid array dimensions .
element-type |a type specier . The default is t.
initial-element |an object .

Arrays 15{9 15{10 Programming Language|Common Lisp

Version 15.17, X3J13/94-101. Version 15.17, X3J13/94-101.
Wed 11-May-1994 6:57pm EDT Wed 11-May-1994 6:57pm EDT

make-array make-array
initial-contents |an object . the array is not expressly adjustable (and it is implementation-dependent whether the array is
actually adjustable ).
adjustable |a generalized boolean . The default is nil.
If ll-pointer is non-nil , the array must be one-dimensional; that is, the array must be a vector .
ll-pointer |a valid ll pointer for the array to be created, or t or nil. The default is nil. If ll-pointer is t, the length of the vector is used to initialize the ll pointer . If ll-pointer is an
displaced-to |an array or nil. The default is nil. This option must not be supplied if either integer , it becomes the initial ll pointer for the vector .
initial-element or initial-contents is supplied. If displaced-to is non-nil , make-array will create a displaced array and displaced-to is the target of
displaced-index-oset |a valid array row-major index for displaced-to . The default is 0. This that displaced array . In that case, the consequences are undened if the actual array element type
option must not be supplied unless a non-nil displaced-to is supplied. of displaced-to is not type equivalent to the actual array element type of the array being created.
If displaced-to is nil, the array is not a displaced array .
new-array |an array .
The displaced-index-oset is made to be the index oset of the array . When an array A is given
Description: as the :displaced-to argument to make-array when creating array B, then array B is said to be
Creates and returns an array constructed of the most specialized type that can accommodate displaced to array A. The total number of elements in an array , called the total size of the array ,
elements of type given by element-type . If dimensions is nil then a zero-dimensional array is is calculated as the product of all the dimensions. It is required that the total size of A be no
created. smaller than the sum of the total size of B plus the oset n supplied by the displaced-index-oset .
The eect of displacing is that array B does not have any elements of its own, but instead maps
Dimensions represents the dimensionality of the new array . accesses to itself into accesses to array A. The mapping treats both arrays as if they were one-
dimensional by taking the elements in row-major order, and then maps an access to element k of
element-type indicates the type of the elements intended to be stored in the new-array . The new- array B to an access to element k+n of array A.
array can actually store any objects of the type which results from upgrading element-type ; see
Section 15.1.2.1 (Array Upgrading). If make-array is called with adjustable , ll-pointer , and displaced-to each nil, then the result is a
simple array . If make-array is called with one or more of adjustable , ll-pointer , or displaced-to
If initial-element is supplied, it is used to initialize each element of new-array . If initial-element being true , whether the resulting array is a simple array is implementation-dependent .
is supplied, it must be of the type given by element-type . initial-element cannot be supplied if
either the :initial-contents option is supplied or displaced-to is non-nil . If initial-element is not When an array A is given as the :displaced-to argument to make-array when creating array B,
supplied, the consequences of later reading an uninitialized element of new-array are undened then array B is said to be displaced to array A. The total number of elements in an array , called
unless either initial-contents is supplied or displaced-to is non-nil . the total size of the array , is calculated as the product of all the dimensions. The consequences
are unspecied if the total size of A is smaller than the sum of the total size of B plus the oset
initial-contents is used to initialize the contents of array . For example: n supplied by the displaced-index-oset . The eect of displacing is that array B does not have any
(make-array '(4 2 3) :initial-contents elements of its own, but instead maps accesses to itself into accesses to array A. The mapping
'(((a b c) (1 2 3)) treats both arrays as if they were one-dimensional by taking the elements in row-major order, and
((d e f) (3 1 2)) then maps an access to element k of array B to an access to element k+n of array A.
((g h i) (2 3 1))
((j k l) (0 0 0))))
Examples:
initial-contents is composed of a nested structure of sequences . The numbers of levels in the struc- (make-array 5) ;; Creates a one-dimensional array of five elements.
ture must equal the rank of array . Each leaf of the nested structure must be of the type given by (make-array '(3 4) :element-type '(mod 16)) ;; Creates a
element-type . If array is zero-dimensional, then initial-contents species the single element . Other- ;;two-dimensional array, 3 by 4, with four-bit elements.
wise, initial-contents must be a sequence whose length is equal to the rst dimension; each element (make-array 5 :element-type 'single-float) ;; Creates an array of single-floats.
must be a nested structure for an array whose dimensions are the remaining dimensions, and so
on. Initial-contents cannot be supplied if either initial-element is supplied or displaced-to is non-nil . (make-array nil :initial-element nil) !
#0ANIL
If initial-contents is not supplied, the consequences of later reading an uninitialized element of (make-array 4 :initial-element nil) !
#(NIL NIL NIL NIL)
new-array are undened unless either initial-element is supplied or displaced-to is non-nil . (make-array '(2 4)
:element-type '(unsigned-byte 2)
If adjustable is non-nil , the array is expressly adjustable (and so actually adjustable ); otherwise,

Arrays 15{11 15{12 Programming Language|Common Lisp

Version 15.17, X3J13/94-101. Version 15.17, X3J13/94-101.
Wed 11-May-1994 6:57pm EDT Wed 11-May-1994 6:57pm EDT

make-array
:initial-contents '((0 1 2 3) (3 2 1 0))) (setq a3 (make-array 50 :fill-pointer 10))
! #2A((0 1 2 3) (3 2 1 0)) ! #<ARRAY 50 fill-pointer 10 46105663>
(make-array 6 (setq b3 (make-array 20 :displaced-to a3 :displaced-index-offset 10
:element-type 'character :fill-pointer 5))
:initial-element #\a ! #<ARRAY 20 indirect, fill-pointer 5 46107432>
:fill-pointer 3) ! "aaa" (length a3) !10
(length b3) !5
The following is an example of making a displaced array .
(setq a (make-array '(4 3)))
See Also:
! #<ARRAY 4x3 simple 32546632> adjustable-array-p, aref , arrayp, array-element-type, array-rank-limit, array-dimension-limit,
(dotimes (i 4) ll-pointer, upgraded-array-element-type
(dotimes (j 3)
(setf (aref a i j) (list i 'x j '= (* i j)))))
Notes:
! NIL There is no specied way to create an array for which adjustable-array-p denitely returns false .
(setq b (make-array 8 :displaced-to a There is no specied way to create an array that is not a simple array .
:displaced-index-offset 2))
! #<ARRAY 8 indirect 32550757>
(dotimes (i 8)
(print (list i (aref b i))))
adjust-array Function
. (0 (0 X 2 = 0))
. (1 (1 X 0 = 0)) Syntax:
. (2 (1 X 1 = 1)) adjust-array array new-dimensions &key element-type
. (3 (1 X 2 = 2)) initial-element
. (4 (2 X 0 = 0)) initial-contents
. (5 (2 X 1 = 2)) ll-pointer
. (6 (2 X 2 = 4)) displaced-to
. (7 (3 X 0 = 0)) displaced-index-oset
! NIL

The last example depends on the fact that arrays are, in eect, stored in row-major order. ! adjusted-array
(setq a1 (make-array 50))
Arguments and Values:
! #<ARRAY 50 simple 32562043> array |an array .
(setq b1 (make-array 20 :displaced-to a1 :displaced-index-offset 10))
! #<ARRAY 20 indirect 32563346> new-dimensions |a valid array dimension or a list of valid array dimensions .
(length b1) ! 20 element-type |a type specier .
(setq a2 (make-array 50 :fill-pointer 10)) initial-element |an object . Initial-element must not be supplied if either initial-contents or
! #<ARRAY 50 fill-pointer 10 46100216> displaced-to is supplied.
(setq b2 (make-array 20 :displaced-to a2 :displaced-index-offset 10))
! #<ARRAY 20 indirect 46104010> initial-contents |an object . If array has rank greater than zero, then initial-contents is composed
(length a2) ! 10
of nested sequences , the depth of which must equal the rank of array . Otherwise, array is zero-
(length b2) ! 20 dimensional and initial-contents supplies the single element. initial-contents must not be supplied if
either initial-element or displaced-to is given.
ll-pointer |a valid ll pointer for the array to be created, or t, or nil. The default is nil.

Arrays 15{13 15{14 Programming Language|Common Lisp

Version 15.17, X3J13/94-101. Version 15.17, X3J13/94-101.
Wed 11-May-1994 6:57pm EDT Wed 11-May-1994 6:57pm EDT

adjust-array adjust-array
displaced-to |an array or nil. initial-elements and initial-contents must not be supplied if displaced- A is displaced to B before the call, and is displaced to C after the call
to is supplied.
(adjust-array A ... :displaced-to B)
displaced-index-oset |an object of type (fixnum 0 n) where n is (array-total-size displaced-to ). (adjust-array A ... :displaced-to C)
displaced-index-oset may be supplied only if displaced-to is supplied.
B and C might be the same. The contents of B do not appear in A afterward unless
adjusted-array |an array . such contents also happen to be in C If displaced-index-oset is not supplied in the
adjust-array call, it defaults to zero; the old oset into B is not retained.
Description:
adjust-array changes the dimensions or elements of array . The result is an array of the same type A is displaced to B before the call, but not displaced afterward.
and rank as array , that is either the modied array , or a newly created array to which array can
be displaced, and that has the given new-dimensions . (adjust-array A ... :displaced-to B)
(adjust-array A ... :displaced-to nil)
New-dimensions specify the size of each dimension of array .
A gets a new \data region," and contents of B are copied into it as appropriate to main-
Element-type species the type of the elements of the resulting array . If element-type is supplied, tain the existing old contents; additional elements of A are taken from initial-element if
the consequences are unspecied if the upgraded array element type of element-type is not the supplied. However, the use of initial-contents causes all old contents to be discarded.
same as the actual array element type of array .
If displaced-index-oset is supplied, it species the oset of the resulting array from the beginning
If initial-contents is supplied, it is treated as for make-array . In this case none of the original of the array that it is displaced to. If displaced-index-oset is not supplied, the oset is 0. The
contents of array appears in the resulting array . size of the resulting array plus the oset value cannot exceed the size of the array that it is
displaced to.
If ll-pointer is an integer , it becomes the ll pointer for the resulting array . If ll-pointer is the
symbol t, it indicates that the size of the resulting array should be used as the ll pointer . If If only new-dimensions and an initial-element argument are supplied, those elements of array that
ll-pointer is nil, it indicates that the ll pointer should be left as it is. are still in bounds appear in the resulting array . The elements of the resulting array that are
not in the bounds of array are initialized to initial-element ; if initial-element is not provided, the
If displaced-to non-nil , a displaced array is created. The resulting array shares its contents consequences of later reading any such new element of new-array before it has been initialized are
with the array given by displaced-to . The resulting array cannot contain more elements than undened.
the array it is displaced to. If displaced-to is not supplied or nil, the resulting array is not a
displaced array . If array A is created displaced to array B and subsequently array B is given If initial-contents or displaced-to is supplied, then none of the original contents of array appears in
to adjust-array , array A will still be displaced to array B . Although array might be a displaced the new array .
array , the resulting array is not a displaced array unless displaced-to is supplied and not nil.
The interaction between adjust-array and displaced arrays is as follows given three arrays , A, B, The consequences are unspecied if array is adjusted to a size smaller than its ll pointer without
and C: supplying the ll-pointer argument so that its ll-pointer is properly adjusted in the process.
If A is displaced to B, the consequences are unspecied if B is adjusted in such a way that it no
A is not displaced before or after the call longer has enough elements to satisfy A.
(adjust-array A ...) If adjust-array is applied to an array that is actually adjustable , the array returned is identical
The dimensions of A are altered, and the contents rearranged as appropriate. Additional to array . If the array returned by adjust-array is distinct from array , then the argument array is
elements of A are taken from initial-element . The use of initial-contents causes all old unchanged.
contents to be discarded. Note that if an array A is displaced to another array B , and B is displaced to another array C ,
and B is altered by adjust-array , A must now refer to the adjust contents of B . This means that
A is not displaced before, but is displaced to C after the call an implementation cannot collapse the chain to make A refer to C directly and forget that the
(adjust-array A ... :displaced-to C)
chain of reference passes through B . However, caching techniques are permitted as long as they
preserve the semantics specied here.
None of the original contents of A appears in A afterwards; A now contains the contents of
C, without any rearrangement of C.

Arrays 15{15 15{16 Programming Language|Common Lisp

Version 15.17, X3J13/94-101. Version 15.17, X3J13/94-101.
Wed 11-May-1994 6:57pm EDT Wed 11-May-1994 6:57pm EDT

Examples: adjustable-array-p Function

(adjustable-array-p
(setq ada (adjust-array Syntax:
(make-array '(2 3)
:adjustable t
adjustable-array-p array ! generalized-boolean
:initial-contents '((a b c) (1 2 3)))
!
Arguments and Values:
'(4 6))))
(array-dimensions ada) !
T
(4 6)
array |an array .
(aref ada 1 1) !2 generalized-boolean|a generalized boolean .
Description:
(setq beta (make-array '(2 3) :adjustable t))
! #2A((NIL NIL NIL) (NIL NIL NIL))
(adjust-array beta '(4 6) :displaced-to ada) Returns true if and only if adjust-array could return a value which is identical to array when
! #2A((A B C NIL NIL NIL) given that array as its rst argument .
(1 2 3 NIL NIL NIL)
(NIL NIL NIL NIL NIL NIL) Examples:
(NIL NIL NIL NIL NIL NIL))
(array-dimensions beta) !
(4 6) (adjustable-array-p
(aref beta 1 1) !
2 (make-array 5
:element-type 'character
Suppose that the 4-by-4 array in m looks like this: :adjustable t
:fill-pointer 3)) ! true
#2A((
(
alpha
epsilon
beta
zeta
gamma
eta
delta
theta
)
)
(adjustable-array-p (make-array 4)) ! implementation-dependent
( iota kappa lambda mu ) Exceptional Situations:
( nu xi omicron pi ))
Should signal an error of type type-error if its argument is not an array .
Then the result of See Also:
(adjust-array m '(3 5) :initial-element 'baz) adjust-array , make-array
is a 3-by-5 array with contents
#2A(( alpha
( epsilon
beta
zeta
gamma
eta
delta
theta
baz )
baz )
aref Accessor
( iota kappa lambda mu baz ))

Exceptional Situations: Syntax:

An error of type error is signaled if ll-pointer is supplied and non-nil but array has no ll aref array &rest subscripts ! element
pointer . (setf (aref array &rest subscripts) new-element)
See Also:
adjustable-array-p, make-array , array-dimension-limit, array-total-size-limit, array Arguments and Values:
array |an array .
subscripts |a list of valid array indices for the array .
element , new-element |an object .

Arrays 15{17 15{18 Programming Language|Common Lisp

Version 15.17, X3J13/94-101. Version 15.17, X3J13/94-101.
Wed 11-May-1994 6:57pm EDT Wed 11-May-1994 6:57pm EDT

Description: Examples:
Accesses the array element specied by the subscripts . If no subscripts are supplied and array is
zero rank, aref accesses the sole element of array . (array-dimension (make-array 4) 0) 4 !
(array-dimension (make-array '(2 3)) 1) ! 3
aref ignores ll pointers . It is permissible to use aref to access any array element , whether active
or not. Aected By:
None.
Examples:
If the variable foo names a 3-by-5 array, then the rst index could be 0, 1, or 2, and then second See Also:
index could be 0, 1, 2, 3, or 4. The array elements can be referred to by using the function aref ; array-dimensions, length
for example, (aref foo 2 1) refers to element (2, 1) of the array.
Notes:
(aref (setq
alpha (make-array 4)) 3) ! implementation-dependent
(setf (aref
alpha 3) 'sirens) !
SIRENS (array-dimension array n)  (nth n (array-dimensions array))
(aref alpha
3) !
SIRENS
(aref (setq
beta (make-array '(2 4)

array-dimensions
:element-type '(unsigned-byte 2)

1 2) 1!
:initial-contents '((0 1 2 3) (3 2 1 0))))
Function
(setq gamma '(0 2))
(apply #'aref beta gamma) !
2
Syntax:
(setf (apply #'aref beta gamma) 3) 3! array-dimensions array ! dimensions
(apply #'aref beta gamma) !
3
(aref beta 0 2) 3! Arguments and Values:
See Also: array |an array .
bit, char, elt, row-major-aref , svref , Section 3.2.1 (Compiler Terminology) dimensions |a list of integers .
Description:
array-dimension Function Returns a list of the dimensions of array . (If array is a vector with a ll pointer , that ll pointer
is ignored.)
Syntax: Examples:
array-dimension array axis-number ! dimension (array-dimensions (make-array 4)) !
(4)
Arguments and Values: (array-dimensions (make-array '(2 3))) !
(2 3)

array |an array . (array-dimensions (make-array 4 :fill-pointer 2)) ! (4)

axis-number |an integer greater than or equal to zero and less than the rank of the array . Exceptional Situations:
Should signal an error of type type-error if its argument is not an array .
dimension|a non-negative integer .
See Also:
Description: array-dimension
array-dimension returns the axis-number dimension 1 of array . (Any ll pointer is ignored.)

Arrays 15{19 15{20 Programming Language|Common Lisp

Version 15.17, X3J13/94-101. Version 15.17, X3J13/94-101.
Wed 11-May-1994 6:57pm EDT Wed 11-May-1994 6:57pm EDT

array-element-type Function Arguments and Values:

array |an array .
Syntax: generalized-boolean|a generalized boolean .
array-element-type array ! typespec Description:
Arguments and Values: Returns true if array has a ll pointer ; otherwise returns false .
array |an array . Examples:
typespec |a type specier .
(array-has-fill-pointer-p (make-array 4)) ! implementation-dependent
Description: (array-has-fill-pointer-p (make-array '(2 3))) ! false
Returns a type specier which represents the actual array element type of the array, which is the (array-has-fill-pointer-p
set of objects that such an array can hold. (Because of array upgrading , this type specier can in (make-array 8
some cases denote a supertype of the expressed array element type of the array .) :fill-pointer 2
:initial-element 'filler)) ! true
Examples: Exceptional Situations:
(array-element-type (make-array 4)) !
T Should signal an error of type type-error if its argument is not an array .
See Also:
(array-element-type (make-array 12 :element-type '(unsigned-byte 8)))
! implementation-dependent
(array-element-type (make-array 12 :element-type '(unsigned-byte 5))) make-array , ll-pointer
! implementation-dependent
Notes:
(array-element-type (make-array 5 :element-type '(mod 5)))
Since arrays of rank other than one cannot have a ll pointer , array-has-ll-pointer-p always
could be (mod 5), (mod 8), fixnum, t, or any other type of which (mod 5) is a subtype . returns nil when its argument is such an array.
Aected By:
The implementation . array-displacement Function
Exceptional Situations:
Should signal an error of type type-error if its argument is not an array . Syntax:
See Also: array-displacement array ! displaced-to, displaced-index-oset
array , make-array , subtypep, upgraded-array-element-type Arguments and Values:
array |an array .
array-has-ll-pointer-p Function displaced-to |an array or nil.
displaced-index-oset |a non-negative xnum .
Syntax: Description:
array-has-ll-pointer-p array ! generalized-boolean If the array is a displaced array , returns the values of the :displaced-to and
:displaced-index-offset options for the array (see the functions make-array and adjust-array ).
If the array is not a displaced array , nil and 0 are returned.

Arrays 15{21 15{22 Programming Language|Common Lisp

Version 15.17, X3J13/94-101. Version 15.17, X3J13/94-101.
Wed 11-May-1994 6:57pm EDT Wed 11-May-1994 6:57pm EDT

If array-displacement is called on an array for which a non-nil object was provided as the (array-in-bounds-p a 0 0) ! true
:displaced-to argument to make-array or adjust-array , it must return that object as its rst (array-in-bounds-p a 6 10) ! true
value. It is implementation-dependent whether array-displacement returns a non-nil primary (array-in-bounds-p a 0 -1) ! false
value for any other array . (array-in-bounds-p a 0 11) ! false
! false
Examples: (array-in-bounds-p a 7 0)

!
See Also:
(setq a1 (make-array 5)) #<ARRAY 5 simple 46115576>
(setq a2 (make-array 4 :displaced-to a1
array-dimensions
!
:displaced-index-offset 1))
#<ARRAY 4 indirect 46117134>
Notes:
(array-displacement a2) (array-in-bounds-p array subscripts)
! #<ARRAY 5 simple 46115576>, 1  (and (not (some #'minusp (list subscripts)))
(setq a3 (make-array 2 :displaced-to a2 (every #'< (list subscripts) (array-dimensions array)))
:displaced-index-offset 2))
! #<ARRAY 2 indirect 46122527>

array-rank
(array-displacement a3)
! #<ARRAY 4 indirect 46117134>, 2
Function
Exceptional Situations:
Should signal an error of type type-error if array is not an array . Syntax:
See Also: array-rank array ! rank
make-array Arguments and Values:
array |an array .
array-in-bounds-p Function rank |a non-negative integer .
Description:
Syntax: Returns the number of dimensions of array .
array-in-bounds-p array &rest subscripts ! generalized-boolean
Examples:
Arguments and Values: !
array |an array . (array-rank
(array-rank
(make-array
(make-array
'()))
4)) ! 1
0

subscripts |a list of integers of length equal to the rank of the array . (array-rank (make-array '(4))) ! 1
(array-rank (make-array '(2 3)))! 2
generalized-boolean|a generalized boolean .
Exceptional Situations:
Description: Should signal an error of type type-error if its argument is not an array .
Returns true if the subscripts are all in bounds for array ; otherwise returns false . (If array is a
vector with a ll pointer , that ll pointer is ignored.) See Also:
array-rank-limit, make-array
Examples:
(setq a (make-array '(7 11) :element-type 'string-char))

Arrays 15{23 15{24 Programming Language|Common Lisp

Version 15.17, X3J13/94-101. Version 15.17, X3J13/94-101.
Wed 11-May-1994 6:57pm EDT Wed 11-May-1994 6:57pm EDT

array-row-major-index Function array-total-size Function

Syntax: Syntax:
array-row-major-index array &rest subscripts ! index array-total-size array ! size
Arguments and Values: Arguments and Values:
array |an array . array |an array .
subscripts |a list of valid array indices for the array . size |a non-negative integer .
index |a valid array row-major index for the array . Description:
Description: Returns the array total size of the array .
Computes the position according to the row-major ordering of array for the element that is Examples:
specied by subscripts , and returns the oset of the element in the computed position from the
beginning of array . (array-total-size (make-array 4)) ! 4
(array-total-size (make-array 4 :fill-pointer 2)) !4
For a one-dimensional array , the result of array-row-major-index equals subscript . (array-total-size (make-array 0)) ! 0

array-row-major-index ignores ll pointers . (array-total-size (make-array '(4 2))) !8

(array-total-size (make-array '(4 0))) !0
Examples: (array-total-size (make-array '())) ! 1

(setq a (make-array '(4 7) :element-type '(unsigned-byte 8))) Exceptional Situations:

(array-row-major-index a 1 2) 9 ! Should signal an error of type type-error if its argument is not an array .
(array-row-major-index
(make-array '(2 3 4) See Also:
:element-type '(unsigned-byte 8) make-array , array-dimensions
:displaced-to a
:displaced-index-offset 4) Notes:
0 2 1) ! 9 If the array is a vector with a ll pointer , the ll pointer is ignored when calculating the array
total size .
Notes: Since the product of no arguments is one, the array total size of a zero-dimensional array is one.
A possible denition of array-row-major-index, with no error-checking, is
(array-total-size x)
(defun array-row-major-index (a &rest subscripts)
 (apply #'* (array-dimensions x))
(apply #'+ (maplist #'(lambda (x y)
(* (car x) (apply #'* (cdr y))))
 (reduce #'* (array-dimensions x))
subscripts
(array-dimensions a))))

Arrays 15{25 15{26 Programming Language|Common Lisp

Version 15.17, X3J13/94-101. Version 15.17, X3J13/94-101.
Wed 11-May-1994 6:57pm EDT Wed 11-May-1994 6:57pm EDT

arrayp Function Description:

Accesses the ll pointer of vector .
Syntax: Examples:
arrayp object ! generalized-boolean
(setq a (make-array 8 :fill-pointer 4)) !
#(NIL NIL NIL NIL)
Arguments and Values: (fill-pointer a) !4
!
object |an object . (dotimes (i (length a)) (setf (aref a i) (* i i))) NIL
a ! #(0 1 4 9)
generalized-boolean|a generalized boolean . (setf (fill-pointer a) 3) 3!
!
Description:
(fill-pointer a) 3
a ! #(0 1 4)
Returns true if object is of type array ; otherwise, returns false . (setf (fill-pointer a) 8) 8!
!
Examples:
a #(0 1 4 9 NIL NIL NIL NIL)

Exceptional Situations:
(arrayp (make-array '(2 3 4) :adjustable t)) ! true Should signal an error of type type-error if vector is not a vector with a ll pointer .
(arrayp (make-array 6)) ! true
(arrayp #*1011)! true See Also:
(arrayp "hi")! true make-array , length
(arrayp 'hi)! false
(arrayp 12) ! false Notes:
See Also: There is no operator that will remove a vector 's ll pointer .
typep
Notes: row-major-aref Accessor
object )  object
Syntax:
(arrayp (typep 'array)

row-major-aref array index ! element

ll-pointer Accessor (setf (row-major-aref array index) new-element)

Syntax: Arguments and Values:

array |an array .
ll-pointer vector ! ll-pointer
index |a valid array row-major index for the array .
(setf (ll-pointer vector) new-ll-pointer)
element , new-element |an object .
Arguments and Values: Description:
vector |a vector with a ll pointer . Considers array as a vector by viewing its elements in row-major order, and returns the element
of that vector which is referred to by the given index .
ll-pointer , new-ll-pointer |a valid ll pointer for the vector .
row-major-aref is valid for use with setf .

Arrays 15{27 15{28 Programming Language|Common Lisp

Version 15.17, X3J13/94-101. Version 15.17, X3J13/94-101.
Wed 11-May-1994 6:57pm EDT Wed 11-May-1994 6:57pm EDT

See Also: Notes:

aref , array-row-major-index Except for storage allocation consequences and dealing correctly with the optional environment
argument , upgraded-array-element-type could be dened as:
Notes: (defun upgraded-array-element-type (type &optional environment)
(row-major-aref array index)  (array-element-type (make-array 0 :element-type type)))
(aref (make-array (array-total-size array)
:displaced-to array

array-dimension-limit
:element-type (array-element-type array))
index)
Constant Variable
(aref array i1 i2 ...) 
(row-major-aref array (array-row-major-index array i1 i2))
Constant Value:
A positive xnum , the exact magnitude of which is implementation-dependent , but which is not
less than 1024.
upgraded-array-element-type Function Description:
The upper exclusive bound on each individual dimension of an array .
Syntax: See Also:
upgraded-array-element-type typespec &optional environment ! upgraded-typespec make-array
Arguments and Values:
typespec |a type specier . array-rank-limit Constant Variable
environment |an environment object . The default is nil, denoting the null lexical environment
and the current global environment .
Constant Value:
upgraded-typespec |a type specier . A positive xnum , the exact magnitude of which is implementation-dependent , but which is not
less than 8.
Description:
Returns the element type of the most specialized array representation capable of holding items of Description:
the type denoted by typespec . The upper exclusive bound on the rank of an array .
The typespec is a subtype of (and possibly type equivalent to) the upgraded-typespec . See Also:
If typespec is bit, the result is type equivalent to bit. If typespec is base-char, the result is type make-array
equivalent to base-char. If typespec is character, the result is type equivalent to character.
The purpose of upgraded-array-element-type is to reveal how an implementation does its
upgrading .
The environment is used to expand any derived type speciers that are mentioned in the typespec .
See Also:
array-element-type, make-array

Arrays 15{29 15{30 Programming Language|Common Lisp

Version 15.17, X3J13/94-101. Version 15.17, X3J13/94-101.
Wed 11-May-1994 6:57pm EDT Wed 11-May-1994 6:57pm EDT

array-total-size-limit Constant Variable

Constant Value: svref Accessor

A positive xnum , the exact magnitude of which is implementation-dependent , but which is not
less than 1024. Syntax:
Description: svref simple-vector index ! element
The upper exclusive bound on the array total size of an array . (setf (svref simple-vector index) new-element)
The actual limit on the array total size imposed by the implementation might vary according the
element type of the array ; in this case, the value of array-total-size-limit will be the smallest of Arguments and Values:
these possible limits. simple-vector |a simple vector .
See Also: index |a valid array index for the simple-vector .
make-array , array-element-type
element , new-element |an object (whose type is a subtype of the array element type of the simple-
vector ).
simple-vector-p Function Description:
Accesses the element of simple-vector specied by index .
Syntax: Examples:
simple-vector-p object ! generalized-boolean
! true
Arguments and Values:
(simple-vector-p (setq v (vector 1 2 'sirens)))
(svref v 0) ! 1
object |an object . (svref v 2) ! SIRENS
(setf (svref v 1) 'newcomer) !
NEWCOMER
generalized-boolean|a generalized boolean . v ! #(1 NEWCOMER SIRENS)

Description: See Also:

Returns true if object is of type simple-vector; otherwise, returns false .. aref , sbit, schar, vector, Section 3.2.1 (Compiler Terminology)
Examples: Notes:
(simple-vector-p (make-array 6)) ! true svref is identical to aref except that it requires its rst argument to be a simple vector .
(simple-vector-p "aaaaaa") ! false (svref v i )  (aref (the simple-vector v ) i )
(simple-vector-p (make-array 6 :fill-pointer t)) ! false
See Also:
simple-vector
Notes:
(simple-vector-p object )  (typep object 'simple-vector)

Arrays 15{31 15{32 Programming Language|Common Lisp

Version 15.17, X3J13/94-101. Version 15.17, X3J13/94-101.
Wed 11-May-1994 6:57pm EDT Wed 11-May-1994 6:57pm EDT

vector Function Description:

Decreases the ll pointer of vector by one, and retrieves the element of vector that is designated
by the new ll pointer .
Syntax:
vector &rest objects ! vector Examples:
Arguments and Values: (vector-push (setq fable (list 'fable))
object |an object . (setq fa (make-array 8
:fill-pointer 2
vector |a vector of type (vector t *). :initial-element 'sisyphus))) !2
!
Description:
(fill-pointer fa) 3
(eq (vector-pop fa) fable) ! true
Creates a fresh simple general vector whose size corresponds to the number of objects . (vector-pop fa) !SISYPHUS
(fill-pointer fa) ! 1
The vector is initialized to contain the objects .
Examples: Side Eects:
The ll pointer is decreased by one.
(arrayp (setq v (vector 1 2 'sirens)))
! true
! true Aected By:
(vectorp v)
(simple-vector-p v)! true The value of the ll pointer .
(length v) ! 3
Exceptional Situations:
See Also: An error of type type-error is signaled if vector does not have a ll pointer .
make-array If the ll pointer is zero, vector-pop signals an error of type error.
Notes: See Also:
vector is analogous to list. vector-push, vector-push-extend, ll-pointer
(vector a1 a2 ... an)
 (make-array (list n) :element-type t
:initial-contents
(list a1 a2 ... an ))
vector-push, vector-push-extend Function

Syntax:
vector-push new-element vector ! new-index-p
vector-pop Function vector-push-extend new-element vector &optional extension ! new-index
Syntax: Arguments and Values:
new-element |an object .
vector-pop vector ! element
vector |a vector with a ll pointer .
Arguments and Values:
vector |a vector with a ll pointer . extension|a positive integer . The default is implementation-dependent .
element |an object . new-index-p |a valid array index for vector , or nil.

Arrays 15{33 15{34 Programming Language|Common Lisp

Version 15.17, X3J13/94-101. Version 15.17, X3J13/94-101.
Wed 11-May-1994 6:57pm EDT Wed 11-May-1994 6:57pm EDT

vector-push, vector-push-extend
new-index |a valid array index for vector . See Also:
adjustable-array-p, ll-pointer, vector-pop
Description:
vector-push and vector-push-extend store new-element in vector . vector-push attempts to store
new-element in the element of vector designated by the ll pointer , and to increase the ll pointer
by one. If the (>= (fill-pointer vector ) (array-dimension vector 0)), neither vector nor its ll vectorp Function
pointer are aected. Otherwise, the store and increment take place and vector-push returns the
former value of the ll pointer which is one less than the one it leaves in vector . Syntax:
vector-push-extend is just like vector-push except that if the ll pointer gets too large, vector vectorp object ! generalized-boolean
is extended using adjust-array so that it can contain more elements. Extension is the minimum
number of elements to be added to vector if it must be extended. Arguments and Values:
object |an object .
vector-push and vector-push-extend return the index of new-element in vector . If
(>= (fill-pointer vector ) (array-dimension vector 0)), vector-push returns nil. generalized-boolean|a generalized boolean .
Examples: Description:
Returns true if object is of type vector; otherwise, returns false .
(vector-push (setq fable (list 'fable))
(setq fa (make-array 8
:fill-pointer 2
Examples:
:initial-element 'first-one))) !2 (vectorp "aaaaaa") ! true
(fill-pointer fa) ! 3 (vectorp (make-array 6 :fill-pointer t)) ! true
(eq (aref fa 2) fable) ! true (vectorp (make-array '(2 3 4))) ! false
(vector-push-extend #\X (vectorp #*11) ! true
(setq aa (vectorp #b11) ! false
(make-array 5
:element-type 'character Notes:
:adjustable t
:fill-pointer 3))) 3 ! (vectorp object )  (typep object 'vector)
(fill-pointer aa) ! 4
(vector-push-extend #\Y aa 4) 4 !
!
bit, sbit
(array-total-size aa) at least 5
(vector-push-extend #\Z aa 4) 5 ! Accessor
(array-total-size aa) !
9 ;(or more)

Aected By: Syntax:

The value of the ll pointer . bit bit-array &rest subscripts ! bit
How vector was created. sbit bit-array &rest subscripts ! bit
Exceptional Situations: (setf (bit bit-array &rest subscripts) new-bit)
(setf (sbit bit-array &rest subscripts) new-bit)
An error of type error is signaled by vector-push-extend if it tries to extend vector and vector is
not actually adjustable . Arguments and Values:
An error of type error is signaled if vector does not have a ll pointer . bit-array |for bit, a bit array ; for sbit, a simple bit array .

Arrays 15{35 15{36 Programming Language|Common Lisp

Version 15.17, X3J13/94-101. Version 15.17, X3J13/94-101.
Wed 11-May-1994 6:57pm EDT Wed 11-May-1994 6:57pm EDT

bit-and, bit-andc1, bit-andc2, bit-eqv, bit-ior, : : :

subscripts |a list of valid array indices for the bit-array . bit-orc2 bit-array1 bit-array2 &optional opt-arg ! resulting-bit-array
bit-xor bit-array1 bit-array2 &optional opt-arg ! resulting-bit-array
bit |a bit .
bit-not bit-array &optional opt-arg ! resulting-bit-array
Description:
bit and sbit access the bit-array element specied by subscripts . Arguments and Values:
bit-array , bit-array1 , bit-array2 |a bit array .
These functions ignore the ll pointer when accessing elements .
Opt-arg |a bit array , or t, or nil. The default is nil.
Examples:
Bit-array , bit-array1 , bit-array2 , and opt-arg (if an array ) must all be of the same rank and dimen-
(bit (setq ba (make-array 8 sions .
:element-type 'bit
:initial-element 1)) resulting-bit-array |a bit array .
3) ! 1
Description:
(setf (bit ba 3) 0) !
0
(bit ba 3) ! 0 These functions perform bit-wise logical operations on bit-array1 and bit-array2 and return an
(sbit ba 5) ! 1 array of matching rank and dimensions , such that any given bit of the result is produced by
(setf (sbit ba 5) 1) !
1 operating on corresponding bits from each of the arguments.
(sbit ba 5) ! 1
In the case of bit-not, an array of rank and dimensions matching bit-array is returned that
See Also: contains a copy of bit-array with all the bits inverted.
aref , Section 3.2.1 (Compiler Terminology) If opt-arg is of type (array bit) the contents of the result are destructively placed into opt-arg .
Notes: If opt-arg is the symbol t, bit-array or bit-array1 is replaced with the result; if opt-arg is nil or
omitted, a new array is created to contain the result.
bit and sbit are like aref except that they require arrays to be a bit array and a simple bit array ,
respectively. Figure 15{4 indicates the logical operation performed by each of the functions .
bit and sbit, unlike char and schar, allow the rst argument to be an array of any rank . Function Operation
bit-and and
bit-and, bit-andc1, bit-andc2, bit-eqv, bit-ior, bit- bit-eqv equivalence (exclusive nor)
nand,
Function
bit-nor, bit-not, bit-orc1, bit-orc2, bit-xor bit-not
bit-ior
bit-xor
complement
inclusive or
exclusive or
bit-nand complement of bit-array1 and bit-array2
bit-nor complement of bit-array1 or bit-array2
Syntax: bit-andc1
bit-andc2
and complement of bit-array1 with bit-array2
and bit-array1 with complement of bit-array2
bit-and bit-array1 bit-array2 &optional opt-arg ! resulting-bit-array bit-orc1 or complement of bit-array1 with bit-array2
bit-andc1 bit-array1 bit-array2 &optional opt-arg ! resulting-bit-array bit-orc2 or bit-array1 with complement of bit-array2
bit-andc2 bit-array1 bit-array2 &optional opt-arg ! resulting-bit-array
bit-eqv bit-array1 bit-array2 &optional opt-arg ! resulting-bit-array
bit-ior bit-array1 bit-array2 &optional opt-arg ! resulting-bit-array Figure 15{4. Bit-wise Logical Operations on Bit Arrays
bit-nand bit-array1 bit-array2 &optional opt-arg ! resulting-bit-array
bit-nor bit-array1 bit-array2 &optional opt-arg ! resulting-bit-array
bit-orc1 bit-array1 bit-array2 &optional opt-arg ! resulting-bit-array

Arrays 15{37 15{38 Programming Language|Common Lisp

Version 15.17, X3J13/94-101. Version 15.17, X3J13/94-101.
Wed 11-May-1994 6:57pm EDT Wed 11-May-1994 6:57pm EDT

Examples: Notes:
(bit-and (setq ba #*11101010) #*01101011) !
#*01101010 (bit-vector-p object )  (typep object 'bit-vector)
(bit-and #*1100 #*1010) !
#*1000
(bit-andc1 #*1100 #*1010) !#*0010
!
simple-bit-vector-p
(setq rba (bit-andc2 ba #*00110011 t)) #*11001000
(eq rba ba) ! true Function
(bit-not (setq ba #*11101010)) !
#*00010101
(setq rba (bit-not ba
(setq tba (make-array 8
:element-type 'bit))))
Syntax:
! #*00010101 simple-bit-vector-p object ! generalized-boolean
(equal rba tba) ! true Arguments and Values:
(bit-xor #*1100 #*1010) !
#*0110
object |an object .
See Also: generalized-boolean|a generalized boolean .
lognot, logand
Description:
bit-vector-p Function
Examples:
Returns true if object is of type simple-bit-vector; otherwise, returns false .

Syntax: (simple-bit-vector-p (make-array 6))

! true
! false
bit-vector-p object ! generalized-boolean (simple-bit-vector-p #*)

Arguments and Values: See Also:

object |an object . simple-vector-p
generalized-boolean|a generalized boolean . Notes:
Description: (simple-bit-vector-p object )  (typep object 'simple-bit-vector)
Returns true if object is of type bit-vector; otherwise, returns false .
Examples:
(bit-vector-p (make-array 6
:element-type 'bit
:fill-pointer t)) ! true
(bit-vector-p #*) ! true
(bit-vector-p (make-array 6)) ! false
See Also:
typep

Arrays 15{39 15{40 Programming Language|Common Lisp