This is the cl-ewkb Reference Manual, version 0.2, generated automatically by Declt version 4.0 beta 2 "William Riker" on Tue Jul 15 03:49:19 2025 GMT+0.
The main system appears first, followed by any subsystem dependency.
cl-ewkbcl-ewkb is a geospatial library, based on cl-wkb, that implements the OGC Well-Known Binary geographic geometry data model with PostGIS 3d, 4d extensions, and provides WKB and EWKB encoding and decoding functionality. cl-wkb author is J.P. Larocue.
Michael Filonenko <filonenko.mikhail@gmail.com>
Michael Filonenko <filonenko.mikhail@gmail.com>
MIT
0.2
ieee-floats (system).
flexi-streams (system).
Modules are listed depth-first from the system components tree.
cl-ewkb/cl-ewkbcl-ewkb (system).
package.lisp (file).
ewkb.lisp (file).
cl-ewkb/cl-wkbcl-ewkb (system).
package.lisp (file).
wkb.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
cl-ewkb/cl-ewkb.asdcl-ewkb/cl-ewkb/package.lispcl-ewkb/cl-ewkb/ewkb.lispcl-ewkb/cl-wkb/package.lispcl-ewkb/cl-wkb/wkb.lispcl-ewkb/cl-ewkb/ewkb.lisppackage.lisp (file).
cl-ewkb (module).
decode (function).
decode-from (function).
encode (function).
encode-to (function).
geometry-collection-geometries (function).
(setf geometry-collection-geometries) (function).
geometry-collection-p (function).
geometry-p (function).
geometry-srid (function).
(setf geometry-srid) (function).
geometry-type (function).
(setf geometry-type) (function).
line-string-p (function).
line-string-points-primitive (function).
(setf line-string-points-primitive) (function).
linear-ring-p (function).
linear-ring-points-primitive (function).
(setf linear-ring-points-primitive) (function).
make-geometry-collection (function).
make-line-string (function).
make-linear-ring (function).
make-multi-line-string (function).
make-multi-point (function).
make-multi-polygon (function).
make-point (function).
make-point-primitive (function).
make-pointm-primitive (function).
make-pointz-primitive (function).
make-pointzm-primitive (function).
make-polygon (function).
multi-line-string-line-strings (function).
(setf multi-line-string-line-strings) (function).
multi-line-string-p (function).
multi-point-p (function).
multi-point-points (function).
(setf multi-point-points) (function).
multi-polygon-p (function).
multi-polygon-polygons (function).
(setf multi-polygon-polygons) (function).
point-p (function).
point-point-primitive (function).
(setf point-point-primitive) (function).
point-primitive-p (function).
point-primitive-x (function).
(setf point-primitive-x) (function).
point-primitive-y (function).
(setf point-primitive-y) (function).
pointm-primitive-m (function).
(setf pointm-primitive-m) (function).
pointm-primitive-p (function).
pointz-primitive-p (function).
pointz-primitive-z (function).
(setf pointz-primitive-z) (function).
pointzm-primitive-m (function).
(setf pointzm-primitive-m) (function).
pointzm-primitive-p (function).
polygon-linear-rings (function).
(setf polygon-linear-rings) (function).
polygon-p (function).
+endiannesses+ (special variable).
+wkb-m+ (special variable).
+wkb-srid+ (special variable).
+wkb-typemask+ (special variable).
+wkb-types+ (special variable).
+wkb-z+ (special variable).
decode-ieee754-double (function).
decode-ieee754-double-from (function).
decode-linear-ring (function).
decode-primitive-point (function).
decode-uint32 (function).
decode-uint32-from (function).
decode-uint64 (function).
decode-uint64-from (function).
decode-uint8 (function).
decode-uint8-from (function).
def-uint-decoder (macro).
def-uint-encoder (macro).
define-stream-decoder (macro).
define-stream-encoder (macro).
defstruct-and-export (macro).
dimension (function).
encode-ieee754-double (function).
encode-ieee754-double-to (function).
encode-linear-ring (function).
encode-primitive-point (function).
encode-uint32 (function).
encode-uint32-to (function).
encode-uint64 (function).
encode-uint64-to (function).
encode-uint8 (function).
encode-uint8-to (function).
encoded-ieee754-double (type).
encoded-uint32 (type).
encoded-uint64 (type).
encoded-uint8 (type).
generic-decode-primitive-point (generic function).
generic-encode-primitive-point (generic function).
geometry (type).
geometry-collection (type).
geometry-collection-srid (function).
(setf geometry-collection-srid) (function).
geometry-collection-type (function).
(setf geometry-collection-type) (function).
ieee754-double (type).
line-string (type).
line-string-srid (function).
(setf line-string-srid) (function).
line-string-type (function).
(setf line-string-type) (function).
linear-ring (type).
make-gisgeometry (function).
multi-line-string (type).
multi-line-string-srid (function).
(setf multi-line-string-srid) (function).
multi-line-string-type (function).
(setf multi-line-string-type) (function).
multi-point (type).
multi-point-srid (function).
(setf multi-point-srid) (function).
multi-point-type (function).
(setf multi-point-type) (function).
multi-polygon (type).
multi-polygon-srid (function).
(setf multi-polygon-srid) (function).
multi-polygon-type (function).
(setf multi-polygon-type) (function).
point (type).
point-primitive (type).
point-srid (function).
(setf point-srid) (function).
point-type (function).
(setf point-type) (function).
pointm-primitive (type).
pointm-primitive-x (function).
(setf pointm-primitive-x) (function).
pointm-primitive-y (function).
(setf pointm-primitive-y) (function).
pointz-primitive (type).
pointz-primitive-x (function).
(setf pointz-primitive-x) (function).
pointz-primitive-y (function).
(setf pointz-primitive-y) (function).
pointzm-primitive (type).
pointzm-primitive-x (function).
(setf pointzm-primitive-x) (function).
pointzm-primitive-y (function).
(setf pointzm-primitive-y) (function).
pointzm-primitive-z (function).
(setf pointzm-primitive-z) (function).
polygon (type).
polygon-srid (function).
(setf polygon-srid) (function).
polygon-type (function).
(setf polygon-type) (function).
strictly-encoded-ieee754-double (type).
strictly-encoded-uint32 (type).
strictly-encoded-uint64 (type).
strictly-encoded-uint8 (type).
uint32 (type).
uint64 (type).
uint8 (type).
cl-ewkb/cl-wkb/wkb.lisppackage.lisp (file).
cl-wkb (module).
decode (function).
decode-from (function).
encode (function).
encode-to (function).
geometries (reader method).
(setf geometries) (writer method).
geometry (class).
geometry-collection (class).
ieee754-double (type).
initialize-instance (method).
line-string (class).
line-strings (reader method).
(setf line-strings) (writer method).
linear-ring (class).
linear-rings (reader method).
(setf linear-rings) (writer method).
m (method).
m (reader method).
multi-line-string (class).
multi-point (class).
multi-polygon (class).
point (class).
point-primitive (reader method).
point-primitive (class).
points (reader method).
(setf points) (writer method).
points-primitive (reader method).
points-primitive (reader method).
(setf points-primitive) (writer method).
(setf points-primitive) (writer method).
polygon (class).
polygons (reader method).
(setf polygons) (writer method).
print-object (method).
print-object (method).
print-object (method).
print-object (method).
print-object (method).
print-object (method).
print-object (method).
x (method).
x (reader method).
y (method).
y (reader method).
z (method).
z (reader method).
+endiannesses+ (special variable).
+wkb-m+ (special variable).
+wkb-srid+ (special variable).
+wkb-typemask+ (special variable).
+wkb-types+ (special variable).
+wkb-z+ (special variable).
decode-ieee754-double (function).
decode-ieee754-double-from (function).
decode-linear-ring (function).
decode-primitive-point (function).
decode-uint32 (function).
decode-uint32-from (function).
decode-uint64 (function).
decode-uint64-from (function).
decode-uint8 (function).
decode-uint8-from (function).
def-uint-decoder (macro).
def-uint-encoder (macro).
define-stream-decoder (macro).
define-stream-encoder (macro).
dimension (function).
encode-ieee754-double (function).
encode-ieee754-double-to (function).
encode-linear-ring (function).
encode-primitive-point (function).
encode-uint32 (function).
encode-uint32-to (function).
encode-uint64 (function).
encode-uint64-to (function).
encode-uint8 (function).
encode-uint8-to (function).
encoded-ieee754-double (type).
encoded-uint32 (type).
encoded-uint64 (type).
encoded-uint8 (type).
generic-decode-primitive-point (generic function).
generic-encode-primitive-point (generic function).
geomtype (reader method).
(setf geomtype) (writer method).
srid (reader method).
(setf srid) (writer method).
strictly-encoded-ieee754-double (type).
strictly-encoded-uint32 (type).
strictly-encoded-uint64 (type).
strictly-encoded-uint8 (type).
uint32 (type).
uint64 (type).
uint8 (type).
Packages are listed by definition order.
cl-ewkbcommon-lisp.
flexi-streams.
ieee-floats.
copy-geometry (function).
copy-geometry-collection (function).
copy-line-string (function).
copy-linear-ring (function).
copy-multi-line-string (function).
copy-multi-point (function).
copy-multi-polygon (function).
copy-point (function).
copy-point-primitive (function).
copy-pointm-primitive (function).
copy-pointz-primitive (function).
copy-pointzm-primitive (function).
copy-polygon (function).
decode (function).
decode-from (function).
encode (function).
encode-to (function).
geometry-collection-geometries (function).
(setf geometry-collection-geometries) (function).
geometry-collection-p (function).
geometry-p (function).
geometry-srid (function).
(setf geometry-srid) (function).
geometry-type (function).
(setf geometry-type) (function).
line-string-p (function).
line-string-points-primitive (function).
(setf line-string-points-primitive) (function).
linear-ring-p (function).
linear-ring-points-primitive (function).
(setf linear-ring-points-primitive) (function).
make-geometry-collection (function).
make-line-string (function).
make-linear-ring (function).
make-multi-line-string (function).
make-multi-point (function).
make-multi-polygon (function).
make-point (function).
make-point-primitive (function).
make-pointm-primitive (function).
make-pointz-primitive (function).
make-pointzm-primitive (function).
make-polygon (function).
multi-line-string-line-strings (function).
(setf multi-line-string-line-strings) (function).
multi-line-string-p (function).
multi-point-p (function).
multi-point-points (function).
(setf multi-point-points) (function).
multi-polygon-p (function).
multi-polygon-polygons (function).
(setf multi-polygon-polygons) (function).
point-p (function).
point-point-primitive (function).
(setf point-point-primitive) (function).
point-primitive-p (function).
point-primitive-x (function).
(setf point-primitive-x) (function).
point-primitive-y (function).
(setf point-primitive-y) (function).
pointm-primitive-m (function).
(setf pointm-primitive-m) (function).
pointm-primitive-p (function).
pointz-primitive-p (function).
pointz-primitive-z (function).
(setf pointz-primitive-z) (function).
pointzm-primitive-m (function).
(setf pointzm-primitive-m) (function).
pointzm-primitive-p (function).
polygon-linear-rings (function).
(setf polygon-linear-rings) (function).
polygon-p (function).
+endiannesses+ (special variable).
+wkb-m+ (special variable).
+wkb-srid+ (special variable).
+wkb-typemask+ (special variable).
+wkb-types+ (special variable).
+wkb-z+ (special variable).
decode-ieee754-double (function).
decode-ieee754-double-from (function).
decode-linear-ring (function).
decode-primitive-point (function).
decode-uint32 (function).
decode-uint32-from (function).
decode-uint64 (function).
decode-uint64-from (function).
decode-uint8 (function).
decode-uint8-from (function).
def-uint-decoder (macro).
def-uint-encoder (macro).
define-stream-decoder (macro).
define-stream-encoder (macro).
defstruct-and-export (macro).
dimension (function).
encode-ieee754-double (function).
encode-ieee754-double-to (function).
encode-linear-ring (function).
encode-primitive-point (function).
encode-uint32 (function).
encode-uint32-to (function).
encode-uint64 (function).
encode-uint64-to (function).
encode-uint8 (function).
encode-uint8-to (function).
encoded-ieee754-double (type).
encoded-uint32 (type).
encoded-uint64 (type).
encoded-uint8 (type).
generic-decode-primitive-point (generic function).
generic-encode-primitive-point (generic function).
geometry (type).
geometry-collection (type).
geometry-collection-srid (function).
(setf geometry-collection-srid) (function).
geometry-collection-type (function).
(setf geometry-collection-type) (function).
ieee754-double (type).
line-string (type).
line-string-srid (function).
(setf line-string-srid) (function).
line-string-type (function).
(setf line-string-type) (function).
linear-ring (type).
make-gisgeometry (function).
multi-line-string (type).
multi-line-string-srid (function).
(setf multi-line-string-srid) (function).
multi-line-string-type (function).
(setf multi-line-string-type) (function).
multi-point (type).
multi-point-srid (function).
(setf multi-point-srid) (function).
multi-point-type (function).
(setf multi-point-type) (function).
multi-polygon (type).
multi-polygon-srid (function).
(setf multi-polygon-srid) (function).
multi-polygon-type (function).
(setf multi-polygon-type) (function).
point (type).
point-primitive (type).
point-srid (function).
(setf point-srid) (function).
point-type (function).
(setf point-type) (function).
pointm-primitive (type).
pointm-primitive-x (function).
(setf pointm-primitive-x) (function).
pointm-primitive-y (function).
(setf pointm-primitive-y) (function).
pointz-primitive (type).
pointz-primitive-x (function).
(setf pointz-primitive-x) (function).
pointz-primitive-y (function).
(setf pointz-primitive-y) (function).
pointzm-primitive (type).
pointzm-primitive-x (function).
(setf pointzm-primitive-x) (function).
pointzm-primitive-y (function).
(setf pointzm-primitive-y) (function).
pointzm-primitive-z (function).
(setf pointzm-primitive-z) (function).
polygon (type).
polygon-srid (function).
(setf polygon-srid) (function).
polygon-type (function).
(setf polygon-type) (function).
strictly-encoded-ieee754-double (type).
strictly-encoded-uint32 (type).
strictly-encoded-uint64 (type).
strictly-encoded-uint8 (type).
uint32 (type).
uint64 (type).
uint8 (type).
cl-wkbwkb
common-lisp.
flexi-streams.
ieee-floats.
decode (function).
decode-from (function).
encode (function).
encode-to (function).
geometries (generic reader).
(setf geometries) (generic writer).
geometry (class).
geometry-collection (class).
ieee754-double (type).
line-string (class).
line-strings (generic reader).
(setf line-strings) (generic writer).
linear-ring (class).
linear-rings (generic reader).
(setf linear-rings) (generic writer).
m (generic function).
multi-line-string (class).
multi-point (class).
multi-polygon (class).
point (class).
point-primitive (generic reader).
point-primitive (class).
points (generic reader).
(setf points) (generic writer).
points-primitive (generic reader).
(setf points-primitive) (generic writer).
polygon (class).
polygons (generic reader).
(setf polygons) (generic writer).
x (generic function).
y (generic function).
z (generic function).
+endiannesses+ (special variable).
+wkb-m+ (special variable).
+wkb-srid+ (special variable).
+wkb-typemask+ (special variable).
+wkb-types+ (special variable).
+wkb-z+ (special variable).
decode-ieee754-double (function).
decode-ieee754-double-from (function).
decode-linear-ring (function).
decode-primitive-point (function).
decode-uint32 (function).
decode-uint32-from (function).
decode-uint64 (function).
decode-uint64-from (function).
decode-uint8 (function).
decode-uint8-from (function).
def-uint-decoder (macro).
def-uint-encoder (macro).
define-stream-decoder (macro).
define-stream-encoder (macro).
dimension (function).
encode-ieee754-double (function).
encode-ieee754-double-to (function).
encode-linear-ring (function).
encode-primitive-point (function).
encode-uint32 (function).
encode-uint32-to (function).
encode-uint64 (function).
encode-uint64-to (function).
encode-uint8 (function).
encode-uint8-to (function).
encoded-ieee754-double (type).
encoded-uint32 (type).
encoded-uint64 (type).
encoded-uint8 (type).
generic-decode-primitive-point (generic function).
generic-encode-primitive-point (generic function).
geomtype (generic reader).
(setf geomtype) (generic writer).
srid (generic reader).
(setf srid) (generic writer).
strictly-encoded-ieee754-double (type).
strictly-encoded-uint32 (type).
strictly-encoded-uint64 (type).
strictly-encoded-uint8 (type).
uint32 (type).
uint64 (type).
uint8 (type).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Return a copy of SEQUENCE which is EQUAL to SEQUENCE but not EQ.
copy-seq.
Return a copy of SEQUENCE which is EQUAL to SEQUENCE but not EQ.
copy-seq.
Return a copy of SEQUENCE which is EQUAL to SEQUENCE but not EQ.
copy-seq.
Return a copy of SEQUENCE which is EQUAL to SEQUENCE but not EQ.
copy-seq.
Return a copy of SEQUENCE which is EQUAL to SEQUENCE but not EQ.
copy-seq.
Return a copy of SEQUENCE which is EQUAL to SEQUENCE but not EQ.
copy-seq.
Return a copy of SEQUENCE which is EQUAL to SEQUENCE but not EQ.
copy-seq.
Return a copy of SEQUENCE which is EQUAL to SEQUENCE but not EQ.
copy-seq.
Return a copy of SEQUENCE which is EQUAL to SEQUENCE but not EQ.
copy-seq.
Return a copy of SEQUENCE which is EQUAL to SEQUENCE but not EQ.
copy-seq.
Return a copy of SEQUENCE which is EQUAL to SEQUENCE but not EQ.
copy-seq.
Return a copy of SEQUENCE which is EQUAL to SEQUENCE but not EQ.
copy-seq.
Return a copy of SEQUENCE which is EQUAL to SEQUENCE but not EQ.
copy-seq.
Function to decode geoobject from WKB/EWKB representation from sequence.
Function to decode geoobject from WKB/EWKB representation from sequence.
Function to decode geoobject from WKB/EWKB representation from stream.
Function to decode geoobject from WKB/EWKB representation from stream.
Function to encode geoobject to WKB/EWKB representation to sequence. Endianness: :little-endian, :big-endian
Function to encode geoobject to WKB/EWKB representation to sequence. Endianness: :little-endian, :big-endian
Function to encode geoobject to WKB/EWKB representation to binary stream. Endianness: :little-endian, :big-endian
Function to encode geoobject to WKB/EWKB representation to binary stream. Endianness: :little-endian, :big-endian
geometry-collection)) ¶automatically generated reader method
geometry-collection)) ¶automatically generated writer method
multi-line-string)) ¶automatically generated reader method
multi-line-string)) ¶automatically generated writer method
multi-point)) ¶automatically generated reader method
multi-point)) ¶automatically generated writer method
line-string)) ¶automatically generated reader method
linear-ring)) ¶automatically generated reader method
line-string)) ¶automatically generated writer method
linear-ring)) ¶automatically generated writer method
multi-polygon)) ¶automatically generated reader method
multi-polygon)) ¶automatically generated writer method
line-string) stream) ¶multi-polygon) stream) ¶multi-line-string) stream) ¶geometry-collection) stream) ¶multi-point) stream) ¶list
(quote nil)
:geometries
list
(quote nil)
:points-primitive
list
(quote nil)
:points-primitive
list
(quote nil)
:line-strings
list
(quote nil)
:points
list
(quote nil)
:polygons
initialize-instance.
m.
point-primitive.
print-object.
x.
y.
z.
cl-wkb:point-primitive
:point-primitive
This slot is read-only.
cl-wkb:ieee754-double
(error "must specify x value.")
:x
x.
This slot is read-only.
cl-wkb:ieee754-double
(error "must specify y value.")
:y
y.
This slot is read-only.
list
(quote nil)
:linear-rings
Defines a function with the given NAME that encodes an integer
of LISP-TYPE to a sequence of octets whose total number of bits equals
BITS.
The defined function takes two arguments: an integer, and an endianness designator: :BIG-ENDIAN or :LITTLE-ENDIAN.
Defines a function with the given NAME that encodes an integer
of LISP-TYPE to a sequence of octets whose total number of bits equals
BITS.
The defined function takes two arguments: an integer, and an endianness designator: :BIG-ENDIAN or :LITTLE-ENDIAN.
Define a structure STRUCT with members MEMBERS and export the standard functions created. SPECIALS is a list of extra parameters eg ((:print-function pf)). Note double parentheses.
Generic decode function for primitive point
(eql :|2d|)) in endianness) ¶(eql :3dm)) in endianness) ¶(eql :3dz)) in endianness) ¶(eql :|4d|)) in endianness) ¶Generic decode function for primitive point
(eql :|2d|)) in endianness) ¶(eql :3dm)) in endianness) ¶(eql :3dz)) in endianness) ¶(eql :|4d|)) in endianness) ¶Generic decode function for primitive point
(eql :|2d|)) object out endianness) ¶(eql :3dm)) object out endianness) ¶(eql :3dz)) object out endianness) ¶(eql :|4d|)) object out endianness) ¶Generic decode function for primitive point
(eql :|2d|)) object out endianness) ¶(eql :3dm)) object out endianness) ¶(eql :3dz)) object out endianness) ¶(eql :|4d|)) object out endianness) ¶| Jump to: | (
C D E F G I L M P S X Y Z |
|---|
| Jump to: | (
C D E F G I L M P S X Y Z |
|---|
| Jump to: | +
G L M P S X Y Z |
|---|
| Jump to: | +
G L M P S X Y Z |
|---|
| Jump to: | C E F G I L M P S T U W |
|---|
| Jump to: | C E F G I L M P S T U W |
|---|