package oolc

  1. Overview
  2. Docs
package oolc
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Oolc

An OCaml Implementation of Open Location Code.

type codeArea = {
  1. latitudeLo : float;
  2. longitudeLo : float;
  3. latitudeHi : float;
  4. longitudeHi : float;
  5. latitudeCenter : float;
  6. longitudeCenter : float;
  7. codeLength : int;
}

Representation of an area indicated by a code.

exception Invalid_Open_Location_Code_length

Exception raised when asking to encode a location with too small a code length.

val isValid : string -> bool

isValid s returns a boolean indicating whether the string is a valid Open Location Code sequence or not.

val isShort : string -> bool

isShort s returns a boolean indicating whether the string is a valid short Open Location Code sequence or not.

val isFull : string -> bool

isFull s returns a boolean indicating whether the string is a valid full Open Location Code sequence or not.

val encode : ?codeLength:int -> float -> float -> string

encode latitude longitude returns an Open Location code corresponding to the location given. An optional length can be given, if not specified, a code with 10 characters will be generated. If the length asked is too small, Invalid_Open_Location_Code-length is raised.

val decode : string -> codeArea

decode c returns the coordinates corresponding to the c, if the code is not valid, an exception is raised.

val shortenBy4 : string -> float -> float -> string

shortenBy4 c latitude longitude tries to remove the first four characters of c if it is a valid code. This will only succeed if both the latitude and longitude are less than 0.25 degrees from the code center. If not, the original code is returned.

val shortenBy6 : string -> float -> float -> string

shortenBy6 c latitude longitude tries to remove the first six characters of c if it is a valid code. This will only succeed if both the latitude and longitude are less than 0.0125 degrees from the code center. If not, the original code is returned.

recoverNearest c latitude longitude returns the nearest full Open Location Code matching with the short code c and the location provided by latitude and longitude.

val recoverNearest : string -> float -> float -> string

recoverNearest c latitude longitude returns the nearest full Open Location Code matching with the short code c and the location provided by latitude and longitude.