The olc Reference Manual

This is the olc Reference Manual, version 1.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Sep 15 06:15:15 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 olc

Convert coordinates between Latitude/Longitude and Open Location Code.

Author

Guillaume Le Vaillant

License

GPL-3

Version

1.0

Source

olc.asd.

Child Component

olc.lisp (file).


3 Files

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


3.1 Lisp


3.1.1 olc/olc.asd

Source

olc.asd.

Parent Component

olc (system).

ASDF Systems

olc.


3.1.2 olc/olc.lisp

Source

olc.asd.

Parent Component

olc (system).

Packages

olc.

Public Interface

4 Packages

Packages are listed by definition order.


4.1 olc

Source

olc.lisp.

Use List

common-lisp.

Public Interface

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


5.1 Public Interface


5.1.1 Ordinary functions

Function: lat/lon->olc (latitude longitude &optional extra-precision)

Return the Open Location Code for the given LATITUDE and LONGITUDE.

Package

olc.

Source

olc.lisp.

Function: olc->lat/lon (code &optional center-p)

Return the latitude and longitude for the southwest corner of the given Open Location Code square, or the center of the square if CENTER-P is not NIL.

Package

olc.

Source

olc.lisp.


Appendix A Indexes


A.1 Concepts


A.3 Variables