From c13e1baa65729a4fd379f16569152a47a5197660 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Wed, 3 Apr 2024 13:55:35 +0000 Subject: [PATCH] Deploy to GitHub pages --- 404.html | 102 ++++ Haversine.html | 313 +++++++++++ Haversine/Distance.html | 662 +++++++++++++++++++++++ Haversine/Number.html | 162 ++++++ css/style.css | 980 ++++++++++++++++++++++++++++++++++ index.html | 177 +++++++ index.json | 1 + js/doc.js | 1099 +++++++++++++++++++++++++++++++++++++++ search-index.js | 1 + 9 files changed, 3497 insertions(+) create mode 100644 404.html create mode 100644 Haversine.html create mode 100644 Haversine/Distance.html create mode 100644 Haversine/Number.html create mode 100644 css/style.css create mode 100644 index.html create mode 100644 index.json create mode 100644 js/doc.js create mode 100644 search-index.js diff --git a/404.html b/404.html new file mode 100644 index 0000000..0f977db --- /dev/null +++ b/404.html @@ -0,0 +1,102 @@ + + + + + + + + + + + + + + + + + haversine 0.4.0 + + + + + + + +
+
+
+ +
+ +
+

+ + haversine + +

+ + + 0.4.0 + +
+
+ + + +
+ + +
+
+ + +
+

+ 404 Not Found +

+ +

+ This page is unavailable in this version of the API docs. +

+ +

+ You can use the sidebar to search for your page, or try a different + Crystal version. +

+ +
+ + diff --git a/Haversine.html b/Haversine.html new file mode 100644 index 0000000..3562e96 --- /dev/null +++ b/Haversine.html @@ -0,0 +1,313 @@ + + + + + + + + + + + + + + + + + Haversine - haversine 0.4.0 + + + + + + + +
+
+
+ +
+ +
+

+ + haversine + +

+ + + 0.4.0 + +
+
+ + + +
+ + +
+
+ + +
+

+ + module Haversine + +

+ + + + + +

+ + + + Overview +

+ +

The haversine formula determines the great-circle distance between two points on a sphere +given their latitudes and longitudes.

+

https://en.wikipedia.org/wiki/Haversine_formula

+ + + + + + + +

+ + + + Extended Modules +

+ + + + + + + + + +

+ + + + Defined in: +

+ + + haversine.cr + +
+ + + haversine/distance.cr + +
+ + + haversine/version.cr + +
+ + + + + +

+ + + + Constant Summary +

+ +
+ +
+ RAD_PER_DEG = Math::PI / 180 +
+ + +
+ VERSION = {{ (`shards version /__w/haversine/haversine/src/haversine`).chomp.stringify }} +
+ + +
+ + + + + + + + + +

+ + + + Instance Method Summary +

+ + + + +
+ +
+ + + + + + + + +

+ + + + Instance Method Detail +

+ +
+
+ + def distance(lat1 : Number, lon1 : Number, lat2 : Number, lon2 : Number) : Haversine::Distance + + # +
+ +
+ +

Calculates the haversine distance between two locations using latitude and longitude.

+
+ +
+
+ +
+
+ +
+
+ + def distance(coord1 : Array(Number), coord2 : Array(Number)) : Haversine::Distance + + # +
+ +
+ +

Calculates the haversine distance between two locations using latitude and longitude.

+
+ +
+
+ +
+
+ +
+
+ + def distance(coord1 : Tuple(Number, Number), coord2 : Tuple(Number, Number)) : Haversine::Distance + + # +
+ +
+ +

Calculates the haversine distance between two locations using latitude and longitude.

+
+ +
+
+ +
+
+ + + +
+ + + diff --git a/Haversine/Distance.html b/Haversine/Distance.html new file mode 100644 index 0000000..73ba7a2 --- /dev/null +++ b/Haversine/Distance.html @@ -0,0 +1,662 @@ + + + + + + + + + + + + + + + + + Haversine::Distance - haversine 0.4.0 + + + + + + + +
+
+
+ +
+ +
+

+ + haversine + +

+ + + 0.4.0 + +
+
+ + + +
+ + +
+
+ + +
+

+ + class Haversine::Distance + +

+ + + + + + + + + + + +

+ + + + Included Modules +

+ + + + + + + + + + + +

+ + + + Defined in: +

+ + + haversine/distance.cr + +
+ + + + + +

+ + + + Constant Summary +

+ +
+ +
+ EARTH_RADIUS = 6371008.8 +
+ + +
+ FACTORS = {centimeters: EARTH_RADIUS * 100, centimetres: EARTH_RADIUS * 100, degrees: 360 / (2 * Math::PI), feet: EARTH_RADIUS * 3.28084, inches: EARTH_RADIUS * 39.37, kilometers: EARTH_RADIUS / 1000, kilometres: EARTH_RADIUS / 1000, meters: EARTH_RADIUS, metres: EARTH_RADIUS, miles: EARTH_RADIUS / 1609.344, millimeters: EARTH_RADIUS * 1000, millimetres: EARTH_RADIUS * 1000, nautical_miles: EARTH_RADIUS / 1852, radians: 1, yards: EARTH_RADIUS * 1.0936} +
+ +
+

Unit of measurement factors using a spherical (non-ellipsoid) earth radius.

+

Keys are the name of the unit, values are the number of that unit in a single radians

+
+ + +
+ + + +

+ + + + Constructors +

+ + + + + + + + +

+ + + + Instance Method Summary +

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +

+ + + + Constructor Detail +

+ +
+
+ + def self.new(distance : Number) + + # +
+ +
+
+ +
+
+ + + + + + + + +

+ + + + Instance Method Detail +

+ +
+
+ + def <=>(other : Haversine::Distance) + + # +
+ +
+ +
+ Description copied from module Comparable(Haversine::Distance) +
+ +

The comparison operator. Returns 0 if the two objects are equal, +a negative number if this object is considered less than other, +a positive number if this object is considered greater than other, +or nil if the two objects are not comparable.

+

Subclasses define this method to provide class-specific ordering.

+

The comparison operator is usually used to sort values:

+
# Sort in a descending way:
+[3, 1, 2].sort { |x, y| y <=> x } # => [3, 2, 1]
+
+# Sort in an ascending way:
+[3, 1, 2].sort { |x, y| x <=> y } # => [1, 2, 3]
+
+ +
+
+ +
+
+ +
+
+ + def distance : Float32 | Float64 | Int32 + + # +
+ +
+
+ +
+
+ +
+
+ + def distance=(distance : Float32 | Float64 | Int32) + + # +
+ +
+
+ +
+
+ +
+
+ + def to_centimeters : Number + + # +
+ +
+
+ +
+
+ +
+
+ + def to_centimetres : Number + + # +
+ +
+
+ +
+
+ +
+
+ + def to_degrees : Number + + # +
+ +
+
+ +
+
+ +
+
+ + def to_feet : Number + + # +
+ +
+
+ +
+
+ +
+
+ + def to_inches : Number + + # +
+ +
+
+ +
+
+ +
+
+ + def to_kilometers : Number + + # +
+ +
+
+ +
+
+ +
+
+ + def to_kilometres : Number + + # +
+ +
+
+ +
+
+ +
+
+ + def to_meters : Number + + # +
+ +
+
+ +
+
+ +
+
+ + def to_metres : Number + + # +
+ +
+
+ +
+
+ +
+
+ + def to_miles : Number + + # +
+ +
+
+ +
+
+ +
+
+ + def to_millimeters : Number + + # +
+ +
+
+ +
+
+ +
+
+ + def to_millimetres : Number + + # +
+ +
+
+ +
+
+ +
+
+ + def to_nautical_miles : Number + + # +
+ +
+
+ +
+
+ +
+
+ + def to_radians : Number + + # +
+ +
+
+ +
+
+ +
+
+ + def to_yards : Number + + # +
+ +
+
+ +
+
+ + + +
+ + + diff --git a/Haversine/Number.html b/Haversine/Number.html new file mode 100644 index 0000000..9d9f4ea --- /dev/null +++ b/Haversine/Number.html @@ -0,0 +1,162 @@ + + + + + + + + + + + + + + + + + Haversine::Number - haversine 0.4.0 + + + + + + + +
+
+
+ +
+ +
+

+ + haversine + +

+ + + 0.4.0 + +
+
+ + + +
+ + +
+
+ + +
+

+ + alias Haversine::Number + +

+ + + + + + + +

+ + + + Alias Definition +

+ Float32 | Float64 | Int32 + + + + + + + + + + + + +

+ + + + Defined in: +

+ + + haversine.cr + +
+ + + + + + + + + + + + + + +
+ +
+ + + + + + + + + +
+ + + diff --git a/css/style.css b/css/style.css new file mode 100644 index 0000000..3d0a8a5 --- /dev/null +++ b/css/style.css @@ -0,0 +1,980 @@ +:root { + color-scheme: light dark; +} + +html, body { + background: #FFFFFF; + position: relative; + margin: 0; + padding: 0; + width: 100%; + height: 100%; + overflow: hidden; +} + +body { + font-family: "Avenir", "Tahoma", "Lucida Sans", "Lucida Grande", Verdana, Arial, sans-serif; + color: #333; + line-height: 1.5; +} + +a { + color: #263F6C; +} + +a:visited { + color: #112750; +} + +h1, h2, h3, h4, h5, h6 { + margin: 35px 0 25px; + color: #444444; +} + +h1.type-name { + color: #47266E; + margin: 20px 0 30px; + background-color: #F8F8F8; + padding: 10px 12px; + border: 1px solid #EBEBEB; + border-radius: 2px; +} + +h2 { + border-bottom: 1px solid #E6E6E6; + padding-bottom: 5px; +} + +body { + display: flex; +} + +.sidebar, .main-content { + overflow: auto; +} + +.sidebar { + width: 30em; + color: #F8F4FD; + background-color: #2E1052; + padding: 0 0 30px; + box-shadow: inset -3px 0 4px rgba(0,0,0,.35); + line-height: 1.2; + z-index: 0; +} + +.sidebar .search-box { + padding: 13px 9px; +} + +.sidebar input { + display: block; + box-sizing: border-box; + margin: 0; + padding: 5px; + font: inherit; + font-family: inherit; + line-height: 1.2; + width: 100%; + border: 0; + outline: 0; + border-radius: 2px; + box-shadow: 0px 3px 5px rgba(0,0,0,.25); + transition: box-shadow .12s; +} + +.sidebar input:focus { + box-shadow: 0px 5px 6px rgba(0,0,0,.5); +} + +.sidebar input::-webkit-input-placeholder { /* Chrome/Opera/Safari */ + color: #757575; + font-size: 14px; + text-indent: 2px; +} + +.sidebar input::-moz-placeholder { /* Firefox 19+ */ + color: #757575; + font-size: 14px; + text-indent: 2px; +} + +.sidebar input:-ms-input-placeholder { /* IE 10+ */ + color: #757575; + font-size: 14px; + text-indent: 2px; +} + +.sidebar input:-moz-placeholder { /* Firefox 18- */ + color: #757575; + font-size: 14px; + text-indent: 2px; +} + +.project-summary { + padding: 9px 15px 30px 30px; +} + +.project-name { + font-size: 1.4rem; + margin: 0; + color: #f4f4f4; + font-weight: 600; +} + +.project-version { + margin-top: 5px; + display: inline-block; + position: relative; +} + +.project-version > form::after { + position: absolute; + right: 0; + top: 0; + content: "\25BC"; + font-size: .6em; + line-height: 1.2rem; + z-index: -1; +} + +.project-versions-nav { + cursor: pointer; + margin: 0; + padding: 0 .9em 0 0; + border: none; + -moz-appearance: none; + -webkit-appearance: none; + appearance: none; + background-color: transparent; + color: inherit; + font-family: inherit; + font-size: inherit; + line-height: inherit; +} +.project-versions-nav:focus { + outline: none; +} + +.project-versions-nav > option { + color: initial; +} + +.sidebar ul { + margin: 0; + padding: 0; + list-style: none outside; +} + +.sidebar li { + display: block; + position: relative; +} + +.types-list li.hide { + display: none; +} + +.sidebar a { + text-decoration: none; + color: inherit; + transition: color .14s; +} +.types-list a { + display: block; + padding: 5px 15px 5px 30px; +} + +.types-list { + display: block; +} + +.sidebar a:focus { + outline: 1px solid #D1B7F1; +} + +.types-list a { + padding: 5px 15px 5px 30px; +} + +.sidebar .current > a, +.sidebar a:hover { + color: #866BA6; +} + +.types-list li ul { + overflow: hidden; + height: 0; + max-height: 0; + transition: 1s ease-in-out; +} + +.types-list li.parent { + padding-left: 30px; +} + +.types-list li.parent::before { + box-sizing: border-box; + content: "▼"; + display: block; + width: 30px; + height: 30px; + position: absolute; + top: 0; + left: 0; + text-align: center; + color: white; + font-size: 8px; + line-height: 30px; + transform: rotateZ(-90deg); + cursor: pointer; + transition: .2s linear; +} + + +.types-list li.parent > a { + padding-left: 0; +} + +.types-list li.parent.open::before { + transform: rotateZ(0); +} + +.types-list li.open > ul { + height: auto; + max-height: 1000em; +} + +.main-content { + padding: 0 30px 30px 30px; + width: 100%; +} + +.kind { + font-size: 60%; + color: #866BA6; +} + +.superclass-hierarchy { + margin: -15px 0 30px 0; + padding: 0; + list-style: none outside; + font-size: 80%; +} + +.superclass-hierarchy .superclass { + display: inline-block; + margin: 0 7px 0 0; + padding: 0; +} + +.superclass-hierarchy .superclass + .superclass::before { + content: "<"; + margin-right: 7px; +} + +.other-types-list li { + display: inline-block; +} + +.other-types-list, +.list-summary { + margin: 0 0 30px 0; + padding: 0; + list-style: none outside; +} + +.entry-const { + font-family: Menlo, Monaco, Consolas, 'Courier New', Courier, monospace; +} + +.entry-const code { + white-space: pre-wrap; +} + +.entry-summary { + padding-bottom: 4px; +} + +.superclass-hierarchy .superclass a, +.other-type a, +.entry-summary .signature { + padding: 4px 8px; + margin-bottom: 4px; + display: inline-block; + background-color: #f8f8f8; + color: #47266E; + border: 1px solid #f0f0f0; + text-decoration: none; + border-radius: 3px; + font-family: Menlo, Monaco, Consolas, 'Courier New', Courier, monospace; + transition: background .15s, border-color .15s; +} + +.superclass-hierarchy .superclass a:hover, +.other-type a:hover, +.entry-summary .signature:hover { + background: #D5CAE3; + border-color: #624288; +} + +.entry-summary .summary { + padding-left: 32px; +} + +.entry-summary .summary p { + margin: 12px 0 16px; +} + +.entry-summary a { + text-decoration: none; +} + +.entry-detail { + padding: 30px 0; +} + +.entry-detail .signature { + position: relative; + padding: 5px 15px; + margin-bottom: 10px; + display: block; + border-radius: 5px; + background-color: #f8f8f8; + color: #47266E; + border: 1px solid #f0f0f0; + font-family: Menlo, Monaco, Consolas, 'Courier New', Courier, monospace; + transition: .2s ease-in-out; +} + +.entry-detail:target .signature { + background-color: #D5CAE3; + border: 1px solid #624288; +} + +.entry-detail .signature .method-permalink { + position: absolute; + top: 0; + left: -35px; + padding: 5px 15px; + text-decoration: none; + font-weight: bold; + color: #624288; + opacity: .4; + transition: opacity .2s; +} + +.entry-detail .signature .method-permalink:hover { + opacity: 1; +} + +.entry-detail:target .signature .method-permalink { + opacity: 1; +} + +.methods-inherited { + padding-right: 10%; + line-height: 1.5em; +} + +.methods-inherited h3 { + margin-bottom: 4px; +} + +.methods-inherited a { + display: inline-block; + text-decoration: none; + color: #47266E; +} + +.methods-inherited a:hover { + text-decoration: underline; + color: #6C518B; +} + +.methods-inherited .tooltip>span { + background: #D5CAE3; + padding: 4px 8px; + border-radius: 3px; + margin: -4px -8px; +} + +.methods-inherited .tooltip * { + color: #47266E; +} + +pre { + padding: 10px 20px; + margin-top: 4px; + border-radius: 3px; + line-height: 1.45; + overflow: auto; + color: #333; + background: #fdfdfd; + font-size: 14px; + border: 1px solid #eee; +} + +code { + font-family: Menlo, Monaco, Consolas, 'Courier New', Courier, monospace; +} + +:not(pre) > code { + background-color: rgba(40,35,30,0.05); + padding: 0.2em 0.4em; + font-size: 85%; + border-radius: 3px; +} + +span.flag { + padding: 2px 4px 1px; + border-radius: 3px; + margin-right: 3px; + font-size: 11px; + border: 1px solid transparent; +} + +span.flag.orange { + background-color: #EE8737; + color: #FCEBDD; + border-color: #EB7317; +} + +span.flag.yellow { + background-color: #E4B91C; + color: #FCF8E8; + border-color: #B69115; +} + +span.flag.green { + background-color: #469C14; + color: #E2F9D3; + border-color: #34700E; +} + +span.flag.red { + background-color: #BF1919; + color: #F9ECEC; + border-color: #822C2C; +} + +span.flag.purple { + background-color: #2E1052; + color: #ECE1F9; + border-color: #1F0B37; +} + +span.flag.lime { + background-color: #a3ff00; + color: #222222; + border-color: #00ff1e; +} + +.tooltip>span { + position: absolute; + opacity: 0; + display: none; + pointer-events: none; +} + +.tooltip:hover>span { + display: inline-block; + opacity: 1; +} + +.c { + color: #969896; +} + +.n { + color: #0086b3; +} + +.t { + color: #0086b3; +} + +.s { + color: #183691; +} + +.i { + color: #7f5030; +} + +.k { + color: #a71d5d; +} + +.o { + color: #a71d5d; +} + +.m { + color: #795da3; +} + +.hidden { + display: none; +} +.search-results { + font-size: 90%; + line-height: 1.3; +} + +.search-results mark { + color: inherit; + background: transparent; + font-weight: bold; +} +.search-result { + padding: 5px 8px 5px 5px; + cursor: pointer; + border-left: 5px solid transparent; + transform: translateX(-3px); + transition: all .2s, background-color 0s, border .02s; + min-height: 3.2em; +} +.search-result.current { + border-left-color: #ddd; + background-color: rgba(200,200,200,0.4); + transform: translateX(0); + transition: all .2s, background-color .5s, border 0s; +} +.search-result.current:hover, +.search-result.current:focus { + border-left-color: #866BA6; +} +.search-result:not(.current):nth-child(2n) { + background-color: rgba(255,255,255,.06); +} +.search-result__title { + font-size: 105%; + word-break: break-all; + line-height: 1.1; + padding: 3px 0; +} +.search-result__title strong { + font-weight: normal; +} +.search-results .search-result__title > a { + padding: 0; + display: block; +} +.search-result__title > a > .args { + color: #dddddd; + font-weight: 300; + transition: inherit; + font-size: 88%; + line-height: 1.2; + letter-spacing: -.02em; +} +.search-result__title > a > .args * { + color: inherit; +} + +.search-result a, +.search-result a:hover { + color: inherit; +} +.search-result:not(.current):hover .search-result__title > a, +.search-result:not(.current):focus .search-result__title > a, +.search-result__title > a:focus { + color: #866BA6; +} +.search-result:not(.current):hover .args, +.search-result:not(.current):focus .args { + color: #6a5a7d; +} + +.search-result__type { + color: #e8e8e8; + font-weight: 300; +} +.search-result__doc { + color: #bbbbbb; + font-size: 90%; +} +.search-result__doc p { + margin: 0; + text-overflow: ellipsis; + display: -webkit-box; + -webkit-box-orient: vertical; + -webkit-line-clamp: 2; + overflow: hidden; + line-height: 1.2em; + max-height: 2.4em; +} + +.js-modal-visible .modal-background { + display: flex; +} +.main-content { + position: relative; +} +.modal-background { + position: absolute; + display: none; + height: 100%; + width: 100%; + background: rgba(120,120,120,.4); + z-index: 100; + align-items: center; + justify-content: center; +} +.usage-modal { + max-width: 90%; + background: #fff; + border: 2px solid #ccc; + border-radius: 9px; + padding: 5px 15px 20px; + min-width: 50%; + color: #555; + position: relative; + transform: scale(.5); + transition: transform 200ms; +} +.js-modal-visible .usage-modal { + transform: scale(1); +} +.usage-modal > .close-button { + position: absolute; + right: 15px; + top: 8px; + color: #aaa; + font-size: 27px; + cursor: pointer; +} +.usage-modal > .close-button:hover { + text-shadow: 2px 2px 2px #ccc; + color: #999; +} +.modal-title { + margin: 0; + text-align: center; + font-weight: normal; + color: #666; + border-bottom: 2px solid #ddd; + padding: 10px; +} +.usage-list { + padding: 0; + margin: 13px; +} +.usage-list > li { + padding: 5px 2px; + overflow: auto; + padding-left: 100px; + min-width: 12em; +} +.usage-modal kbd { + background: #eee; + border: 1px solid #ccc; + border-bottom-width: 2px; + border-radius: 3px; + padding: 3px 8px; + font-family: monospace; + margin-right: 2px; + display: inline-block; +} +.usage-key { + float: left; + clear: left; + margin-left: -100px; + margin-right: 12px; +} +.doc-inherited { + font-weight: bold; +} + +.anchor { + float: left; + padding-right: 4px; + margin-left: -20px; +} + +.main-content .anchor .octicon-link { + width: 16px; + height: 16px; +} + +.main-content .anchor:focus { + outline: none +} + +.main-content h1:hover .anchor, +.main-content h2:hover .anchor, +.main-content h3:hover .anchor, +.main-content h4:hover .anchor, +.main-content h5:hover .anchor, +.main-content h6:hover .anchor { + text-decoration: none +} + +.main-content h1 .octicon-link, +.main-content h2 .octicon-link, +.main-content h3 .octicon-link, +.main-content h4 .octicon-link, +.main-content h5 .octicon-link, +.main-content h6 .octicon-link { + visibility: hidden +} + +.main-content h1:hover .anchor .octicon-link, +.main-content h2:hover .anchor .octicon-link, +.main-content h3:hover .anchor .octicon-link, +.main-content h4:hover .anchor .octicon-link, +.main-content h5:hover .anchor .octicon-link, +.main-content h6:hover .anchor .octicon-link { + visibility: visible +} + +img { + max-width: 100%; +} + +table { + font-size: 14px; + display: block; + max-width: -moz-fit-content; + max-width: fit-content; + overflow-x: auto; + white-space: nowrap; + background: #fdfdfd; + text-align: center; + border: 1px solid #eee; + border-collapse: collapse; + padding: 0px 5px 0px 5px; +} + +table th { + padding: 10px; + letter-spacing: 1px; + border-bottom: 1px solid #eee; +} + +table td { + padding: 10px; +} + +#sidebar-btn { + height: 32px; + width: 32px; +} + +#sidebar-btn-label { + height: 2em; + width: 2em; +} + +#sidebar-btn, #sidebar-btn-label { + display: none; + margin: .7rem; + appearance: none; + color: black; + cursor: pointer; +} + +@media only screen and (max-width: 635px) { + .sidebar, .main-content { + /* svg size + vertical margin - .search-box padding-top */ + padding-top: calc(2em + 2 * 0.7rem - 13px); + } + + #sidebar-btn, #sidebar-btn-label { + display: block; + position: absolute; + z-index: 50; + transition-duration: 200ms; + left: 0; + } + + #sidebar-btn:not(:checked) ~ #sidebar-btn-label > .close, + #sidebar-btn:checked ~ #sidebar-btn-label > .open, + #sidebar-btn:checked ~ .main-content { + display: none; + } + + #sidebar-btn:checked { + left: calc(100% - 32px - (2 * 0.7rem)); + } + + #sidebar-btn:checked ~ #sidebar-btn-label { + color: white; + /* 100% - svg size - horizontal margin */ + left: calc(100% - 2em - (2 * 0.7rem)); + } + + #sidebar-btn~.sidebar { + width: 0%; + } + + #sidebar-btn:checked~.sidebar { + visibility: visible; + width: 100%; + } + + .sidebar { + transition-duration: 200ms; + max-width: 100vw; + visibility: hidden; + } +} + +@media (prefers-color-scheme: dark) { + html, body { + background: #1b1b1b; + } + + body { + color: white; + } + + a { + color: #8cb4ff; + } + + .main-content a:visited { + color: #5f8de3; + } + + h1, h2, h3, h4, h5, h6 { + color: white; + } + + h1.type-name { + color: white; + background-color: #202020; + border: 1px solid #353535; + } + + .project-versions-nav > option { + background-color: #222; + } + + .superclass-hierarchy .superclass a, + .superclass-hierarchy .superclass a:visited, + .other-type a, + .other-type a:visited, + .entry-summary .signature, + .entry-summary a:visited { + background-color: #202020; + color: white; + border: 1px solid #353535; + } + + .superclass-hierarchy .superclass a:hover, + .other-type a:hover, + .entry-summary .signature:hover { + background: #443d4d; + border-color: #b092d4; + } + + .kind { + color: #b092d4; + } + + .n { + color: #00ade6; + } + + .t { + color: #00ade6; + } + + .k { + color: #ff66ae; + } + + .o { + color: #ff66ae; + } + + .s { + color: #7799ff; + } + + .i { + color: #b38668; + } + + .m { + color: #b9a5d6; + } + + .c { + color: #a1a1a1; + } + + .methods-inherited a, .methods-inherited a:visited { + color: #B290D9; + } + + .methods-inherited a:hover { + color: #D4B7F4; + } + + .methods-inherited .tooltip>span { + background: #443d4d; + } + + .methods-inherited .tooltip * { + color: white; + } + + .entry-detail:target .signature { + background-color: #443d4d; + border: 1px solid #b092d4; + } + + .entry-detail .signature { + background-color: #202020; + color: white; + border: 1px solid #353535; + } + + .entry-detail .signature .method-permalink { + color: #b092d4; + } + + :not(pre)>code { + background-color: #202020; + } + + span.flag.purple { + background-color: #443d4d; + color: #ECE1F9; + border-color: #b092d4; + } + + .sidebar input::-webkit-input-placeholder { /* Chrome/Opera/Safari */ + color: white; + } + + .sidebar input::-moz-placeholder { /* Firefox 19+ */ + color: white; + } + + .sidebar input:-ms-input-placeholder { /* IE 10+ */ + color: white; + } + + .sidebar input:-moz-placeholder { /* Firefox 18- */ + color: white; + } + + pre, + table { + color: white; + background: #202020; + border: 1px solid #353535; + } + + table th { + border-bottom: 1px solid #353535; + } + + #sidebar-btn, #sidebar-btn-label { + color: white; + } +} diff --git a/index.html b/index.html new file mode 100644 index 0000000..0651da5 --- /dev/null +++ b/index.html @@ -0,0 +1,177 @@ + + + + + + + + + + + + + + + + + haversine 0.4.0 + + + + + + + +
+
+
+ +
+ +
+

+ + haversine + +

+ + + 0.4.0 + +
+
+ + + +
+ + +
+
+ + +
+

+haversine

+

Crystal CI +GitHub release +Docs +License

+

Crystal implementation of the Haversine formula to calculate distances between two points given their latitudes and longitudes.

+

+ +Installation

+
    +
  1. +

    Add the dependency to your shard.yml:

    +
    dependencies:
+  haversine:
+    github: geocrystal/haversine
    +
    2. +
  2. +

    Run shards install

    +
    3. +
+

+ +Usage

+
require "haversine"
+

Calling Haversine.distance with four latitude/longitude coordinates returns a Haversine::Distance object which can provide output in kilometers, meters, miles, feet, or nautical miles.

+

Each "coordinates" member must be a pair of coordinates - latitude and longitude.

+

Haversine.distance accepts of either:

+ +
# Tokyo -> Paris
+distance = Haversine.distance(35.61488, 139.5813, 48.85341, 2.3488)
+
+distance.to_kilometers     # => 9715.470491159029
+distance.to_meters         # => 9715470.491159027
+distance.to_miles          # => 6032.710918698025
+distance.to_feet           # => 31852713.65072557
+distance.to_nautical_miles # => 5242.2799481204265
+

If you have latitude/longitude pairs stored in an array or tuple, you can alternately provide two arrays/tuples when calling Haversine.distance:

+
london = [51.500153, -0.126236]
+new_york = [40.714268, -74.005974]
+
+distance = Haversine.distance(new_york, london)
+distance.to_kilometers # => 5570.4744596620685
+
+london = {51.500153, -0.126236}
+new_york = {40.714268, -74.005974}
+
+distance = Haversine.distance(new_york, london)
+distance.to_kilometers # => 5570.4744596620685
+

Also you can compare Haversine::Distance objects:

+
london = [51.500153, -0.126236]
+new_york = [40.714268, -74.005974]
+shanghai = [31.222220, 121.458060]
+
+distance1 = Haversine.distance(london, new_york)
+distance2 = Haversine.distance(london, shanghai)
+
+distance1 < distance2 # => true
+

+ +Contributing

+
    +
  1. Fork it (https://github.com/geocrystal/haversine/fork)
    2. +
  2. Create your feature branch (git checkout -b my-new-feature)
    3. +
  3. Commit your changes (git commit -am 'Add some feature')
    4. +
  4. Push to the branch (git push origin my-new-feature)
    5. +
  5. Create a new Pull Request
    6. +
+

+ +Contributors

+ +
+ + diff --git a/index.json b/index.json new file mode 100644 index 0000000..18bc57b --- /dev/null +++ b/index.json @@ -0,0 +1 @@ +{"repository_name":"haversine","body":"# haversine\n\n[![Crystal CI](https://github.com/geocrystal/haversine/actions/workflows/crystal.yml/badge.svg)](https://github.com/geocrystal/haversine/actions/workflows/crystal.yml)\n[![GitHub release](https://img.shields.io/github/release/geocrystal/haversine.svg)](https://github.com/mamgeocrystalantoha/haversine/releases)\n[![Docs](https://img.shields.io/badge/docs-available-brightgreen.svg)](https://geocrystal.github.io/haversine/)\n[![License](https://img.shields.io/github/license/geocrystal/haversine.svg)](https://github.com/geocrystal/haversine/blob/master/LICENSE)\n\nCrystal implementation of the [Haversine formula](https://en.wikipedia.org/wiki/Haversine_formula) to calculate distances between two points given their latitudes and longitudes.\n\n## Installation\n\n1. Add the dependency to your `shard.yml`:\n\n ```yaml\n dependencies:\n haversine:\n github: geocrystal/haversine\n ```\n\n2. Run `shards install`\n\n## Usage\n\n```crystal\nrequire \"haversine\"\n```\n\nCalling `Haversine.distance` with four latitude/longitude coordinates returns a `Haversine::Distance` object which can provide output in kilometers, meters, miles, feet, or nautical miles.\n\nEach \"coordinates\" member **must** be a pair of coordinates - `latitude` and `longitude`.\n\n`Haversine.distance` accepts of either:\n\n- `Haversine.distance(lat1, lon1, lat2, lon2)`\n- `Haversine.distance({lat1, lon1}, {lat2, lon2})`\n- `Haversine.distance([lat1, lon1], [lat2, lon2])`\n\n```crystal\n# Tokyo -> Paris\ndistance = Haversine.distance(35.61488, 139.5813, 48.85341, 2.3488)\n\ndistance.to_kilometers # => 9715.470491159029\ndistance.to_meters # => 9715470.491159027\ndistance.to_miles # => 6032.710918698025\ndistance.to_feet # => 31852713.65072557\ndistance.to_nautical_miles # => 5242.2799481204265\n```\n\nIf you have latitude/longitude pairs stored in an array or tuple, you can alternately provide two arrays/tuples when calling `Haversine.distance`:\n\n```crystal\nlondon = [51.500153, -0.126236]\nnew_york = [40.714268, -74.005974]\n\ndistance = Haversine.distance(new_york, london)\ndistance.to_kilometers # => 5570.4744596620685\n\nlondon = {51.500153, -0.126236}\nnew_york = {40.714268, -74.005974}\n\ndistance = Haversine.distance(new_york, london)\ndistance.to_kilometers # => 5570.4744596620685\n```\n\nAlso you can compare `Haversine::Distance` objects:\n\n```crystal\nlondon = [51.500153, -0.126236]\nnew_york = [40.714268, -74.005974]\nshanghai = [31.222220, 121.458060]\n\ndistance1 = Haversine.distance(london, new_york)\ndistance2 = Haversine.distance(london, shanghai)\n\ndistance1 < distance2 # => true\n```\n\n## Contributing\n\n1. Fork it ()\n2. Create your feature branch (`git checkout -b my-new-feature`)\n3. Commit your changes (`git commit -am 'Add some feature'`)\n4. Push to the branch (`git push origin my-new-feature`)\n5. Create a new Pull Request\n\n## Contributors\n\n- [Anton Maminov](https://github.com/mamantoha) - creator and maintainer\n","program":{"html_id":"haversine/toplevel","path":"toplevel.html","kind":"module","full_name":"Top Level Namespace","name":"Top Level Namespace","abstract":false,"locations":[],"repository_name":"haversine","program":true,"enum":false,"alias":false,"const":false,"types":[{"html_id":"haversine/Haversine","path":"Haversine.html","kind":"module","full_name":"Haversine","name":"Haversine","abstract":false,"locations":[{"filename":"src/haversine.cr","line_number":7,"url":null},{"filename":"src/haversine/distance.cr","line_number":1,"url":null},{"filename":"src/haversine/version.cr","line_number":1,"url":null}],"repository_name":"haversine","program":false,"enum":false,"alias":false,"const":false,"constants":[{"id":"RAD_PER_DEG","name":"RAD_PER_DEG","value":"Math::PI / 180"},{"id":"VERSION","name":"VERSION","value":"{{ (`shards version /__w/haversine/haversine/src/haversine`).chomp.stringify }}"}],"extended_modules":[{"html_id":"haversine/Haversine","kind":"module","full_name":"Haversine","name":"Haversine"}],"doc":"The haversine formula determines the great-circle distance between two points on a sphere\ngiven their latitudes and longitudes.\n\nhttps://en.wikipedia.org/wiki/Haversine_formula","summary":"

The haversine formula determines the great-circle distance between two points on a sphere given their latitudes and longitudes.

","instance_methods":[{"html_id":"distance(lat1:Number,lon1:Number,lat2:Number,lon2:Number):Haversine::Distance-instance-method","name":"distance","doc":"Calculates the haversine distance between two locations using latitude and longitude.","summary":"

Calculates the haversine distance between two locations using latitude and longitude.

","abstract":false,"args":[{"name":"lat1","external_name":"lat1","restriction":"Number"},{"name":"lon1","external_name":"lon1","restriction":"Number"},{"name":"lat2","external_name":"lat2","restriction":"Number"},{"name":"lon2","external_name":"lon2","restriction":"Number"}],"args_string":"(lat1 : Number, lon1 : Number, lat2 : Number, lon2 : Number) : Haversine::Distance","args_html":"(lat1 : Number, lon1 : Number, lat2 : Number, lon2 : Number) : Haversine::Distance","location":{"filename":"src/haversine.cr","line_number":15,"url":null},"def":{"name":"distance","args":[{"name":"lat1","external_name":"lat1","restriction":"Number"},{"name":"lon1","external_name":"lon1","restriction":"Number"},{"name":"lat2","external_name":"lat2","restriction":"Number"},{"name":"lon2","external_name":"lon2","restriction":"Number"}],"return_type":"Haversine::Distance","visibility":"Public","body":"dlon = lon2 - lon1\ndlat = lat2 - lat1\na = calc(dlat, lat1, lat2, dlon)\nc = 2 * (Math.atan2(Math.sqrt(a), Math.sqrt(1 - a)))\nHaversine::Distance.new(c)\n"}},{"html_id":"distance(coord1:Array(Number),coord2:Array(Number)):Haversine::Distance-instance-method","name":"distance","doc":"Calculates the haversine distance between two locations using latitude and longitude.","summary":"

Calculates the haversine distance between two locations using latitude and longitude.

","abstract":false,"args":[{"name":"coord1","external_name":"coord1","restriction":"Array(Number)"},{"name":"coord2","external_name":"coord2","restriction":"Array(Number)"}],"args_string":"(coord1 : Array(Number), coord2 : Array(Number)) : Haversine::Distance","args_html":"(coord1 : Array(Number), coord2 : Array(Number)) : Haversine::Distance","location":{"filename":"src/haversine.cr","line_number":26,"url":null},"def":{"name":"distance","args":[{"name":"coord1","external_name":"coord1","restriction":"Array(Number)"},{"name":"coord2","external_name":"coord2","restriction":"Array(Number)"}],"return_type":"Haversine::Distance","visibility":"Public","body":"lat1, lon1 = coord1\nlat2, lon2 = coord2\ndistance(lat1, lon1, lat2, lon2)\n"}},{"html_id":"distance(coord1:Tuple(Number,Number),coord2:Tuple(Number,Number)):Haversine::Distance-instance-method","name":"distance","doc":"Calculates the haversine distance between two locations using latitude and longitude.","summary":"

Calculates the haversine distance between two locations using latitude and longitude.

","abstract":false,"args":[{"name":"coord1","external_name":"coord1","restriction":"Tuple(Number, Number)"},{"name":"coord2","external_name":"coord2","restriction":"Tuple(Number, Number)"}],"args_string":"(coord1 : Tuple(Number, Number), coord2 : Tuple(Number, Number)) : Haversine::Distance","args_html":"(coord1 : Tuple(Number, Number), coord2 : Tuple(Number, Number)) : Haversine::Distance","location":{"filename":"src/haversine.cr","line_number":34,"url":null},"def":{"name":"distance","args":[{"name":"coord1","external_name":"coord1","restriction":"Tuple(Number, Number)"},{"name":"coord2","external_name":"coord2","restriction":"Tuple(Number, Number)"}],"return_type":"Haversine::Distance","visibility":"Public","body":"lat1, lon1 = coord1\nlat2, lon2 = coord2\ndistance(lat1, lon1, lat2, lon2)\n"}}],"types":[{"html_id":"haversine/Haversine/Distance","path":"Haversine/Distance.html","kind":"class","full_name":"Haversine::Distance","name":"Distance","abstract":false,"superclass":{"html_id":"haversine/Reference","kind":"class","full_name":"Reference","name":"Reference"},"ancestors":[{"html_id":"haversine/Comparable","kind":"module","full_name":"Comparable","name":"Comparable"},{"html_id":"haversine/Reference","kind":"class","full_name":"Reference","name":"Reference"},{"html_id":"haversine/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/haversine/distance.cr","line_number":2,"url":null}],"repository_name":"haversine","program":false,"enum":false,"alias":false,"const":false,"constants":[{"id":"EARTH_RADIUS","name":"EARTH_RADIUS","value":"6371008.8"},{"id":"FACTORS","name":"FACTORS","value":"{centimeters: EARTH_RADIUS * 100, centimetres: EARTH_RADIUS * 100, degrees: 360 / (2 * Math::PI), feet: EARTH_RADIUS * 3.28084, inches: EARTH_RADIUS * 39.37, kilometers: EARTH_RADIUS / 1000, kilometres: EARTH_RADIUS / 1000, meters: EARTH_RADIUS, metres: EARTH_RADIUS, miles: EARTH_RADIUS / 1609.344, millimeters: EARTH_RADIUS * 1000, millimetres: EARTH_RADIUS * 1000, nautical_miles: EARTH_RADIUS / 1852, radians: 1, yards: EARTH_RADIUS * 1.0936}","doc":"Unit of measurement factors using a spherical (non-ellipsoid) earth radius.\n\nKeys are the name of the unit, values are the number of that unit in a single radians","summary":"

Unit of measurement factors using a spherical (non-ellipsoid) earth radius.

"}],"included_modules":[{"html_id":"haversine/Comparable","kind":"module","full_name":"Comparable","name":"Comparable"}],"namespace":{"html_id":"haversine/Haversine","kind":"module","full_name":"Haversine","name":"Haversine"},"constructors":[{"html_id":"new(distance:Number)-class-method","name":"new","abstract":false,"args":[{"name":"distance","external_name":"distance","restriction":"Number"}],"args_string":"(distance : Number)","args_html":"(distance : Number)","location":{"filename":"src/haversine/distance.cr","line_number":30,"url":null},"def":{"name":"new","args":[{"name":"distance","external_name":"distance","restriction":"Number"}],"visibility":"Public","body":"_ = allocate\n_.initialize(distance)\nif _.responds_to?(:finalize)\n ::GC.add_finalizer(_)\nend\n_\n"}}],"instance_methods":[{"html_id":"<=>(other:Haversine::Distance)-instance-method","name":"<=>","doc":"The comparison operator. Returns `0` if the two objects are equal,\na negative number if this object is considered less than *other*,\na positive number if this object is considered greater than *other*,\nor `nil` if the two objects are not comparable.\n\nSubclasses define this method to provide class-specific ordering.\n\nThe comparison operator is usually used to sort values:\n\n```\n# Sort in a descending way:\n[3, 1, 2].sort { |x, y| y <=> x } # => [3, 2, 1]\n\n# Sort in an ascending way:\n[3, 1, 2].sort { |x, y| x <=> y } # => [1, 2, 3]\n```","summary":"

The comparison operator.

","abstract":false,"args":[{"name":"other","external_name":"other","restriction":"Haversine::Distance"}],"args_string":"(other : Haversine::Distance)","args_html":"(other : Haversine::Distance)","location":{"filename":"src/haversine/distance.cr","line_number":39,"url":null},"def":{"name":"<=>","args":[{"name":"other","external_name":"other","restriction":"Haversine::Distance"}],"visibility":"Public","body":"distance <=> other.distance"}},{"html_id":"distance:Float32|Float64|Int32-instance-method","name":"distance","abstract":false,"location":{"filename":"src/haversine/distance.cr","line_number":28,"url":null},"def":{"name":"distance","visibility":"Public","body":"@distance"}},{"html_id":"distance=(distance:Float32|Float64|Int32)-instance-method","name":"distance=","abstract":false,"args":[{"name":"distance","external_name":"distance","restriction":"::Float32 | ::Float64 | ::Int32"}],"args_string":"(distance : Float32 | Float64 | Int32)","args_html":"(distance : Float32 | Float64 | Int32)","location":{"filename":"src/haversine/distance.cr","line_number":28,"url":null},"def":{"name":"distance=","args":[{"name":"distance","external_name":"distance","restriction":"::Float32 | ::Float64 | ::Int32"}],"visibility":"Public","body":"@distance = distance"}},{"html_id":"to_centimeters:Number-instance-method","name":"to_centimeters","abstract":false,"location":{"filename":"src/haversine/distance.cr","line_number":33,"url":null},"def":{"name":"to_centimeters","return_type":"Number","visibility":"Public","body":"@distance * FACTORS[:centimeters]"}},{"html_id":"to_centimetres:Number-instance-method","name":"to_centimetres","abstract":false,"location":{"filename":"src/haversine/distance.cr","line_number":33,"url":null},"def":{"name":"to_centimetres","return_type":"Number","visibility":"Public","body":"@distance * FACTORS[:centimetres]"}},{"html_id":"to_degrees:Number-instance-method","name":"to_degrees","abstract":false,"location":{"filename":"src/haversine/distance.cr","line_number":33,"url":null},"def":{"name":"to_degrees","return_type":"Number","visibility":"Public","body":"@distance * FACTORS[:degrees]"}},{"html_id":"to_feet:Number-instance-method","name":"to_feet","abstract":false,"location":{"filename":"src/haversine/distance.cr","line_number":33,"url":null},"def":{"name":"to_feet","return_type":"Number","visibility":"Public","body":"@distance * FACTORS[:feet]"}},{"html_id":"to_inches:Number-instance-method","name":"to_inches","abstract":false,"location":{"filename":"src/haversine/distance.cr","line_number":33,"url":null},"def":{"name":"to_inches","return_type":"Number","visibility":"Public","body":"@distance * FACTORS[:inches]"}},{"html_id":"to_kilometers:Number-instance-method","name":"to_kilometers","abstract":false,"location":{"filename":"src/haversine/distance.cr","line_number":33,"url":null},"def":{"name":"to_kilometers","return_type":"Number","visibility":"Public","body":"@distance * FACTORS[:kilometers]"}},{"html_id":"to_kilometres:Number-instance-method","name":"to_kilometres","abstract":false,"location":{"filename":"src/haversine/distance.cr","line_number":33,"url":null},"def":{"name":"to_kilometres","return_type":"Number","visibility":"Public","body":"@distance * FACTORS[:kilometres]"}},{"html_id":"to_meters:Number-instance-method","name":"to_meters","abstract":false,"location":{"filename":"src/haversine/distance.cr","line_number":33,"url":null},"def":{"name":"to_meters","return_type":"Number","visibility":"Public","body":"@distance * FACTORS[:meters]"}},{"html_id":"to_metres:Number-instance-method","name":"to_metres","abstract":false,"location":{"filename":"src/haversine/distance.cr","line_number":33,"url":null},"def":{"name":"to_metres","return_type":"Number","visibility":"Public","body":"@distance * FACTORS[:metres]"}},{"html_id":"to_miles:Number-instance-method","name":"to_miles","abstract":false,"location":{"filename":"src/haversine/distance.cr","line_number":33,"url":null},"def":{"name":"to_miles","return_type":"Number","visibility":"Public","body":"@distance * FACTORS[:miles]"}},{"html_id":"to_millimeters:Number-instance-method","name":"to_millimeters","abstract":false,"location":{"filename":"src/haversine/distance.cr","line_number":33,"url":null},"def":{"name":"to_millimeters","return_type":"Number","visibility":"Public","body":"@distance * FACTORS[:millimeters]"}},{"html_id":"to_millimetres:Number-instance-method","name":"to_millimetres","abstract":false,"location":{"filename":"src/haversine/distance.cr","line_number":33,"url":null},"def":{"name":"to_millimetres","return_type":"Number","visibility":"Public","body":"@distance * FACTORS[:millimetres]"}},{"html_id":"to_nautical_miles:Number-instance-method","name":"to_nautical_miles","abstract":false,"location":{"filename":"src/haversine/distance.cr","line_number":33,"url":null},"def":{"name":"to_nautical_miles","return_type":"Number","visibility":"Public","body":"@distance * FACTORS[:nautical_miles]"}},{"html_id":"to_radians:Number-instance-method","name":"to_radians","abstract":false,"location":{"filename":"src/haversine/distance.cr","line_number":33,"url":null},"def":{"name":"to_radians","return_type":"Number","visibility":"Public","body":"@distance * FACTORS[:radians]"}},{"html_id":"to_yards:Number-instance-method","name":"to_yards","abstract":false,"location":{"filename":"src/haversine/distance.cr","line_number":33,"url":null},"def":{"name":"to_yards","return_type":"Number","visibility":"Public","body":"@distance * FACTORS[:yards]"}}]},{"html_id":"haversine/Haversine/Number","path":"Haversine/Number.html","kind":"alias","full_name":"Haversine::Number","name":"Number","abstract":false,"locations":[{"filename":"src/haversine.cr","line_number":10,"url":null}],"repository_name":"haversine","program":false,"enum":false,"alias":true,"aliased":"(Float32 | Float64 | Int32)","aliased_html":"Float32 | Float64 | Int32","const":false,"namespace":{"html_id":"haversine/Haversine","kind":"module","full_name":"Haversine","name":"Haversine"}}]}]}} \ No newline at end of file diff --git a/js/doc.js b/js/doc.js new file mode 100644 index 0000000..45d38b9 --- /dev/null +++ b/js/doc.js @@ -0,0 +1,1099 @@ +window.CrystalDocs = (window.CrystalDocs || {}); + +CrystalDocs.base_path = (CrystalDocs.base_path || ""); + +CrystalDocs.searchIndex = (CrystalDocs.searchIndex || false); +CrystalDocs.MAX_RESULTS_DISPLAY = 140; + +CrystalDocs.runQuery = function(query) { + function searchType(type, query, results) { + var matches = []; + var matchedFields = []; + var name = type.full_name; + var i = name.lastIndexOf("::"); + if (i > 0) { + name = name.substring(i + 2); + } + var nameMatches = query.matches(name); + if (nameMatches){ + matches = matches.concat(nameMatches); + matchedFields.push("name"); + } + + var namespaceMatches = query.matchesNamespace(type.full_name); + if(namespaceMatches){ + matches = matches.concat(namespaceMatches); + matchedFields.push("name"); + } + + var docMatches = query.matches(type.doc); + if(docMatches){ + matches = matches.concat(docMatches); + matchedFields.push("doc"); + } + if (matches.length > 0) { + results.push({ + id: type.html_id, + result_type: "type", + kind: type.kind, + name: name, + full_name: type.full_name, + href: type.path, + summary: type.summary, + matched_fields: matchedFields, + matched_terms: matches + }); + } + + if (type.instance_methods) { + type.instance_methods.forEach(function(method) { + searchMethod(method, type, "instance_method", query, results); + }) + } + if (type.class_methods) { + type.class_methods.forEach(function(method) { + searchMethod(method, type, "class_method", query, results); + }) + } + if (type.constructors) { + type.constructors.forEach(function(constructor) { + searchMethod(constructor, type, "constructor", query, results); + }) + } + if (type.macros) { + type.macros.forEach(function(macro) { + searchMethod(macro, type, "macro", query, results); + }) + } + if (type.constants) { + type.constants.forEach(function(constant){ + searchConstant(constant, type, query, results); + }); + } + if (type.types) { + type.types.forEach(function(subtype){ + searchType(subtype, query, results); + }); + } + }; + + function searchMethod(method, type, kind, query, results) { + var matches = []; + var matchedFields = []; + var nameMatches = query.matchesMethod(method.name, kind, type); + if (nameMatches){ + matches = matches.concat(nameMatches); + matchedFields.push("name"); + } + + if (method.args) { + method.args.forEach(function(arg){ + var argMatches = query.matches(arg.external_name); + if (argMatches) { + matches = matches.concat(argMatches); + matchedFields.push("args"); + } + }); + } + + var docMatches = query.matches(type.doc); + if(docMatches){ + matches = matches.concat(docMatches); + matchedFields.push("doc"); + } + + if (matches.length > 0) { + var typeMatches = query.matches(type.full_name); + if (typeMatches) { + matchedFields.push("type"); + matches = matches.concat(typeMatches); + } + results.push({ + id: method.html_id, + type: type.full_name, + result_type: kind, + name: method.name, + full_name: type.full_name + "#" + method.name, + args_string: method.args_string, + summary: method.summary, + href: type.path + "#" + method.html_id, + matched_fields: matchedFields, + matched_terms: matches + }); + } + } + + function searchConstant(constant, type, query, results) { + var matches = []; + var matchedFields = []; + var nameMatches = query.matches(constant.name); + if (nameMatches){ + matches = matches.concat(nameMatches); + matchedFields.push("name"); + } + var docMatches = query.matches(constant.doc); + if(docMatches){ + matches = matches.concat(docMatches); + matchedFields.push("doc"); + } + if (matches.length > 0) { + var typeMatches = query.matches(type.full_name); + if (typeMatches) { + matchedFields.push("type"); + matches = matches.concat(typeMatches); + } + results.push({ + id: constant.id, + type: type.full_name, + result_type: "constant", + name: constant.name, + full_name: type.full_name + "#" + constant.name, + value: constant.value, + summary: constant.summary, + href: type.path + "#" + constant.id, + matched_fields: matchedFields, + matched_terms: matches + }); + } + } + + var results = []; + searchType(CrystalDocs.searchIndex.program, query, results); + return results; +}; + +CrystalDocs.rankResults = function(results, query) { + function uniqueArray(ar) { + var j = {}; + + ar.forEach(function(v) { + j[v + "::" + typeof v] = v; + }); + + return Object.keys(j).map(function(v) { + return j[v]; + }); + } + + results = results.sort(function(a, b) { + var matchedTermsDiff = uniqueArray(b.matched_terms).length - uniqueArray(a.matched_terms).length; + var aHasDocs = b.matched_fields.includes("doc"); + var bHasDocs = b.matched_fields.includes("doc"); + + var aOnlyDocs = aHasDocs && a.matched_fields.length == 1; + var bOnlyDocs = bHasDocs && b.matched_fields.length == 1; + + if (a.result_type == "type" && b.result_type != "type" && !aOnlyDocs) { + if(CrystalDocs.DEBUG) { console.log("a is type b not"); } + return -1; + } else if (b.result_type == "type" && a.result_type != "type" && !bOnlyDocs) { + if(CrystalDocs.DEBUG) { console.log("b is type, a not"); } + return 1; + } + if (a.matched_fields.includes("name")) { + if (b.matched_fields.includes("name")) { + var a_name = (CrystalDocs.prefixForType(a.result_type) || "") + ((a.result_type == "type") ? a.full_name : a.name); + var b_name = (CrystalDocs.prefixForType(b.result_type) || "") + ((b.result_type == "type") ? b.full_name : b.name); + a_name = a_name.toLowerCase(); + b_name = b_name.toLowerCase(); + for(var i = 0; i < query.normalizedTerms.length; i++) { + var term = query.terms[i].replace(/^::?|::?$/, ""); + var a_orig_index = a_name.indexOf(term); + var b_orig_index = b_name.indexOf(term); + if(CrystalDocs.DEBUG) { console.log("term: " + term + " a: " + a_name + " b: " + b_name); } + if(CrystalDocs.DEBUG) { console.log(a_orig_index, b_orig_index, a_orig_index - b_orig_index); } + if (a_orig_index >= 0) { + if (b_orig_index >= 0) { + if(CrystalDocs.DEBUG) { console.log("both have exact match", a_orig_index > b_orig_index ? -1 : 1); } + if(a_orig_index != b_orig_index) { + if(CrystalDocs.DEBUG) { console.log("both have exact match at different positions", a_orig_index > b_orig_index ? 1 : -1); } + return a_orig_index > b_orig_index ? 1 : -1; + } + } else { + if(CrystalDocs.DEBUG) { console.log("a has exact match, b not"); } + return -1; + } + } else if (b_orig_index >= 0) { + if(CrystalDocs.DEBUG) { console.log("b has exact match, a not"); } + return 1; + } + } + } else { + if(CrystalDocs.DEBUG) { console.log("a has match in name, b not"); } + return -1; + } + } else if ( + !a.matched_fields.includes("name") && + b.matched_fields.includes("name") + ) { + return 1; + } + + if (matchedTermsDiff != 0 || (aHasDocs != bHasDocs)) { + if(CrystalDocs.DEBUG) { console.log("matchedTermsDiff: " + matchedTermsDiff, aHasDocs, bHasDocs); } + return matchedTermsDiff; + } + + var matchedFieldsDiff = b.matched_fields.length - a.matched_fields.length; + if (matchedFieldsDiff != 0) { + if(CrystalDocs.DEBUG) { console.log("matched to different number of fields: " + matchedFieldsDiff); } + return matchedFieldsDiff > 0 ? 1 : -1; + } + + var nameCompare = a.name.localeCompare(b.name); + if(nameCompare != 0){ + if(CrystalDocs.DEBUG) { console.log("nameCompare resulted in: " + a.name + "<=>" + b.name + ": " + nameCompare); } + return nameCompare > 0 ? 1 : -1; + } + + if(a.matched_fields.includes("args") && b.matched_fields.includes("args")) { + for(var i = 0; i < query.terms.length; i++) { + var term = query.terms[i]; + var aIndex = a.args_string.indexOf(term); + var bIndex = b.args_string.indexOf(term); + if(CrystalDocs.DEBUG) { console.log("index of " + term + " in args_string: " + aIndex + " - " + bIndex); } + if(aIndex >= 0){ + if(bIndex >= 0){ + if(aIndex != bIndex){ + return aIndex > bIndex ? 1 : -1; + } + }else{ + return -1; + } + }else if(bIndex >= 0) { + return 1; + } + } + } + + return 0; + }); + + if (results.length > 1) { + // if we have more than two search terms, only include results with the most matches + var bestMatchedTerms = uniqueArray(results[0].matched_terms).length; + + results = results.filter(function(result) { + return uniqueArray(result.matched_terms).length + 1 >= bestMatchedTerms; + }); + } + return results; +}; + +CrystalDocs.prefixForType = function(type) { + switch (type) { + case "instance_method": + return "#"; + + case "class_method": + case "macro": + case "constructor": + return "."; + + default: + return false; + } +}; + +CrystalDocs.displaySearchResults = function(results, query) { + function sanitize(html){ + return html.replace(/<(?!\/?code)[^>]+>/g, ""); + } + + // limit results + if (results.length > CrystalDocs.MAX_RESULTS_DISPLAY) { + results = results.slice(0, CrystalDocs.MAX_RESULTS_DISPLAY); + } + + var $frag = document.createDocumentFragment(); + var $resultsElem = document.querySelector(".search-list"); + $resultsElem.innerHTML = ""; + + results.forEach(function(result, i) { + var url = CrystalDocs.base_path + result.href; + var type = false; + + var title = query.highlight(result.result_type == "type" ? result.full_name : result.name); + + var prefix = CrystalDocs.prefixForType(result.result_type); + if (prefix) { + title = "" + prefix + "" + title; + } + + title = "" + title + ""; + + if (result.args_string) { + title += + "" + query.highlight(result.args_string) + ""; + } + + $elem = document.createElement("li"); + $elem.className = "search-result search-result--" + result.result_type; + $elem.dataset.href = url; + $elem.setAttribute("title", result.full_name + " docs page"); + + var $title = document.createElement("div"); + $title.setAttribute("class", "search-result__title"); + var $titleLink = document.createElement("a"); + $titleLink.setAttribute("href", url); + + $titleLink.innerHTML = title; + $title.appendChild($titleLink); + $elem.appendChild($title); + $elem.addEventListener("click", function() { + $titleLink.click(); + }); + + if (result.result_type !== "type") { + var $type = document.createElement("div"); + $type.setAttribute("class", "search-result__type"); + $type.innerHTML = query.highlight(result.type); + $elem.appendChild($type); + } + + if(result.summary){ + var $doc = document.createElement("div"); + $doc.setAttribute("class", "search-result__doc"); + $doc.innerHTML = query.highlight(sanitize(result.summary)); + $elem.appendChild($doc); + } + + $elem.appendChild(document.createComment(JSON.stringify(result))); + $frag.appendChild($elem); + }); + + $resultsElem.appendChild($frag); + + CrystalDocs.toggleResultsList(true); +}; + +CrystalDocs.toggleResultsList = function(visible) { + if (visible) { + document.querySelector(".types-list").classList.add("hidden"); + document.querySelector(".search-results").classList.remove("hidden"); + } else { + document.querySelector(".types-list").classList.remove("hidden"); + document.querySelector(".search-results").classList.add("hidden"); + } +}; + +CrystalDocs.Query = function(string) { + this.original = string; + this.terms = string.split(/\s+/).filter(function(word) { + return CrystalDocs.Query.stripModifiers(word).length > 0; + }); + + var normalized = this.terms.map(CrystalDocs.Query.normalizeTerm); + this.normalizedTerms = normalized; + + function runMatcher(field, matcher) { + if (!field) { + return false; + } + var normalizedValue = CrystalDocs.Query.normalizeTerm(field); + + var matches = []; + normalized.forEach(function(term) { + if (matcher(normalizedValue, term)) { + matches.push(term); + } + }); + return matches.length > 0 ? matches : false; + } + + this.matches = function(field) { + return runMatcher(field, function(normalized, term) { + if (term[0] == "#" || term[0] == ".") { + return false; + } + return normalized.indexOf(term) >= 0; + }); + }; + + function namespaceMatcher(normalized, term){ + var i = term.indexOf(":"); + if(i >= 0){ + term = term.replace(/^::?|::?$/, ""); + var index = normalized.indexOf(term); + if((index == 0) || (index > 0 && normalized[index-1] == ":")){ + return true; + } + } + return false; + } + this.matchesMethod = function(name, kind, type) { + return runMatcher(name, function(normalized, term) { + var i = term.indexOf("#"); + if(i >= 0){ + if (kind != "instance_method") { + return false; + } + }else{ + i = term.indexOf("."); + if(i >= 0){ + if (kind != "class_method" && kind != "macro" && kind != "constructor") { + return false; + } + }else{ + //neither # nor . + if(term.indexOf(":") && namespaceMatcher(normalized, term)){ + return true; + } + } + } + + var methodName = term; + if(i >= 0){ + var termType = term.substring(0, i); + methodName = term.substring(i+1); + + if(termType != "") { + if(CrystalDocs.Query.normalizeTerm(type.full_name).indexOf(termType) < 0){ + return false; + } + } + } + return normalized.indexOf(methodName) >= 0; + }); + }; + + this.matchesNamespace = function(namespace){ + return runMatcher(namespace, namespaceMatcher); + }; + + this.highlight = function(string) { + if (typeof string == "undefined") { + return ""; + } + function escapeRegExp(s) { + return s.replace(/[.*+?\^${}()|\[\]\\]/g, "\\$&").replace(/^[#\.:]+/, ""); + } + return string.replace( + new RegExp("(" + this.normalizedTerms.map(escapeRegExp).join("|") + ")", "gi"), + "$1" + ); + }; +}; +CrystalDocs.Query.normalizeTerm = function(term) { + return term.toLowerCase(); +}; +CrystalDocs.Query.stripModifiers = function(term) { + switch (term[0]) { + case "#": + case ".": + case ":": + return term.substr(1); + + default: + return term; + } +} + +CrystalDocs.search = function(string) { + if(!CrystalDocs.searchIndex) { + console.log("CrystalDocs search index not initialized, delaying search"); + + document.addEventListener("CrystalDocs:loaded", function listener(){ + document.removeEventListener("CrystalDocs:loaded", listener); + CrystalDocs.search(string); + }); + return; + } + + document.dispatchEvent(new Event("CrystalDocs:searchStarted")); + + var query = new CrystalDocs.Query(string); + var results = CrystalDocs.runQuery(query); + results = CrystalDocs.rankResults(results, query); + CrystalDocs.displaySearchResults(results, query); + + document.dispatchEvent(new Event("CrystalDocs:searchPerformed")); +}; + +CrystalDocs.initializeIndex = function(data) { + CrystalDocs.searchIndex = data; + + document.dispatchEvent(new Event("CrystalDocs:loaded")); +}; + +CrystalDocs.loadIndex = function() { + function loadJSON(file, callback) { + var xobj = new XMLHttpRequest(); + xobj.overrideMimeType("application/json"); + xobj.open("GET", file, true); + xobj.onreadystatechange = function() { + if (xobj.readyState == 4 && xobj.status == "200") { + callback(xobj.responseText); + } + }; + xobj.send(null); + } + + function loadScript(file) { + script = document.createElement("script"); + script.src = file; + document.body.appendChild(script); + } + + function parseJSON(json) { + CrystalDocs.initializeIndex(JSON.parse(json)); + } + + for(var i = 0; i < document.scripts.length; i++){ + var script = document.scripts[i]; + if (script.src && script.src.indexOf("js/doc.js") >= 0) { + if (script.src.indexOf("file://") == 0) { + // We need to support JSONP files for the search to work on local file system. + var jsonPath = script.src.replace("js/doc.js", "search-index.js"); + loadScript(jsonPath); + return; + } else { + var jsonPath = script.src.replace("js/doc.js", "index.json"); + loadJSON(jsonPath, parseJSON); + return; + } + } + } + console.error("Could not find location of js/doc.js"); +}; + +// Callback for jsonp +function crystal_doc_search_index_callback(data) { + CrystalDocs.initializeIndex(data); +} + +Navigator = function(sidebar, searchInput, list, leaveSearchScope){ + this.list = list; + var self = this; + + var performingSearch = false; + + document.addEventListener('CrystalDocs:searchStarted', function(){ + performingSearch = true; + }); + document.addEventListener('CrystalDocs:searchDebounceStarted', function(){ + performingSearch = true; + }); + document.addEventListener('CrystalDocs:searchPerformed', function(){ + performingSearch = false; + }); + document.addEventListener('CrystalDocs:searchDebounceStopped', function(event){ + performingSearch = false; + }); + + function delayWhileSearching(callback) { + if(performingSearch){ + document.addEventListener('CrystalDocs:searchPerformed', function listener(){ + document.removeEventListener('CrystalDocs:searchPerformed', listener); + + // add some delay to let search results display kick in + setTimeout(callback, 100); + }); + }else{ + callback(); + } + } + + function clearMoveTimeout() { + clearTimeout(self.moveTimeout); + self.moveTimeout = null; + } + + function startMoveTimeout(upwards){ + /*if(self.moveTimeout) { + clearMoveTimeout(); + } + + var go = function() { + if (!self.moveTimeout) return; + self.move(upwards); + self.moveTimeout = setTimeout(go, 600); + }; + self.moveTimeout = setTimeout(go, 800);*/ + } + + function scrollCenter(element) { + var rect = element.getBoundingClientRect(); + var middle = sidebar.clientHeight / 2; + sidebar.scrollTop += rect.top + rect.height / 2 - middle; + } + + var move = this.move = function(upwards){ + if(!this.current){ + this.highlightFirst(); + return true; + } + var next = upwards ? this.current.previousElementSibling : this.current.nextElementSibling; + if(next && next.classList) { + this.highlight(next); + scrollCenter(next); + return true; + } + return false; + }; + + this.moveRight = function(){ + }; + this.moveLeft = function(){ + }; + + this.highlight = function(elem) { + if(!elem){ + return; + } + this.removeHighlight(); + + this.current = elem; + this.current.classList.add("current"); + }; + + this.highlightFirst = function(){ + this.highlight(this.list.querySelector('li:first-child')); + }; + + this.removeHighlight = function() { + if(this.current){ + this.current.classList.remove("current"); + } + this.current = null; + } + + this.openSelectedResult = function() { + if(this.current) { + this.current.click(); + } + } + + this.focus = function() { + searchInput.focus(); + searchInput.select(); + this.highlightFirst(); + } + + function handleKeyUp(event) { + switch(event.key) { + case "ArrowUp": + case "ArrowDown": + case "i": + case "j": + case "k": + case "l": + case "c": + case "h": + case "t": + case "n": + event.stopPropagation(); + clearMoveTimeout(); + } + } + + function handleKeyDown(event) { + switch(event.key) { + case "Enter": + event.stopPropagation(); + event.preventDefault(); + leaveSearchScope(); + self.openSelectedResult(); + break; + case "Escape": + event.stopPropagation(); + event.preventDefault(); + leaveSearchScope(); + break; + case "j": + case "c": + case "ArrowUp": + if(event.ctrlKey || event.key == "ArrowUp") { + event.stopPropagation(); + self.move(true); + startMoveTimeout(true); + } + break; + case "k": + case "h": + case "ArrowDown": + if(event.ctrlKey || event.key == "ArrowDown") { + event.stopPropagation(); + self.move(false); + startMoveTimeout(false); + } + break; + case "k": + case "t": + case "ArrowLeft": + if(event.ctrlKey || event.key == "ArrowLeft") { + event.stopPropagation(); + self.moveLeft(); + } + break; + case "l": + case "n": + case "ArrowRight": + if(event.ctrlKey || event.key == "ArrowRight") { + event.stopPropagation(); + self.moveRight(); + } + break; + } + } + + function handleInputKeyUp(event) { + switch(event.key) { + case "ArrowUp": + case "ArrowDown": + event.stopPropagation(); + event.preventDefault(); + clearMoveTimeout(); + } + } + + function handleInputKeyDown(event) { + switch(event.key) { + case "Enter": + event.stopPropagation(); + event.preventDefault(); + delayWhileSearching(function(){ + self.openSelectedResult(); + leaveSearchScope(); + }); + break; + case "Escape": + event.stopPropagation(); + event.preventDefault(); + // remove focus from search input + leaveSearchScope(); + sidebar.focus(); + break; + case "ArrowUp": + event.stopPropagation(); + event.preventDefault(); + self.move(true); + startMoveTimeout(true); + break; + + case "ArrowDown": + event.stopPropagation(); + event.preventDefault(); + self.move(false); + startMoveTimeout(false); + break; + } + } + + sidebar.tabIndex = 100; // set tabIndex to enable keylistener + sidebar.addEventListener('keyup', function(event) { + handleKeyUp(event); + }); + sidebar.addEventListener('keydown', function(event) { + handleKeyDown(event); + }); + searchInput.addEventListener('keydown', function(event) { + handleInputKeyDown(event); + }); + searchInput.addEventListener('keyup', function(event) { + handleInputKeyUp(event); + }); + this.move(); +}; + +CrystalDocs.initializeVersions = function () { + function loadJSON(file, callback) { + var xobj = new XMLHttpRequest(); + xobj.overrideMimeType("application/json"); + xobj.open("GET", file, true); + xobj.onreadystatechange = function() { + if (xobj.readyState == 4 && xobj.status == "200") { + callback(xobj.responseText); + } + }; + xobj.send(null); + } + + function parseJSON(json) { + CrystalDocs.loadConfig(JSON.parse(json)); + } + + $elem = document.querySelector("html > head > meta[name=\"crystal_docs.json_config_url\"]") + if ($elem == undefined) { + return + } + jsonURL = $elem.getAttribute("content") + if (jsonURL && jsonURL != "") { + loadJSON(jsonURL, parseJSON); + } +} + +CrystalDocs.loadConfig = function (config) { + var projectVersions = config["versions"] + var currentVersion = document.querySelector("html > head > meta[name=\"crystal_docs.project_version\"]").getAttribute("content") + + var currentVersionInList = projectVersions.find(function (element) { + return element.name == currentVersion + }) + + if (!currentVersionInList) { + projectVersions.unshift({ name: currentVersion, url: '#' }) + } + + $version = document.querySelector(".project-summary > .project-version") + $version.innerHTML = "" + + $select = document.createElement("select") + $select.classList.add("project-versions-nav") + $select.addEventListener("change", function () { + window.location.href = this.value + }) + projectVersions.forEach(function (version) { + $item = document.createElement("option") + $item.setAttribute("value", version.url) + $item.append(document.createTextNode(version.name)) + + if (version.name == currentVersion) { + $item.setAttribute("selected", true) + $item.setAttribute("disabled", true) + } + $select.append($item) + }); + $form = document.createElement("form") + $form.setAttribute("autocomplete", "off") + $form.append($select) + $version.append($form) +} + +document.addEventListener("DOMContentLoaded", function () { + CrystalDocs.initializeVersions() +}) + +var UsageModal = function(title, content) { + var $body = document.body; + var self = this; + var $modalBackground = document.createElement("div"); + $modalBackground.classList.add("modal-background"); + var $usageModal = document.createElement("div"); + $usageModal.classList.add("usage-modal"); + $modalBackground.appendChild($usageModal); + var $title = document.createElement("h3"); + $title.classList.add("modal-title"); + $title.innerHTML = title + $usageModal.appendChild($title); + var $closeButton = document.createElement("span"); + $closeButton.classList.add("close-button"); + $closeButton.setAttribute("title", "Close modal"); + $closeButton.innerText = '×'; + $usageModal.appendChild($closeButton); + $usageModal.insertAdjacentHTML("beforeend", content); + + $modalBackground.addEventListener('click', function(event) { + var element = event.target || event.srcElement; + + if(element == $modalBackground) { + self.hide(); + } + }); + $closeButton.addEventListener('click', function(event) { + self.hide(); + }); + + $body.insertAdjacentElement('beforeend', $modalBackground); + + this.show = function(){ + $body.classList.add("js-modal-visible"); + }; + this.hide = function(){ + $body.classList.remove("js-modal-visible"); + }; + this.isVisible = function(){ + return $body.classList.contains("js-modal-visible"); + } +} + + +document.addEventListener('DOMContentLoaded', function() { + var sessionStorage; + try { + sessionStorage = window.sessionStorage; + } catch (e) { } + if(!sessionStorage) { + sessionStorage = { + setItem: function() {}, + getItem: function() {}, + removeItem: function() {} + }; + } + + var repositoryName = document.querySelector('[name=repository-name]').getAttribute('content'); + var typesList = document.querySelector('.types-list'); + var searchInput = document.querySelector('.search-input'); + var parents = document.querySelectorAll('.types-list li.parent'); + + var scrollSidebarToOpenType = function(){ + var openTypes = typesList.querySelectorAll('.current'); + if (openTypes.length > 0) { + var lastOpenType = openTypes[openTypes.length - 1]; + lastOpenType.scrollIntoView(!(window.matchMedia('only screen and (max-width: 635px)')).matches); + } + } + + scrollSidebarToOpenType(); + + var setPersistentSearchQuery = function(value){ + sessionStorage.setItem(repositoryName + '::search-input:value', value); + } + + for(var i = 0; i < parents.length; i++) { + var _parent = parents[i]; + _parent.addEventListener('click', function(e) { + e.stopPropagation(); + + if(e.target.tagName.toLowerCase() == 'li') { + if(e.target.className.match(/open/)) { + sessionStorage.removeItem(e.target.getAttribute('data-id')); + e.target.className = e.target.className.replace(/ +open/g, ''); + } else { + sessionStorage.setItem(e.target.getAttribute('data-id'), '1'); + if(e.target.className.indexOf('open') == -1) { + e.target.className += ' open'; + } + } + } + }); + + if(sessionStorage.getItem(_parent.getAttribute('data-id')) == '1') { + _parent.className += ' open'; + } + } + + var leaveSearchScope = function(){ + CrystalDocs.toggleResultsList(false); + window.focus(); + } + + var navigator = new Navigator(document.querySelector('.types-list'), searchInput, document.querySelector(".search-results"), leaveSearchScope); + + CrystalDocs.loadIndex(); + var searchTimeout; + var lastSearchText = false; + var performSearch = function() { + document.dispatchEvent(new Event("CrystalDocs:searchDebounceStarted")); + + clearTimeout(searchTimeout); + searchTimeout = setTimeout(function() { + var text = searchInput.value; + + if(text == "") { + CrystalDocs.toggleResultsList(false); + }else if(text == lastSearchText){ + document.dispatchEvent(new Event("CrystalDocs:searchDebounceStopped")); + }else{ + CrystalDocs.search(text); + navigator.highlightFirst(); + searchInput.focus(); + } + lastSearchText = text; + setPersistentSearchQuery(text); + }, 200); + }; + + if(location.hash.length > 3 && location.hash.substring(0,3) == "#q="){ + // allows directly linking a search query which is then executed on the client + // this comes handy for establishing a custom browser search engine with https://crystal-lang.org/api/#q=%s as a search URL + // TODO: Add OpenSearch description + var searchQuery = location.hash.substring(3); + history.pushState({searchQuery: searchQuery}, "Search for " + searchQuery, location.href.replace(/#q=.*/, "")); + searchInput.value = searchQuery; + document.addEventListener('CrystalDocs:loaded', performSearch); + } + + if (searchInput.value.length == 0) { + var searchText = sessionStorage.getItem(repositoryName + '::search-input:value'); + if(searchText){ + searchInput.value = searchText; + } + } + searchInput.addEventListener('keyup', performSearch); + searchInput.addEventListener('input', performSearch); + + var usageModal = new UsageModal('Keyboard Shortcuts', '' + + '' + ); + + function handleShortkeys(event) { + var element = event.target || event.srcElement; + + if(element.tagName == "INPUT" || element.tagName == "TEXTAREA" || element.parentElement.tagName == "TEXTAREA"){ + return; + } + + switch(event.key) { + case "?": + usageModal.show(); + break; + + case "Escape": + usageModal.hide(); + break; + + case "s": + case "/": + if(usageModal.isVisible()) { + return; + } + event.stopPropagation(); + navigator.focus(); + performSearch(); + break; + } + } + + document.addEventListener('keyup', handleShortkeys); + + var scrollToEntryFromLocationHash = function() { + var hash = window.location.hash; + if (hash) { + var targetAnchor = decodeURI(hash.substr(1)); + var targetEl = document.getElementById(targetAnchor) + if (targetEl) { + targetEl.offsetParent.scrollTop = targetEl.offsetTop; + } + } + }; + window.addEventListener("hashchange", scrollToEntryFromLocationHash, false); + scrollToEntryFromLocationHash(); +}); diff --git a/search-index.js b/search-index.js new file mode 100644 index 0000000..0504be9 --- /dev/null +++ b/search-index.js @@ -0,0 +1 @@ +crystal_doc_search_index_callback({"repository_name":"haversine","body":"# haversine\n\n[![Crystal CI](https://github.com/geocrystal/haversine/actions/workflows/crystal.yml/badge.svg)](https://github.com/geocrystal/haversine/actions/workflows/crystal.yml)\n[![GitHub release](https://img.shields.io/github/release/geocrystal/haversine.svg)](https://github.com/mamgeocrystalantoha/haversine/releases)\n[![Docs](https://img.shields.io/badge/docs-available-brightgreen.svg)](https://geocrystal.github.io/haversine/)\n[![License](https://img.shields.io/github/license/geocrystal/haversine.svg)](https://github.com/geocrystal/haversine/blob/master/LICENSE)\n\nCrystal implementation of the [Haversine formula](https://en.wikipedia.org/wiki/Haversine_formula) to calculate distances between two points given their latitudes and longitudes.\n\n## Installation\n\n1. Add the dependency to your `shard.yml`:\n\n ```yaml\n dependencies:\n haversine:\n github: geocrystal/haversine\n ```\n\n2. Run `shards install`\n\n## Usage\n\n```crystal\nrequire \"haversine\"\n```\n\nCalling `Haversine.distance` with four latitude/longitude coordinates returns a `Haversine::Distance` object which can provide output in kilometers, meters, miles, feet, or nautical miles.\n\nEach \"coordinates\" member **must** be a pair of coordinates - `latitude` and `longitude`.\n\n`Haversine.distance` accepts of either:\n\n- `Haversine.distance(lat1, lon1, lat2, lon2)`\n- `Haversine.distance({lat1, lon1}, {lat2, lon2})`\n- `Haversine.distance([lat1, lon1], [lat2, lon2])`\n\n```crystal\n# Tokyo -> Paris\ndistance = Haversine.distance(35.61488, 139.5813, 48.85341, 2.3488)\n\ndistance.to_kilometers # => 9715.470491159029\ndistance.to_meters # => 9715470.491159027\ndistance.to_miles # => 6032.710918698025\ndistance.to_feet # => 31852713.65072557\ndistance.to_nautical_miles # => 5242.2799481204265\n```\n\nIf you have latitude/longitude pairs stored in an array or tuple, you can alternately provide two arrays/tuples when calling `Haversine.distance`:\n\n```crystal\nlondon = [51.500153, -0.126236]\nnew_york = [40.714268, -74.005974]\n\ndistance = Haversine.distance(new_york, london)\ndistance.to_kilometers # => 5570.4744596620685\n\nlondon = {51.500153, -0.126236}\nnew_york = {40.714268, -74.005974}\n\ndistance = Haversine.distance(new_york, london)\ndistance.to_kilometers # => 5570.4744596620685\n```\n\nAlso you can compare `Haversine::Distance` objects:\n\n```crystal\nlondon = [51.500153, -0.126236]\nnew_york = [40.714268, -74.005974]\nshanghai = [31.222220, 121.458060]\n\ndistance1 = Haversine.distance(london, new_york)\ndistance2 = Haversine.distance(london, shanghai)\n\ndistance1 < distance2 # => true\n```\n\n## Contributing\n\n1. Fork it ()\n2. Create your feature branch (`git checkout -b my-new-feature`)\n3. Commit your changes (`git commit -am 'Add some feature'`)\n4. Push to the branch (`git push origin my-new-feature`)\n5. Create a new Pull Request\n\n## Contributors\n\n- [Anton Maminov](https://github.com/mamantoha) - creator and maintainer\n","program":{"html_id":"haversine/toplevel","path":"toplevel.html","kind":"module","full_name":"Top Level Namespace","name":"Top Level Namespace","abstract":false,"locations":[],"repository_name":"haversine","program":true,"enum":false,"alias":false,"const":false,"types":[{"html_id":"haversine/Haversine","path":"Haversine.html","kind":"module","full_name":"Haversine","name":"Haversine","abstract":false,"locations":[{"filename":"src/haversine.cr","line_number":7,"url":null},{"filename":"src/haversine/distance.cr","line_number":1,"url":null},{"filename":"src/haversine/version.cr","line_number":1,"url":null}],"repository_name":"haversine","program":false,"enum":false,"alias":false,"const":false,"constants":[{"id":"RAD_PER_DEG","name":"RAD_PER_DEG","value":"Math::PI / 180"},{"id":"VERSION","name":"VERSION","value":"{{ (`shards version /__w/haversine/haversine/src/haversine`).chomp.stringify }}"}],"extended_modules":[{"html_id":"haversine/Haversine","kind":"module","full_name":"Haversine","name":"Haversine"}],"doc":"The haversine formula determines the great-circle distance between two points on a sphere\ngiven their latitudes and longitudes.\n\nhttps://en.wikipedia.org/wiki/Haversine_formula","summary":"

The haversine formula determines the great-circle distance between two points on a sphere given their latitudes and longitudes.

","instance_methods":[{"html_id":"distance(lat1:Number,lon1:Number,lat2:Number,lon2:Number):Haversine::Distance-instance-method","name":"distance","doc":"Calculates the haversine distance between two locations using latitude and longitude.","summary":"

Calculates the haversine distance between two locations using latitude and longitude.

","abstract":false,"args":[{"name":"lat1","external_name":"lat1","restriction":"Number"},{"name":"lon1","external_name":"lon1","restriction":"Number"},{"name":"lat2","external_name":"lat2","restriction":"Number"},{"name":"lon2","external_name":"lon2","restriction":"Number"}],"args_string":"(lat1 : Number, lon1 : Number, lat2 : Number, lon2 : Number) : Haversine::Distance","args_html":"(lat1 : Number, lon1 : Number, lat2 : Number, lon2 : Number) : Haversine::Distance","location":{"filename":"src/haversine.cr","line_number":15,"url":null},"def":{"name":"distance","args":[{"name":"lat1","external_name":"lat1","restriction":"Number"},{"name":"lon1","external_name":"lon1","restriction":"Number"},{"name":"lat2","external_name":"lat2","restriction":"Number"},{"name":"lon2","external_name":"lon2","restriction":"Number"}],"return_type":"Haversine::Distance","visibility":"Public","body":"dlon = lon2 - lon1\ndlat = lat2 - lat1\na = calc(dlat, lat1, lat2, dlon)\nc = 2 * (Math.atan2(Math.sqrt(a), Math.sqrt(1 - a)))\nHaversine::Distance.new(c)\n"}},{"html_id":"distance(coord1:Array(Number),coord2:Array(Number)):Haversine::Distance-instance-method","name":"distance","doc":"Calculates the haversine distance between two locations using latitude and longitude.","summary":"

Calculates the haversine distance between two locations using latitude and longitude.

","abstract":false,"args":[{"name":"coord1","external_name":"coord1","restriction":"Array(Number)"},{"name":"coord2","external_name":"coord2","restriction":"Array(Number)"}],"args_string":"(coord1 : Array(Number), coord2 : Array(Number)) : Haversine::Distance","args_html":"(coord1 : Array(Number), coord2 : Array(Number)) : Haversine::Distance","location":{"filename":"src/haversine.cr","line_number":26,"url":null},"def":{"name":"distance","args":[{"name":"coord1","external_name":"coord1","restriction":"Array(Number)"},{"name":"coord2","external_name":"coord2","restriction":"Array(Number)"}],"return_type":"Haversine::Distance","visibility":"Public","body":"lat1, lon1 = coord1\nlat2, lon2 = coord2\ndistance(lat1, lon1, lat2, lon2)\n"}},{"html_id":"distance(coord1:Tuple(Number,Number),coord2:Tuple(Number,Number)):Haversine::Distance-instance-method","name":"distance","doc":"Calculates the haversine distance between two locations using latitude and longitude.","summary":"

Calculates the haversine distance between two locations using latitude and longitude.

","abstract":false,"args":[{"name":"coord1","external_name":"coord1","restriction":"Tuple(Number, Number)"},{"name":"coord2","external_name":"coord2","restriction":"Tuple(Number, Number)"}],"args_string":"(coord1 : Tuple(Number, Number), coord2 : Tuple(Number, Number)) : Haversine::Distance","args_html":"(coord1 : Tuple(Number, Number), coord2 : Tuple(Number, Number)) : Haversine::Distance","location":{"filename":"src/haversine.cr","line_number":34,"url":null},"def":{"name":"distance","args":[{"name":"coord1","external_name":"coord1","restriction":"Tuple(Number, Number)"},{"name":"coord2","external_name":"coord2","restriction":"Tuple(Number, Number)"}],"return_type":"Haversine::Distance","visibility":"Public","body":"lat1, lon1 = coord1\nlat2, lon2 = coord2\ndistance(lat1, lon1, lat2, lon2)\n"}}],"types":[{"html_id":"haversine/Haversine/Distance","path":"Haversine/Distance.html","kind":"class","full_name":"Haversine::Distance","name":"Distance","abstract":false,"superclass":{"html_id":"haversine/Reference","kind":"class","full_name":"Reference","name":"Reference"},"ancestors":[{"html_id":"haversine/Comparable","kind":"module","full_name":"Comparable","name":"Comparable"},{"html_id":"haversine/Reference","kind":"class","full_name":"Reference","name":"Reference"},{"html_id":"haversine/Object","kind":"class","full_name":"Object","name":"Object"}],"locations":[{"filename":"src/haversine/distance.cr","line_number":2,"url":null}],"repository_name":"haversine","program":false,"enum":false,"alias":false,"const":false,"constants":[{"id":"EARTH_RADIUS","name":"EARTH_RADIUS","value":"6371008.8"},{"id":"FACTORS","name":"FACTORS","value":"{centimeters: EARTH_RADIUS * 100, centimetres: EARTH_RADIUS * 100, degrees: 360 / (2 * Math::PI), feet: EARTH_RADIUS * 3.28084, inches: EARTH_RADIUS * 39.37, kilometers: EARTH_RADIUS / 1000, kilometres: EARTH_RADIUS / 1000, meters: EARTH_RADIUS, metres: EARTH_RADIUS, miles: EARTH_RADIUS / 1609.344, millimeters: EARTH_RADIUS * 1000, millimetres: EARTH_RADIUS * 1000, nautical_miles: EARTH_RADIUS / 1852, radians: 1, yards: EARTH_RADIUS * 1.0936}","doc":"Unit of measurement factors using a spherical (non-ellipsoid) earth radius.\n\nKeys are the name of the unit, values are the number of that unit in a single radians","summary":"

Unit of measurement factors using a spherical (non-ellipsoid) earth radius.

"}],"included_modules":[{"html_id":"haversine/Comparable","kind":"module","full_name":"Comparable","name":"Comparable"}],"namespace":{"html_id":"haversine/Haversine","kind":"module","full_name":"Haversine","name":"Haversine"},"constructors":[{"html_id":"new(distance:Number)-class-method","name":"new","abstract":false,"args":[{"name":"distance","external_name":"distance","restriction":"Number"}],"args_string":"(distance : Number)","args_html":"(distance : Number)","location":{"filename":"src/haversine/distance.cr","line_number":30,"url":null},"def":{"name":"new","args":[{"name":"distance","external_name":"distance","restriction":"Number"}],"visibility":"Public","body":"_ = allocate\n_.initialize(distance)\nif _.responds_to?(:finalize)\n ::GC.add_finalizer(_)\nend\n_\n"}}],"instance_methods":[{"html_id":"<=>(other:Haversine::Distance)-instance-method","name":"<=>","doc":"The comparison operator. Returns `0` if the two objects are equal,\na negative number if this object is considered less than *other*,\na positive number if this object is considered greater than *other*,\nor `nil` if the two objects are not comparable.\n\nSubclasses define this method to provide class-specific ordering.\n\nThe comparison operator is usually used to sort values:\n\n```\n# Sort in a descending way:\n[3, 1, 2].sort { |x, y| y <=> x } # => [3, 2, 1]\n\n# Sort in an ascending way:\n[3, 1, 2].sort { |x, y| x <=> y } # => [1, 2, 3]\n```","summary":"

The comparison operator.

","abstract":false,"args":[{"name":"other","external_name":"other","restriction":"Haversine::Distance"}],"args_string":"(other : Haversine::Distance)","args_html":"(other : Haversine::Distance)","location":{"filename":"src/haversine/distance.cr","line_number":39,"url":null},"def":{"name":"<=>","args":[{"name":"other","external_name":"other","restriction":"Haversine::Distance"}],"visibility":"Public","body":"distance <=> other.distance"}},{"html_id":"distance:Float32|Float64|Int32-instance-method","name":"distance","abstract":false,"location":{"filename":"src/haversine/distance.cr","line_number":28,"url":null},"def":{"name":"distance","visibility":"Public","body":"@distance"}},{"html_id":"distance=(distance:Float32|Float64|Int32)-instance-method","name":"distance=","abstract":false,"args":[{"name":"distance","external_name":"distance","restriction":"::Float32 | ::Float64 | ::Int32"}],"args_string":"(distance : Float32 | Float64 | Int32)","args_html":"(distance : Float32 | Float64 | Int32)","location":{"filename":"src/haversine/distance.cr","line_number":28,"url":null},"def":{"name":"distance=","args":[{"name":"distance","external_name":"distance","restriction":"::Float32 | ::Float64 | ::Int32"}],"visibility":"Public","body":"@distance = distance"}},{"html_id":"to_centimeters:Number-instance-method","name":"to_centimeters","abstract":false,"location":{"filename":"src/haversine/distance.cr","line_number":33,"url":null},"def":{"name":"to_centimeters","return_type":"Number","visibility":"Public","body":"@distance * FACTORS[:centimeters]"}},{"html_id":"to_centimetres:Number-instance-method","name":"to_centimetres","abstract":false,"location":{"filename":"src/haversine/distance.cr","line_number":33,"url":null},"def":{"name":"to_centimetres","return_type":"Number","visibility":"Public","body":"@distance * FACTORS[:centimetres]"}},{"html_id":"to_degrees:Number-instance-method","name":"to_degrees","abstract":false,"location":{"filename":"src/haversine/distance.cr","line_number":33,"url":null},"def":{"name":"to_degrees","return_type":"Number","visibility":"Public","body":"@distance * FACTORS[:degrees]"}},{"html_id":"to_feet:Number-instance-method","name":"to_feet","abstract":false,"location":{"filename":"src/haversine/distance.cr","line_number":33,"url":null},"def":{"name":"to_feet","return_type":"Number","visibility":"Public","body":"@distance * FACTORS[:feet]"}},{"html_id":"to_inches:Number-instance-method","name":"to_inches","abstract":false,"location":{"filename":"src/haversine/distance.cr","line_number":33,"url":null},"def":{"name":"to_inches","return_type":"Number","visibility":"Public","body":"@distance * FACTORS[:inches]"}},{"html_id":"to_kilometers:Number-instance-method","name":"to_kilometers","abstract":false,"location":{"filename":"src/haversine/distance.cr","line_number":33,"url":null},"def":{"name":"to_kilometers","return_type":"Number","visibility":"Public","body":"@distance * FACTORS[:kilometers]"}},{"html_id":"to_kilometres:Number-instance-method","name":"to_kilometres","abstract":false,"location":{"filename":"src/haversine/distance.cr","line_number":33,"url":null},"def":{"name":"to_kilometres","return_type":"Number","visibility":"Public","body":"@distance * FACTORS[:kilometres]"}},{"html_id":"to_meters:Number-instance-method","name":"to_meters","abstract":false,"location":{"filename":"src/haversine/distance.cr","line_number":33,"url":null},"def":{"name":"to_meters","return_type":"Number","visibility":"Public","body":"@distance * FACTORS[:meters]"}},{"html_id":"to_metres:Number-instance-method","name":"to_metres","abstract":false,"location":{"filename":"src/haversine/distance.cr","line_number":33,"url":null},"def":{"name":"to_metres","return_type":"Number","visibility":"Public","body":"@distance * FACTORS[:metres]"}},{"html_id":"to_miles:Number-instance-method","name":"to_miles","abstract":false,"location":{"filename":"src/haversine/distance.cr","line_number":33,"url":null},"def":{"name":"to_miles","return_type":"Number","visibility":"Public","body":"@distance * FACTORS[:miles]"}},{"html_id":"to_millimeters:Number-instance-method","name":"to_millimeters","abstract":false,"location":{"filename":"src/haversine/distance.cr","line_number":33,"url":null},"def":{"name":"to_millimeters","return_type":"Number","visibility":"Public","body":"@distance * FACTORS[:millimeters]"}},{"html_id":"to_millimetres:Number-instance-method","name":"to_millimetres","abstract":false,"location":{"filename":"src/haversine/distance.cr","line_number":33,"url":null},"def":{"name":"to_millimetres","return_type":"Number","visibility":"Public","body":"@distance * FACTORS[:millimetres]"}},{"html_id":"to_nautical_miles:Number-instance-method","name":"to_nautical_miles","abstract":false,"location":{"filename":"src/haversine/distance.cr","line_number":33,"url":null},"def":{"name":"to_nautical_miles","return_type":"Number","visibility":"Public","body":"@distance * FACTORS[:nautical_miles]"}},{"html_id":"to_radians:Number-instance-method","name":"to_radians","abstract":false,"location":{"filename":"src/haversine/distance.cr","line_number":33,"url":null},"def":{"name":"to_radians","return_type":"Number","visibility":"Public","body":"@distance * FACTORS[:radians]"}},{"html_id":"to_yards:Number-instance-method","name":"to_yards","abstract":false,"location":{"filename":"src/haversine/distance.cr","line_number":33,"url":null},"def":{"name":"to_yards","return_type":"Number","visibility":"Public","body":"@distance * FACTORS[:yards]"}}]},{"html_id":"haversine/Haversine/Number","path":"Haversine/Number.html","kind":"alias","full_name":"Haversine::Number","name":"Number","abstract":false,"locations":[{"filename":"src/haversine.cr","line_number":10,"url":null}],"repository_name":"haversine","program":false,"enum":false,"alias":true,"aliased":"(Float32 | Float64 | Int32)","aliased_html":"Float32 | Float64 | Int32","const":false,"namespace":{"html_id":"haversine/Haversine","kind":"module","full_name":"Haversine","name":"Haversine"}}]}]}}) \ No newline at end of file