The cl-geos Reference Manual

Child Component

src (module).

Next: Files, Previous: Systems, Up: The cl-geos Reference Manual [Contents][Index]

3 Modules

Modules are listed depth-first from the system components tree.

cl-geos/src

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

3.1 `cl-geos/src`

Source

Parent Component

cl-geos (system).

Child Components

package.lisp (file).
library.lisp (file).
geometry.lisp (file).
coordinate-sequences.lisp (file).
point.lisp (file).
line-string.lisp (file).
linear-ring.lisp (file).
polygon.lisp (file).
multi-point.lisp (file).
multi-line-string.lisp (file).
multi-polygon.lisp (file).
io.lisp (file).
topology-operations.lisp (file).
predicates.lisp (file).

Next: Packages, Previous: Modules, Up: The cl-geos Reference Manual [Contents][Index]

4 Files

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

Lisp

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

Next: cl-geos/src/package.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

4.1.1 `cl-geos/cl-geos.asd`

Source: cl-geos.asd.
Parent Component: cl-geos (system).
ASDF Systems: cl-geos.

Next: cl-geos/src/library.lisp, Previous: cl-geos/cl-geos.asd, Up: Lisp [Contents][Index]

4.1.2 `cl-geos/src/package.lisp`

Source: cl-geos.asd.
Parent Component: src (module).
Packages: geos.

Next: cl-geos/src/geometry.lisp, Previous: cl-geos/src/package.lisp, Up: Lisp [Contents][Index]

4.1.3 `cl-geos/src/library.lisp`

Source

Parent Component

src (module).

Public Interface

translate-from-foreign (method).
translate-from-foreign (method).
translate-to-foreign (method).

Internals

%geos-bool (class).
%geos-return (class).
%make-context-handle (function).
*context-handle* (special variable).
context-handle (structure).
context-handle-p (function).
context-handle-pointer (reader).
(setf context-handle-pointer) (writer).
copy-context-handle (function).
define-geos-fun (macro).
error-on (reader method).
error-on (reader method).
finish-geos (function).
finishgeos-r (function).
geos-error (condition).
geos-error-message (reader method).
init-geos (function).
initgeos-r (function).
make-context-handle (function).
register-context-handle (function).
split-camel-case (function).

Next: cl-geos/src/coordinate-sequences.lisp, Previous: cl-geos/src/library.lisp, Up: Lisp [Contents][Index]

4.1.4 `cl-geos/src/geometry.lisp`

Source

Parent Component

src (module).

Public Interface

clone (function).
free-translated-object (method).
geometry (class).
initialize-instance (method).
translate-from-foreign (method).
translate-to-foreign (method).
translate-to-foreign (method).
translate-to-foreign (method).
translate-to-foreign (method).

Internals

%geometry (class).
%geometry-array (class).
%geos-geom-clone (function).
%geos-geom-create-collection (function).
%geos-geom-destroy (function).
%geos-geom-type-id (function).
*type-map* (special variable).
cancel-finalization-fn (reader method).
(setf cancel-finalization-fn) (writer method).
geos-geom-clone (function).
geos-geom-create-collection (function).
geos-geom-destroy (function).
geos-geom-type-id (function).
geos-pointer (reader method).
(setf geos-pointer) (writer method).
make-geos-rep (generic function).
release-ownership (function).

Next: cl-geos/src/point.lisp, Previous: cl-geos/src/geometry.lisp, Up: Lisp [Contents][Index]

4.1.5 `cl-geos/src/coordinate-sequences.lisp`

Source

Parent Component

src (module).

Internals

%geos-coord-seq-create (function).
%geos-coord-seq-get-dimensions (function).
%geos-coord-seq-get-ordinate (function).
%geos-coord-seq-get-size (function).
%geos-coord-seq-get-x (function).
%geos-coord-seq-get-y (function).
%geos-coord-seq-set-x (function).
%geos-coord-seq-set-y (function).
%geos-geom-get-coord-seq (function).
assert-coordinate-sequence (function).
ensure-coordinate-ring (function).
ensure-coordinate-sequence (generic function).
geos-coord-seq-create (function).
geos-coord-seq-get-dimensions (function).
geos-coord-seq-get-ordinate (function).
geos-coord-seq-get-size (function).
geos-coord-seq-get-x (function).
geos-coord-seq-get-y (function).
geos-coord-seq-set-x (function).
geos-coord-seq-set-y (function).
geos-geom-get-coord-seq (function).
make-ring (function).

Next: cl-geos/src/line-string.lisp, Previous: cl-geos/src/coordinate-sequences.lisp, Up: Lisp [Contents][Index]

4.1.6 `cl-geos/src/point.lisp`

Source

Parent Component

src (module).

Public Interface

make-point (generic function).
make-point* (function).
point (class).
xdims (method).
xref (method).

Internals

%geos-geom-create-point (function).
%geos-geom-get-x (function).
%geos-geom-get-y (function).
cached-x (reader method).
(setf cached-x) (writer method).
cached-y (reader method).
(setf cached-y) (writer method).
ensure-point (generic function).
geos-geom-create-point (function).
geos-geom-get-x (function).
geos-geom-get-y (function).
make-geos-rep (method).
x (method).
y (method).

Next: cl-geos/src/linear-ring.lisp, Previous: cl-geos/src/point.lisp, Up: Lisp [Contents][Index]

4.1.7 `cl-geos/src/line-string.lisp`

Source

Parent Component

src (module).

Public Interface

line-string (class).
make-line-string (function).
xdims (method).
xref (method).

Internals

%geos-geom-create-line-string (function).
cached-coords (reader method).
(setf cached-coords) (writer method).
ensure-line-string (generic function).
geos-geom-create-line-string (function).
make-geos-rep (method).

Next: cl-geos/src/polygon.lisp, Previous: cl-geos/src/line-string.lisp, Up: Lisp [Contents][Index]

4.1.8 `cl-geos/src/linear-ring.lisp`

Source

Parent Component

src (module).

Public Interface

linear-ring (class).
make-linear-ring (function).

Internals

%geos-geom-create-linear-ring (function).
ensure-linear-ring (generic function).
geos-geom-create-linear-ring (function).
make-geos-rep (method).

Next: cl-geos/src/multi-point.lisp, Previous: cl-geos/src/linear-ring.lisp, Up: Lisp [Contents][Index]

4.1.9 `cl-geos/src/polygon.lisp`

Source

Parent Component

src (module).

Public Interface

make-polygon (function).
polygon (class).

Internals

%geos-geom-create-polygon (function).
cached-holes (reader method).
(setf cached-holes) (writer method).
cached-shell (reader method).
(setf cached-shell) (writer method).
ensure-polygon (generic function).
geos-geom-create-polygon (function).
make-geos-rep (method).

Next: cl-geos/src/multi-line-string.lisp, Previous: cl-geos/src/polygon.lisp, Up: Lisp [Contents][Index]

4.1.10 `cl-geos/src/multi-point.lisp`

Source

Parent Component

src (module).

Public Interface

make-multi-point (function).
multi-point (class).

Internals

cached-points (reader method).
(setf cached-points) (writer method).
make-geos-rep (method).

Next: cl-geos/src/multi-polygon.lisp, Previous: cl-geos/src/multi-point.lisp, Up: Lisp [Contents][Index]

4.1.11 `cl-geos/src/multi-line-string.lisp`

Source

Parent Component

src (module).

Public Interface

make-multi-line-string (function).
multi-line-string (class).

Internals

cached-line-strings (reader method).
(setf cached-line-strings) (writer method).
make-geos-rep (method).

Next: cl-geos/src/io.lisp, Previous: cl-geos/src/multi-line-string.lisp, Up: Lisp [Contents][Index]

4.1.12 `cl-geos/src/multi-polygon.lisp`

Source

Parent Component

src (module).

Public Interface

make-multi-polygon (function).
multi-polygon (class).

Internals

cached-polygons (reader method).
(setf cached-polygons) (writer method).
make-geos-rep (method).

Next: cl-geos/src/topology-operations.lisp, Previous: cl-geos/src/multi-polygon.lisp, Up: Lisp [Contents][Index]

4.1.13 `cl-geos/src/io.lisp`

Source

Parent Component

src (module).

Public Interface

*print-object-print-wkt* (special variable).
*wkt-rounding-precision* (special variable).
*wkt-trim-p* (special variable).
from-wkt-string (function).
print-object (method).
to-wkb (function).
to-wkt (function).
wkb-file (function).
wkt-string (function).

Internals

%geos-wkbwriter-create (function).
%geos-wkbwriter-destroy (function).
%geos-wkbwriter-write (function).
%geos-wktreader-create (function).
%geos-wktreader-destroy (function).
%geos-wktreader-read (function).
%geos-wktwriter-create (function).
%geos-wktwriter-destroy (function).
%geos-wktwriter-set-rounding-precision (function).
%geos-wktwriter-set-trim (function).
%geos-wktwriter-write (function).
geos-wkbwriter-create (function).
geos-wkbwriter-destroy (function).
geos-wkbwriter-write (function).
geos-wktreader-create (function).
geos-wktreader-destroy (function).
geos-wktreader-read (function).
geos-wktwriter-create (function).
geos-wktwriter-destroy (function).
geos-wktwriter-set-rounding-precision (function).
geos-wktwriter-set-trim (function).
geos-wktwriter-write (function).

Next: cl-geos/src/predicates.lisp, Previous: cl-geos/src/io.lisp, Up: Lisp [Contents][Index]

4.1.14 `cl-geos/src/topology-operations.lisp`

Source

Parent Component

src (module).

Public Interface

boundary (function).
convex-hull (function).
difference (function).
envelope (function).
get-centroid (function).
intersection (function).
node (function).
point-on-surface (function).
sym-difference (function).
unary-union (function).
union (function).

Internals

%geos-boundary (function).
%geos-convex-hull (function).
%geos-difference (function).
%geos-envelope (function).
%geos-get-centroid (function).
%geos-intersection (function).
%geos-node (function).
%geos-point-on-surface (function).
%geos-sym-difference (function).
%geos-unary-union (function).
%geos-union (function).

Previous: cl-geos/src/topology-operations.lisp, Up: Lisp [Contents][Index]

4.1.15 `cl-geos/src/predicates.lisp`

Source

Parent Component

src (module).

Public Interface

contains-p (function).
covered-by-p (function).
covers-p (function).
crosses-p (function).
disjoint-p (function).
equals-exact-p (function).
equals-p (function).
intersects-p (function).
overlaps-p (function).
touches-p (function).
within-p (function).

Internals

%geos-contains (function).
%geos-covered-by (function).
%geos-covers (function).
%geos-crosses (function).
%geos-disjoint (function).
%geos-equals (function).
%geos-equals-exact (function).
%geos-intersects (function).
%geos-is-closed (function).
%geos-is-empty (function).
%geos-is-ring (function).
%geos-is-simple (function).
%geos-is-valid (function).
%geos-overlaps (function).
%geos-touches (function).
%geos-within (function).
is-closed (function).
is-empty (function).
is-ring (function).
is-simple (function).
is-valid (function).

Next: Definitions, Previous: Files, Up: The cl-geos Reference Manual [Contents][Index]

5 Packages

Packages are listed by definition order.

geos

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

5.1 `geos`

Source

package.lisp.

Use List

cffi.
common-lisp.
xarray.

Public Interface

*print-object-print-wkt* (special variable).
*wkt-rounding-precision* (special variable).
*wkt-trim-p* (special variable).
boundary (function).
clone (function).
contains-p (function).
convex-hull (function).
covered-by-p (function).
covers-p (function).
crosses-p (function).
difference (function).
disjoint-p (function).
envelope (function).
equals-exact-p (function).
equals-p (function).
from-wkt-string (function).
geometry (class).
get-centroid (function).
intersection (function).
intersects-p (function).
line-string (class).
linear-ring (class).
make-line-string (function).
make-linear-ring (function).
make-multi-line-string (function).
make-multi-point (function).
make-multi-polygon (function).
make-point (generic function).
make-point* (function).
make-polygon (function).
multi-line-string (class).
multi-point (class).
multi-polygon (class).
node (function).
overlaps-p (function).
point (class).
point-on-surface (function).
polygon (class).
sym-difference (function).
to-wkb (function).
to-wkt (function).
touches-p (function).
unary-union (function).
union (function).
within-p (function).
wkb-file (function).
wkt-string (function).

Internals

%geometry (class).
%geometry-array (class).
%geos-bool (class).
%geos-boundary (function).
%geos-contains (function).
%geos-convex-hull (function).
%geos-coord-seq-create (function).
%geos-coord-seq-get-dimensions (function).
%geos-coord-seq-get-ordinate (function).
%geos-coord-seq-get-size (function).
%geos-coord-seq-get-x (function).
%geos-coord-seq-get-y (function).
%geos-coord-seq-set-x (function).
%geos-coord-seq-set-y (function).
%geos-covered-by (function).
%geos-covers (function).
%geos-crosses (function).
%geos-difference (function).
%geos-disjoint (function).
%geos-envelope (function).
%geos-equals (function).
%geos-equals-exact (function).
%geos-geom-clone (function).
%geos-geom-create-collection (function).
%geos-geom-create-line-string (function).
%geos-geom-create-linear-ring (function).
%geos-geom-create-point (function).
%geos-geom-create-polygon (function).
%geos-geom-destroy (function).
%geos-geom-get-coord-seq (function).
%geos-geom-get-x (function).
%geos-geom-get-y (function).
%geos-geom-type-id (function).
%geos-get-centroid (function).
%geos-intersection (function).
%geos-intersects (function).
%geos-is-closed (function).
%geos-is-empty (function).
%geos-is-ring (function).
%geos-is-simple (function).
%geos-is-valid (function).
%geos-node (function).
%geos-overlaps (function).
%geos-point-on-surface (function).
%geos-return (class).
%geos-sym-difference (function).
%geos-touches (function).
%geos-unary-union (function).
%geos-union (function).
%geos-within (function).
%geos-wkbwriter-create (function).
%geos-wkbwriter-destroy (function).
%geos-wkbwriter-write (function).
%geos-wktreader-create (function).
%geos-wktreader-destroy (function).
%geos-wktreader-read (function).
%geos-wktwriter-create (function).
%geos-wktwriter-destroy (function).
%geos-wktwriter-set-rounding-precision (function).
%geos-wktwriter-set-trim (function).
%geos-wktwriter-write (function).
%make-context-handle (function).
*context-handle* (special variable).
*type-map* (special variable).
assert-coordinate-sequence (function).
cached-coords (generic reader).
(setf cached-coords) (generic writer).
cached-holes (generic reader).
(setf cached-holes) (generic writer).
cached-line-strings (generic reader).
(setf cached-line-strings) (generic writer).
cached-points (generic reader).
(setf cached-points) (generic writer).
cached-polygons (generic reader).
(setf cached-polygons) (generic writer).
cached-shell (generic reader).
(setf cached-shell) (generic writer).
cached-x (generic reader).
(setf cached-x) (generic writer).
cached-y (generic reader).
(setf cached-y) (generic writer).
cancel-finalization-fn (generic reader).
(setf cancel-finalization-fn) (generic writer).
context-handle (structure).
context-handle-p (function).
context-handle-pointer (reader).
(setf context-handle-pointer) (writer).
copy-context-handle (function).
define-geos-fun (macro).
ensure-coordinate-ring (function).
ensure-coordinate-sequence (generic function).
ensure-line-string (generic function).
ensure-linear-ring (generic function).
ensure-point (generic function).
ensure-polygon (generic function).
error-on (generic reader).
finish-geos (function).
finishgeos-r (function).
geos-coord-seq-create (function).
geos-coord-seq-get-dimensions (function).
geos-coord-seq-get-ordinate (function).
geos-coord-seq-get-size (function).
geos-coord-seq-get-x (function).
geos-coord-seq-get-y (function).
geos-coord-seq-set-x (function).
geos-coord-seq-set-y (function).
geos-error (condition).
geos-error-message (generic reader).
geos-geom-clone (function).
geos-geom-create-collection (function).
geos-geom-create-line-string (function).
geos-geom-create-linear-ring (function).
geos-geom-create-point (function).
geos-geom-create-polygon (function).
geos-geom-destroy (function).
geos-geom-get-coord-seq (function).
geos-geom-get-x (function).
geos-geom-get-y (function).
geos-geom-type-id (function).
geos-pointer (generic reader).
(setf geos-pointer) (generic writer).
geos-wkbwriter-create (function).
geos-wkbwriter-destroy (function).
geos-wkbwriter-write (function).
geos-wktreader-create (function).
geos-wktreader-destroy (function).
geos-wktreader-read (function).
geos-wktwriter-create (function).
geos-wktwriter-destroy (function).
geos-wktwriter-set-rounding-precision (function).
geos-wktwriter-set-trim (function).
geos-wktwriter-write (function).
init-geos (function).
initgeos-r (function).
is-closed (function).
is-empty (function).
is-ring (function).
is-simple (function).
is-valid (function).
make-context-handle (function).
make-geos-rep (generic function).
make-ring (function).
register-context-handle (function).
release-ownership (function).
split-camel-case (function).
x (generic function).
y (generic function).

Next: Indexes, Previous: Packages, Up: The cl-geos Reference Manual [Contents][Index]

6 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]

6.1 Public Interface

Special variables
Ordinary functions
Generic functions
Standalone methods
Classes

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

6.1.1 Special variables

Special Variable: *print-object-print-wkt* ¶

If T, prints the WKT representation of geometries in print-object.

Package: geos.
Source: io.lisp.

Special Variable: *wkt-rounding-precision* ¶

Set the precision of the output. If -1, prints the maximum precision.

Package: geos.
Source: io.lisp.

Special Variable: *wkt-trim-p* ¶

If non-NIL, the number of decimals in WKT output is trimmed to the minimum necessary.

Package: geos.
Source: io.lisp.

Next: Generic functions, Previous: Special variables, Up: Public Interface [Contents][Index]

6.1.2 Ordinary functions

Function: boundary (geometry) ¶

Package: geos.
Source: topology-operations.lisp.

Function: clone (geometry) ¶

Clone the geometry.

Package: geos.
Source: geometry.lisp.

Function: contains-p (geometry-1 geometry-2) ¶

Package: geos.
Source: predicates.lisp.

Function: convex-hull (geometry) ¶

Package: geos.
Source: topology-operations.lisp.

Function: covered-by-p (geometry-1 geometry-2) ¶

Package: geos.
Source: predicates.lisp.

Function: covers-p (geometry-1 geometry-2) ¶

Package: geos.
Source: predicates.lisp.

Function: crosses-p (geometry-1 geometry-2) ¶

Package: geos.
Source: predicates.lisp.

Function: difference (geometry-1 geometry-2) ¶

Package: geos.
Source: topology-operations.lisp.

Function: disjoint-p (geometry-1 geometry-2) ¶

Package: geos.
Source: predicates.lisp.

Function: envelope (geometry) ¶

Package: geos.
Source: topology-operations.lisp.

Function: equals-exact-p (geometry-1 geometry-2 tolerance) ¶

Package: geos.
Source: predicates.lisp.

Function: equals-p (geometry-1 geometry-2) ¶

Package: geos.
Source: predicates.lisp.

Function: from-wkt-string (string) ¶

Package: geos.
Source: io.lisp.

Function: get-centroid (geometry) ¶

Package: geos.
Source: topology-operations.lisp.

Function: intersection (geometry-1 geometry-2) ¶

Package: geos.
Source: topology-operations.lisp.

Function: intersects-p (geometry-1 geometry-2) ¶

Package: geos.
Source: predicates.lisp.

Function: make-line-string (coords) ¶

Make a line string. COORDS must a a sequence of x-y coordinates.

Package: geos.
Source: line-string.lisp.

Function: make-linear-ring (coords) ¶

Package: geos.
Source: linear-ring.lisp.

Function: make-multi-line-string (line-strings) ¶

Package: geos.
Source: multi-line-string.lisp.

Function: make-multi-point (points) ¶

Package: geos.
Source: multi-point.lisp.

Function: make-multi-polygon (polygons) ¶

Package: geos.
Source: multi-polygon.lisp.

Function: make-point* (x y) ¶

Package: geos.
Source: point.lisp.

Function: make-polygon (shell &optional holes) ¶

Given a boundary as a linear-ring and a list of holes (also linear-rings), construct a polygon.

Package: geos.
Source: polygon.lisp.

Function: node (geometry) ¶

Package: geos.
Source: topology-operations.lisp.

Function: overlaps-p (geometry-1 geometry-2) ¶

Package: geos.
Source: predicates.lisp.

Function: point-on-surface (geometry) ¶

Package: geos.
Source: topology-operations.lisp.

Function: sym-difference (geometry-1 geometry-2) ¶

Package: geos.
Source: topology-operations.lisp.

Function: to-wkb (geometry &optional stream) ¶

Package: geos.
Source: io.lisp.

Function: to-wkt (geometry &optional stream) ¶

Package: geos.
Source: io.lisp.

Function: touches-p (geometry-1 geometry-2) ¶

Package: geos.
Source: predicates.lisp.

Function: unary-union (geometry) ¶

Package: geos.
Source: topology-operations.lisp.

Function: union (geometry-1 geometry-2) ¶

Package: geos.
Source: topology-operations.lisp.

Function: within-p (geometry-1 geometry-2) ¶

Package: geos.
Source: predicates.lisp.

Function: wkb-file (geometry filespec &key if-exists) ¶

Package: geos.
Source: io.lisp.

Function: wkt-string (geometry) ¶

Package: geos.
Source: io.lisp.

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

6.1.3 Generic functions

Generic Function: make-point (coords) ¶

Make a point. COORDS must be a sequence of length two.

Package

Source

point.lisp.

Methods

Method: make-point ((coords list)) ¶

Method: make-point ((coords array)) ¶

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

6.1.4 Standalone methods

Method: free-translated-object (value (type %geometry-array) param) ¶

Package: cffi.
Source: geometry.lisp.

Method: initialize-instance :around ((self geometry) &rest initargs &key geos-pointer) ¶

Ensure that, after all Lisp side initialization and checks are complete, that a GEOS representation of the object is created and its pointer saved.

Source: geometry.lisp.

Method: print-object ((self geometry) stream) ¶

Source: io.lisp.

Method: translate-from-foreign (value (type %geometry)) ¶

Package: cffi.
Source: geometry.lisp.

Method: translate-from-foreign (value (type %geos-return)) ¶

Package: cffi.
Source: library.lisp.

Method: translate-from-foreign (value (type %geos-bool)) ¶

Package: cffi.
Source: library.lisp.

Method: translate-to-foreign ((value geometry) (type %geometry)) ¶

Package: cffi.
Source: geometry.lisp.

Method: translate-to-foreign (value (type %geometry)) ¶

Package: cffi.
Source: geometry.lisp.

Method: translate-to-foreign ((value array) (type %geometry-array)) ¶

Package: cffi.
Source: geometry.lisp.

Method: translate-to-foreign ((value list) (type %geometry-array)) ¶

Package: cffi.
Source: geometry.lisp.

Method: translate-to-foreign (value (type %geos-bool)) ¶

Package: cffi.
Source: library.lisp.

Method: xdims ((p point)) ¶

Package: xarray.
Source: point.lisp.

Method: xdims ((line line-string)) ¶

Package: xarray.
Source: line-string.lisp.

Method: xref ((p point) &rest subscripts) ¶

Package: xarray.
Source: point.lisp.

Method: xref ((line line-string) &rest subscripts) ¶

Package: xarray.
Source: line-string.lisp.

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

6.1.5 Classes

Class: geometry ¶

Top level class for any GEOS geometry.

Package

Source

Direct subclasses

line-string.
multi-line-string.
multi-point.
multi-polygon.
point.
polygon.

Direct methods

(setf cancel-finalization-fn).
cancel-finalization-fn.
(setf geos-pointer).
geos-pointer.
initialize-instance.
print-object.
translate-to-foreign.

Direct slots

Slot: geos-pointer ¶

The pointer to the GEOS representation of the geometry.

Initargs: :geos-pointer
Readers: geos-pointer.
Writers: (setf geos-pointer).

Slot: cancel-finalization-fn ¶

Readers: cancel-finalization-fn.
Writers: (setf cancel-finalization-fn).

Class: line-string ¶

A series of points.

Package

Source

line-string.lisp.

Direct superclasses

geometry.
xarray-like.

Direct subclasses

linear-ring.

Direct methods

(setf cached-coords).
cached-coords.
ensure-line-string.
make-geos-rep.
xdims.
xref.

Direct slots

Slot: cached-coords ¶

Initargs: :coords
Readers: cached-coords.
Writers: (setf cached-coords).

Class: linear-ring ¶

Package

Source

linear-ring.lisp.

Direct superclasses

line-string.

Direct methods

ensure-linear-ring.
make-geos-rep.

Class: multi-line-string ¶

Package

multi-line-string.lisp.

Source

Direct superclasses

Direct methods

(setf cached-line-strings).
cached-line-strings.
make-geos-rep.

Direct slots

Slot: cached-line-strings ¶

Initargs: :line-strings
Readers: cached-line-strings.
Writers: (setf cached-line-strings).

Class: multi-point ¶

Package

Source

multi-point.lisp.

Direct superclasses

Direct methods

(setf cached-points).
cached-points.
make-geos-rep.

Direct slots

Slot: cached-points ¶

Initargs: :points
Readers: cached-points.
Writers: (setf cached-points).

Class: multi-polygon ¶

Package

Source

multi-polygon.lisp.

Direct superclasses

Direct methods

(setf cached-polygons).
cached-polygons.
make-geos-rep.

Direct slots

Slot: cached-polygons ¶

Initargs: :polygons
Readers: cached-polygons.
Writers: (setf cached-polygons).

Class: point ¶

A single point, consisting of an x and a y component.

Package

Source

point.lisp.

Direct superclasses

geometry.
xarray-like.

Direct methods

(setf cached-x).
cached-x.
(setf cached-y).
cached-y.
ensure-point.
make-geos-rep.
x.
xdims.
xref.
y.

Direct slots

Slot: cached-x ¶

The X value of the point. Cached when retrieved from GEOS.

Initargs: :x
Readers: cached-x.
Writers: (setf cached-x).

Slot: cached-y ¶

The X value of the point. Cached when retrieved from GEOS.

Initargs: :y
Readers: cached-y.
Writers: (setf cached-y).

Class: polygon ¶

Package

Source

polygon.lisp.

Direct superclasses

Direct methods

(setf cached-holes).
cached-holes.
(setf cached-shell).
cached-shell.
ensure-polygon.
make-geos-rep.

Direct slots

Slot: cached-shell ¶

Initargs: :shell
Readers: cached-shell.
Writers: (setf cached-shell).

Slot: cached-holes ¶

Initargs: :holes
Readers: cached-holes.
Writers: (setf cached-holes).

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

6.2 Internals

Special variables
Macros
Ordinary functions
Generic functions
Conditions
Structures
Classes

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

6.2.1 Special variables

Special Variable: *context-handle* ¶

Package: geos.
Source: library.lisp.

Special Variable: *type-map* ¶

Package: geos.
Source: geometry.lisp.

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

6.2.2 Macros

Macro: define-geos-fun (name-and-options return-type &body args) ¶

Package: geos.
Source: library.lisp.

Next: Generic functions, Previous: Macros, Up: Internals [Contents][Index]

6.2.3 Ordinary functions

Function: %geos-boundary (handle geometry) ¶

Package: geos.
Source: topology-operations.lisp.

Function: %geos-contains (handle geometry-1 geometry-2) ¶

Package: geos.
Source: predicates.lisp.

Function: %geos-convex-hull (handle geometry) ¶

Package: geos.
Source: topology-operations.lisp.

Function: %geos-coord-seq-create (handle size dims) ¶

Package: geos.
Source: coordinate-sequences.lisp.

Function: %geos-coord-seq-get-dimensions (handle s dims) ¶

Package: geos.
Source: coordinate-sequences.lisp.

Function: %geos-coord-seq-get-ordinate (handle sequence idx dim value) ¶

Package: geos.
Source: coordinate-sequences.lisp.

Function: %geos-coord-seq-get-size (handle s size) ¶

Package: geos.
Source: coordinate-sequences.lisp.

Function: %geos-coord-seq-get-x (handle sequence idx value) ¶

Package: geos.
Source: coordinate-sequences.lisp.

Function: %geos-coord-seq-get-y (handle sequence idx value) ¶

Package: geos.
Source: coordinate-sequences.lisp.

Function: %geos-coord-seq-set-x (handle sequence idx value) ¶

Package: geos.
Source: coordinate-sequences.lisp.

Function: %geos-coord-seq-set-y (handle sequence idx value) ¶

Package: geos.
Source: coordinate-sequences.lisp.

Function: %geos-covered-by (handle geometry-1 geometry-2) ¶

Package: geos.
Source: predicates.lisp.

Function: %geos-covers (handle geometry-1 geometry-2) ¶

Package: geos.
Source: predicates.lisp.

Function: %geos-crosses (handle geometry-1 geometry-2) ¶

Package: geos.
Source: predicates.lisp.

Function: %geos-difference (handle geometry-1 geometry-2) ¶

Package: geos.
Source: topology-operations.lisp.

Function: %geos-disjoint (handle geometry-1 geometry-2) ¶

Package: geos.
Source: predicates.lisp.

Function: %geos-envelope (handle geometry) ¶

Package: geos.
Source: topology-operations.lisp.

Function: %geos-equals (handle geometry-1 geometry-2) ¶

Package: geos.
Source: predicates.lisp.

Function: %geos-equals-exact (handle geometry-1 geometry-2 tolerance) ¶

Package: geos.
Source: predicates.lisp.

Function: %geos-geom-clone (handle g) ¶

Package: geos.
Source: geometry.lisp.

Function: %geos-geom-create-collection (handle type geoms num-geoms) ¶

Package: geos.
Source: geometry.lisp.

Function: %geos-geom-create-line-string (handle sequence) ¶

Package: geos.
Source: line-string.lisp.

Function: %geos-geom-create-linear-ring (handle sequence) ¶

Package: geos.
Source: linear-ring.lisp.

Function: %geos-geom-create-point (handle sequence) ¶

Package: geos.
Source: point.lisp.

Function: %geos-geom-create-polygon (handle shell holes num-holes) ¶

Package: geos.
Source: polygon.lisp.

Function: %geos-geom-destroy (handle geometry-pointer) ¶

Package: geos.
Source: geometry.lisp.

Function: %geos-geom-get-coord-seq (handle g) ¶

Package: geos.
Source: coordinate-sequences.lisp.

Function: %geos-geom-get-x (handle point value) ¶

Package: geos.
Source: point.lisp.

Function: %geos-geom-get-y (handle point value) ¶

Package: geos.
Source: point.lisp.

Function: %geos-geom-type-id (handle geometry) ¶

Package: geos.
Source: geometry.lisp.

Function: %geos-get-centroid (handle geometry) ¶

Package: geos.
Source: topology-operations.lisp.

Function: %geos-intersection (handle geometry-1 geometry-2) ¶

Package: geos.
Source: topology-operations.lisp.

Function: %geos-intersects (handle geometry-1 geometry-2) ¶

Package: geos.
Source: predicates.lisp.

Function: %geos-is-closed (handle geometry) ¶

Package: geos.
Source: predicates.lisp.

Function: %geos-is-empty (handle geometry) ¶

Package: geos.
Source: predicates.lisp.

Function: %geos-is-ring (handle geometry) ¶

Package: geos.
Source: predicates.lisp.

Function: %geos-is-simple (handle geometry) ¶

Package: geos.
Source: predicates.lisp.

Function: %geos-is-valid (handle geometry) ¶

Package: geos.
Source: predicates.lisp.

Function: %geos-node (handle geometry) ¶

Package: geos.
Source: topology-operations.lisp.

Function: %geos-overlaps (handle geometry-1 geometry-2) ¶

Package: geos.
Source: predicates.lisp.

Function: %geos-point-on-surface (handle geometry) ¶

Package: geos.
Source: topology-operations.lisp.

Function: %geos-sym-difference (handle geometry-1 geometry-2) ¶

Package: geos.
Source: topology-operations.lisp.

Function: %geos-touches (handle geometry-1 geometry-2) ¶

Package: geos.
Source: predicates.lisp.

Function: %geos-unary-union (handle geometry) ¶

Package: geos.
Source: topology-operations.lisp.

Function: %geos-union (handle geometry-1 geometry-2) ¶

Package: geos.
Source: topology-operations.lisp.

Function: %geos-within (handle geometry-1 geometry-2) ¶

Package: geos.
Source: predicates.lisp.

Function: %geos-wkbwriter-create (handle) ¶

Package: geos.
Source: io.lisp.

Function: %geos-wkbwriter-destroy (handle writer) ¶

Package: geos.
Source: io.lisp.

Function: %geos-wkbwriter-write (handle writer geometry size-out) ¶

Package: geos.
Source: io.lisp.

Function: %geos-wktreader-create (handle) ¶

Package: geos.
Source: io.lisp.

Function: %geos-wktreader-destroy (handle reader) ¶

Package: geos.
Source: io.lisp.

Function: %geos-wktreader-read (handle reader wkt) ¶

Package: geos.
Source: io.lisp.

Function: %geos-wktwriter-create (handle) ¶

Package: geos.
Source: io.lisp.

Function: %geos-wktwriter-destroy (handle writer) ¶

Package: geos.
Source: io.lisp.

Function: %geos-wktwriter-set-rounding-precision (handle writer precision) ¶

Package: geos.
Source: io.lisp.

Function: %geos-wktwriter-set-trim (handle writer trim) ¶

Package: geos.
Source: io.lisp.

Function: %geos-wktwriter-write (handle writer geometry) ¶

Package: geos.
Source: io.lisp.

Function: %make-context-handle (&key pointer) ¶

Package: geos.
Source: library.lisp.

Function: assert-coordinate-sequence (seq) ¶

Package: geos.
Source: coordinate-sequences.lisp.

Function: context-handle-p (object) ¶

Package: geos.
Source: library.lisp.

Reader: context-handle-pointer (instance) ¶

Writer: (setf context-handle-pointer) (instance) ¶

Package: geos.
Source: library.lisp.
Target Slot: pointer.

Function: copy-context-handle (instance) ¶

Package: geos.
Source: library.lisp.

Function: ensure-coordinate-ring (seq) ¶

Package: geos.
Source: coordinate-sequences.lisp.

Function: finish-geos (handle) ¶

Destroy a GEOS handle.

Package: geos.
Source: library.lisp.

Function: finishgeos-r (context) ¶

Package: geos.
Source: library.lisp.

Function: geos-coord-seq-create (size dims) ¶

Package: geos.
Source: coordinate-sequences.lisp.

Function: geos-coord-seq-get-dimensions (sequence) ¶

Package: geos.
Source: coordinate-sequences.lisp.

Function: geos-coord-seq-get-ordinate (sequence idx dim) ¶

Package: geos.
Source: coordinate-sequences.lisp.

Function: geos-coord-seq-get-size (sequence) ¶

Package: geos.
Source: coordinate-sequences.lisp.

Function: geos-coord-seq-get-x (sequence idx) ¶

Package: geos.
Source: coordinate-sequences.lisp.

Function: geos-coord-seq-get-y (sequence idx) ¶

Package: geos.
Source: coordinate-sequences.lisp.

Function: geos-coord-seq-set-x (sequence idx value) ¶

Package: geos.
Source: coordinate-sequences.lisp.

Function: geos-coord-seq-set-y (sequence idx value) ¶

Package: geos.
Source: coordinate-sequences.lisp.

Function: geos-geom-clone (g) ¶

Package: geos.
Source: geometry.lisp.

Function: geos-geom-create-collection (type geoms num-geoms) ¶

Package: geos.
Source: geometry.lisp.

Function: geos-geom-create-line-string (sequence) ¶

Package: geos.
Source: line-string.lisp.

Function: geos-geom-create-linear-ring (sequence) ¶

Package: geos.
Source: linear-ring.lisp.

Function: geos-geom-create-point (sequence) ¶

Package: geos.
Source: point.lisp.

Function: geos-geom-create-polygon (shell holes num-holes) ¶

Package: geos.
Source: polygon.lisp.

Function: geos-geom-destroy (geometry-pointer) ¶

Package: geos.
Source: geometry.lisp.

Function: geos-geom-get-coord-seq (g) ¶

Package: geos.
Source: coordinate-sequences.lisp.

Function: geos-geom-get-x (point) ¶

Package: geos.
Source: point.lisp.

Function: geos-geom-get-y (point) ¶

Package: geos.
Source: point.lisp.

Function: geos-geom-type-id (geometry) ¶

Package: geos.
Source: geometry.lisp.

Function: geos-wkbwriter-create () ¶

Package: geos.
Source: io.lisp.

Function: geos-wkbwriter-destroy (writer) ¶

Package: geos.
Source: io.lisp.

Function: geos-wkbwriter-write (writer geometry stream) ¶

Package: geos.
Source: io.lisp.

Function: geos-wktreader-create () ¶

Package: geos.
Source: io.lisp.

Function: geos-wktreader-destroy (reader) ¶

Package: geos.
Source: io.lisp.

Function: geos-wktreader-read (reader wkt) ¶

Package: geos.
Source: io.lisp.

Function: geos-wktwriter-create () ¶

Package: geos.
Source: io.lisp.

Function: geos-wktwriter-destroy (writer) ¶

Package: geos.
Source: io.lisp.

Function: geos-wktwriter-set-rounding-precision (writer precision) ¶

Package: geos.
Source: io.lisp.

Function: geos-wktwriter-set-trim (writer trim) ¶

Package: geos.
Source: io.lisp.

Function: geos-wktwriter-write (writer geometry) ¶

Package: geos.
Source: io.lisp.

Function: init-geos () ¶

Return a new GEOS context handle.

Package: geos.
Source: library.lisp.

Function: initgeos-r (notice-func error-func) ¶

Package: geos.
Source: library.lisp.

Function: is-closed (geometry) ¶

Package: geos.
Source: predicates.lisp.

Function: is-empty (geometry) ¶

Package: geos.
Source: predicates.lisp.

Function: is-ring (geometry) ¶

Package: geos.
Source: predicates.lisp.

Function: is-simple (geometry) ¶

Package: geos.
Source: predicates.lisp.

Function: is-valid (geometry) ¶

Package: geos.
Source: predicates.lisp.

Function: make-context-handle () ¶

Package: geos.
Source: library.lisp.

Function: make-ring (array) ¶

Make the given array into a ring by copying the first column as the last column.

Package: geos.
Source: coordinate-sequences.lisp.

Function: register-context-handle () ¶

Package: geos.
Source: library.lisp.

Function: release-ownership (geometry) ¶

Package: geos.
Source: geometry.lisp.

Function: split-camel-case (string) ¶

Package: geos.
Source: library.lisp.

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

6.2.4 Generic functions

Generic Reader: cached-coords (object) ¶

Package

Methods

Reader Method: cached-coords ((line-string line-string)) ¶

automatically generated reader method

Source: line-string.lisp.
Target Slot: cached-coords.

Generic Writer: (setf cached-coords) (object) ¶

Package

Methods

Writer Method: (setf cached-coords) ((line-string line-string)) ¶

automatically generated writer method

Source: line-string.lisp.
Target Slot: cached-coords.

Generic Reader: cached-holes (object) ¶

Package

Methods

Reader Method: cached-holes ((polygon polygon)) ¶

automatically generated reader method

Source: polygon.lisp.
Target Slot: cached-holes.

Generic Writer: (setf cached-holes) (object) ¶

Package

Methods

Writer Method: (setf cached-holes) ((polygon polygon)) ¶

automatically generated writer method

Source: polygon.lisp.
Target Slot: cached-holes.

Generic Reader: cached-line-strings (object) ¶

Package

Methods

Reader Method: cached-line-strings ((multi-line-string multi-line-string)) ¶

automatically generated reader method

Source: multi-line-string.lisp.
Target Slot: cached-line-strings.

Generic Writer: (setf cached-line-strings) (object) ¶

Package

Methods

Writer Method: (setf cached-line-strings) ((multi-line-string multi-line-string)) ¶

automatically generated writer method

Source: multi-line-string.lisp.
Target Slot: cached-line-strings.

Generic Reader: cached-points (object) ¶

Package

Methods

Reader Method: cached-points ((multi-point multi-point)) ¶

automatically generated reader method

Source: multi-point.lisp.
Target Slot: cached-points.

Generic Writer: (setf cached-points) (object) ¶

Package

Methods

Writer Method: (setf cached-points) ((multi-point multi-point)) ¶

automatically generated writer method

Source: multi-point.lisp.
Target Slot: cached-points.

Generic Reader: cached-polygons (object) ¶

Package

Methods

Reader Method: cached-polygons ((multi-polygon multi-polygon)) ¶

automatically generated reader method

Source: multi-polygon.lisp.
Target Slot: cached-polygons.

Generic Writer: (setf cached-polygons) (object) ¶

Package

Methods

Writer Method: (setf cached-polygons) ((multi-polygon multi-polygon)) ¶

automatically generated writer method

Source: multi-polygon.lisp.
Target Slot: cached-polygons.

Generic Reader: cached-shell (object) ¶

Package

Methods

Reader Method: cached-shell ((polygon polygon)) ¶

automatically generated reader method

Source: polygon.lisp.
Target Slot: cached-shell.

Generic Writer: (setf cached-shell) (object) ¶

Package

Methods

Writer Method: (setf cached-shell) ((polygon polygon)) ¶

automatically generated writer method

Source: polygon.lisp.
Target Slot: cached-shell.

Generic Reader: cached-x (object) ¶

Generic Writer: (setf cached-x) (object) ¶

Package

Methods

Reader Method: cached-x ((point point)) ¶

Writer Method: (setf cached-x) ((point point)) ¶

The X value of the point. Cached when retrieved from GEOS.

Source: point.lisp.
Target Slot: cached-x.

Generic Reader: cached-y (object) ¶

Generic Writer: (setf cached-y) (object) ¶

Package

Methods

Reader Method: cached-y ((point point)) ¶

Writer Method: (setf cached-y) ((point point)) ¶

The X value of the point. Cached when retrieved from GEOS.

Source: point.lisp.
Target Slot: cached-y.

Generic Reader: cancel-finalization-fn (object) ¶

Package

Methods

Reader Method: cancel-finalization-fn ((geometry geometry)) ¶

automatically generated reader method

Source: geometry.lisp.
Target Slot: cancel-finalization-fn.

Generic Writer: (setf cancel-finalization-fn) (object) ¶

Package

Methods

Writer Method: (setf cancel-finalization-fn) ((geometry geometry)) ¶

automatically generated writer method

Source: geometry.lisp.
Target Slot: cancel-finalization-fn.

Generic Function: ensure-coordinate-sequence (seq) ¶

Package

coordinate-sequences.lisp.

Source

Methods

Method: ensure-coordinate-sequence ((seq list)) ¶

Method: ensure-coordinate-sequence ((seq array)) ¶

Generic Function: ensure-line-string (coords) ¶

Package

Source

line-string.lisp.

Methods

Method: ensure-line-string ((coords line-string)) ¶

Method: ensure-line-string (coords) ¶

Generic Function: ensure-linear-ring (coords-or-linear-ring) ¶

Package

Source

linear-ring.lisp.

Methods

Method: ensure-linear-ring ((linear-ring linear-ring)) ¶

Method: ensure-linear-ring (coords) ¶

Generic Function: ensure-point (coords) ¶

Package

Source

point.lisp.

Methods

Method: ensure-point ((coords point)) ¶

Method: ensure-point (coords) ¶

Generic Function: ensure-polygon (shell) ¶

Package

Source

polygon.lisp.

Methods

Method: ensure-polygon ((shell polygon)) ¶

Method: ensure-polygon (shell) ¶

Generic Reader: error-on (object) ¶

Package

Methods

Reader Method: error-on ((%geos-bool %geos-bool)) ¶

automatically generated reader method

Source: library.lisp.
Target Slot: error-on.

Reader Method: error-on ((%geos-return %geos-return)) ¶

automatically generated reader method

Source: library.lisp.
Target Slot: error-on.

Generic Reader: geos-error-message (condition) ¶

Package

Methods

Reader Method: geos-error-message ((condition geos-error)) ¶

Source: library.lisp.
Target Slot: message.

Generic Reader: geos-pointer (object) ¶

Generic Writer: (setf geos-pointer) (object) ¶

Package

Methods

Reader Method: geos-pointer ((geometry geometry)) ¶

Writer Method: (setf geos-pointer) ((geometry geometry)) ¶

The pointer to the GEOS representation of the geometry.

Source: geometry.lisp.
Target Slot: geos-pointer.

Generic Function: make-geos-rep (geometry) ¶

Given an initialized Lisp representation of GEOMETRY, create
a GEOS representation of the geometry and return the pointer to that representation.

Package

Source

Methods

Method: make-geos-rep ((self multi-polygon)) ¶

Source: multi-polygon.lisp.

Method: make-geos-rep ((self multi-line-string)) ¶

Source: multi-line-string.lisp.

Method: make-geos-rep ((self multi-point)) ¶

Source: multi-point.lisp.

Method: make-geos-rep ((self polygon)) ¶

Source: polygon.lisp.

Method: make-geos-rep ((self linear-ring)) ¶

Source: linear-ring.lisp.

Method: make-geos-rep ((self line-string)) ¶

Source: line-string.lisp.

Method: make-geos-rep ((self point)) ¶

Source: point.lisp.

Generic Function: x (self) ¶

Package

Methods

Method: x ((self point)) ¶

Source: point.lisp.

Generic Function: y (self) ¶

Package

Methods

Method: y ((self point)) ¶

Source: point.lisp.

Next: Structures, Previous: Generic functions, Up: Internals [Contents][Index]

6.2.5 Conditions

Condition: geos-error ¶

Package

Source

Direct superclasses

error.

Direct methods

geos-error-message.

Direct slots

Slot: message ¶

Initargs: :message
Readers: geos-error-message.
Writers: This slot is read-only.

Next: Classes, Previous: Conditions, Up: Internals [Contents][Index]

6.2.6 Structures

Structure: context-handle ¶

Package

Source

Direct superclasses

structure-object.

Direct slots

Slot: pointer ¶

Readers: context-handle-pointer.
Writers: (setf context-handle-pointer).

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

6.2.7 Classes

Class: %geometry ¶

Package

Source

Direct superclasses

enhanced-foreign-type.

Direct methods

translate-from-foreign.
translate-to-foreign.
translate-to-foreign.

Direct Default Initargs

Initarg	Value
`:actual-type`	`(quote (pointer))`

Class: %geometry-array ¶

Package

Source

Direct superclasses

enhanced-foreign-type.

Direct methods

free-translated-object.
translate-to-foreign.
translate-to-foreign.

Direct Default Initargs

Initarg	Value
`:actual-type`	`(quote (pointer))`

Class: %geos-bool ¶

Package

Source

Direct superclasses

enhanced-foreign-type.

Direct methods

error-on.
translate-from-foreign.
translate-to-foreign.

Direct Default Initargs

Initarg	Value
`:actual-type`	`(quote (char))`

Direct slots

Slot: error-on ¶

Initargs: :error-on
Readers: error-on.
Writers: This slot is read-only.

Class: %geos-return ¶

Package

Source