Changeset 36207 in project


Ignore:
Timestamp:
08/12/18 02:18:33 (13 months ago)
Author:
Kon Lovett
Message:

canon

File:
1 edited

Legend:

Unmodified
Added
Removed
  • wiki/eggref/5/geo-utils

    r36191 r36207  
    2929==== make-geopoint
    3030
    31 <procedure>(make-geopoint LAT LON) => geopoint</procedure>
     31<procedure>(make-geopoint LAT LON) -> geopoint</procedure>
    3232
    3333==== geopoint?
    3434
    35 <procedure>(geopoint? OBJ) => boolean</procedure>
     35<procedure>(geopoint? OBJ) --> boolean</procedure>
    3636
    3737==== check-geopoint
    3838
    39 <procedure>(check-geopoint LOC OBJ [VARNAM]) => geopoint</procedure>
     39<procedure>(check-geopoint LOC OBJ [VARNAM]) -> geopoint</procedure>
    4040
    4141==== error-geopoint
     
    4545==== geopoint-latitude
    4646
    47 <procedure>(geopoint-latitude GP) => real</procedure>
     47<procedure>(geopoint-latitude GP) -> real</procedure>
    4848
    4949==== geopoint-longitude
    5050
    51 <procedure>(geopoint-longitude GP) => real</procedure>
     51<procedure>(geopoint-longitude GP) -> real</procedure>
    5252
    5353==== geopoint-strictly-above?
    5454
    55 <procedure>(geopoint-strictly-above? GP1 GP2) => boolean</procedure>
     55<procedure>(geopoint-strictly-above? GP1 GP2) --> boolean</procedure>
    5656
    5757==== geopoint-above?
    5858
    59 <procedure>(geopoint-above? GP1 GP2) => boolean</procedure>
     59<procedure>(geopoint-above? GP1 GP2) --> boolean</procedure>
    6060
    6161==== geopoint-strictly-below?
    6262
    63 <procedure>(geopoint-strictly-below? GP1 GP2) => boolean</procedure>
     63<procedure>(geopoint-strictly-below? GP1 GP2) --> boolean</procedure>
    6464
    6565==== geopoint-below?
    6666
    67 <procedure>(geopoint-below? GP1 GP2) => boolean</procedure>
     67<procedure>(geopoint-below? GP1 GP2) --> boolean</procedure>
    6868
    6969==== geopoint-strictly-left?
    7070
    71 <procedure>(geopoint-strictly-left? GP1 GP2) => boolean</procedure>
     71<procedure>(geopoint-strictly-left? GP1 GP2) --> boolean</procedure>
    7272
    7373==== geopoint-left?
    7474
    75 <procedure>(geopoint-left? GP1 GP2) => boolean</procedure>
     75<procedure>(geopoint-left? GP1 GP2) --> boolean</procedure>
    7676
    7777==== geopoint-strictly-right?
    7878
    79 <procedure>(geopoint-strictly-right? GP1 GP2) => boolean</procedure>
     79<procedure>(geopoint-strictly-right? GP1 GP2) --> boolean</procedure>
    8080
    8181==== geopoint-right?
    8282
    83 <procedure>(geopoint-right? GP1 GP2) => boolean</procedure>
     83<procedure>(geopoint-right? GP1 GP2) --> boolean</procedure>
    8484
    8585==== geopoint=
    8686
    87 <procedure>(geopoint= GP1 GP2) => boolean</procedure>
     87<procedure>(geopoint= GP1 GP2) --> boolean</procedure>
    8888
    8989==== geopoint<
    9090
    91 <procedure>(geopoint< GP1 GP2) => boolean</procedure>
     91<procedure>(geopoint< GP1 GP2) --> boolean</procedure>
    9292
    9393==== geopoint>
    9494
    95 <procedure>(geopoint> GP1 GP2) => boolean</procedure>
     95<procedure>(geopoint> GP1 GP2) --> boolean</procedure>
    9696
    9797==== geopoint<=
    9898
    99 <procedure>(geopoint<= GP1 GP2) => boolean</procedure>
     99<procedure>(geopoint<= GP1 GP2) --> boolean</procedure>
    100100
    101101==== geopoint>=
    102102
    103 <procedure>(geopoint>= GP1 GP2) => boolean</procedure>
     103<procedure>(geopoint>= GP1 GP2) --> boolean</procedure>
    104104
    105105
     
    118118==== make-geobox
    119119
    120 <procedure>(make-geobox GP-MIN GP-MAX) => geobox</procedure>
     120<procedure>(make-geobox GP-MIN GP-MAX) -> geobox</procedure>
    121121
    122122==== geobox?
    123123
    124 <procedure>(geobox? OBJ) => boolean</procedure>
     124<procedure>(geobox? OBJ) --> boolean</procedure>
    125125
    126126==== check-geobox
    127127
    128 <procedure>(check-geobox LOC OBJ [VARNAM]) => geobox</procedure>
     128<procedure>(check-geobox LOC OBJ [VARNAM]) -> geobox</procedure>
    129129
    130130==== error-geobox
     
    134134==== geobox-minimum
    135135
    136 <procedure>(geobox-minimum GB) => geopoint</procedure>
     136<procedure>(geobox-minimum GB) -> geopoint</procedure>
    137137
    138138==== geobox-maximum
    139139
    140 <procedure>(geobox-maximum GB) => geopoint</procedure>
     140<procedure>(geobox-maximum GB) -> geopoint</procedure>
    141141
    142142==== geobox=
    143143
    144 <procedure>(geobox= GB1 GB2) => boolean</procedure>
     144<procedure>(geobox= GB1 GB2) --> boolean</procedure>
    145145
    146146==== geobox<
    147147
    148 <procedure>(geobox< GB1 GB2) => boolean</procedure>
     148<procedure>(geobox< GB1 GB2) --> boolean</procedure>
    149149
    150150==== geobox>
    151151
    152 <procedure>(geobox> GB1 GB2) => boolean</procedure>
     152<procedure>(geobox> GB1 GB2) --> boolean</procedure>
    153153
    154154==== geobox<=
    155155
    156 <procedure>(geobox<= GB1 GB2) => boolean</procedure>
     156<procedure>(geobox<= GB1 GB2) --> boolean</procedure>
    157157
    158158==== geobox>=
    159159
    160 <procedure>(geobox>= GB1 GB2) => boolean</procedure>
     160<procedure>(geobox>= GB1 GB2) --> boolean</procedure>
    161161
    162162==== geopoint-within-box
    163163
    164 <procedure>(geopoint-within-box GP GB) => boolean</procedure>
     164<procedure>(geopoint-within-box GP GB) --> boolean</procedure>
    165165
    166166
     
    179179==== make-geopolygon
    180180
    181 <procedure>(make-geopolygon GP ...) => geopolygon</procedure>
     181<procedure>(make-geopolygon GP ...) -> geopolygon</procedure>
    182182
    183183{{GP}} is a {{geopoint}}.
    184184
    185 <procedure>(make-geopolygon GPS) => geopolygon</procedure>
     185<procedure>(make-geopolygon GPS) -> geopolygon</procedure>
    186186
    187187{{GPS}} is {{(or (list-of geopoint) (vector-of geopoint))}}.
     
    189189==== geopolygon?
    190190
    191 <procedure>(geopolygon? OBJ) => boolean</procedure>
     191<procedure>(geopolygon? OBJ) --> boolean</procedure>
    192192
    193193==== check-geopolygon
    194194
    195 <procedure>(check-geopolygon LOC OBJ [VARNAM]) => geopolygon</procedure>
     195<procedure>(check-geopolygon LOC OBJ [VARNAM]) -> geopolygon</procedure>
    196196
    197197==== error-geopolygon
     
    201201==== geopolygon
    202202
    203 <procedure>(geopolygon GP...) => geopolygon</procedure>
     203<procedure>(geopolygon GP...) -> geopolygon</procedure>
    204204
    205205==== geopolygon-closed?
    206206
    207 <procedure>(geopolygon-closed? GPOLY) => boolean</procedure>
     207<procedure>(geopolygon-closed? GPOLY) --> boolean</procedure>
    208208
    209209Polygon has the same initial and final {{geopoint}}.
     
    211211==== geopolygon-open?
    212212
    213 <procedure>(geopolygon-open? GPOLY) => boolean</procedure>
     213<procedure>(geopolygon-open? GPOLY) --> boolean</procedure>
    214214
    215215Polygon does not have the same initial and final {{geopoint}}.
     
    217217==== geopolygon-bounding-box
    218218
    219 <procedure>(geopolygon-bounding-box GPOLY) => geobox</procedure>
     219<procedure>(geopolygon-bounding-box GPOLY) -> geobox</procedure>
    220220
    221221
     
    230230==== geopoint-in-closed-polygon?
    231231
    232 <procedure>(geopoint-in-closed-polygon? GP GPOLY [INTERSECTS? intersects?-pnp]) => boolean</procedure>
     232<procedure>(geopoint-in-closed-polygon? GP GPOLY [INTERSECTS? intersects?-pnp]) --> boolean</procedure>
    233233
    234234Is the {{(: GP geopoint)}} in the {{(: GPOLY (or (vector-of geopoint)
     
    236236
    237237{{INTERSECTS?}} is a {{(procedure ((: PI geopoint) (: PJ geopoint) (: LAT
    238 real) (: LON real)) => boolean)}} testing for ray intersection.
     238real) (: LON real)) --> boolean)}} testing for ray intersection.
    239239
    240240Treats an open geopolygon as closed.
     
    242242==== intersects?-pnp
    243243
    244 <procedure>(intersects?-pnp PI PJ LAT LON) => boolean</procedure>
     244<procedure>(intersects?-pnp PI PJ LAT LON) --> boolean</procedure>
    245245
    246246==== intersects?-pip
    247247
    248 <procedure>(intersects?-pip PI PJ LAT LON) => boolean</procedure>
     248<procedure>(intersects?-pip PI PJ LAT LON) --> boolean</procedure>
    249249
    250250
     
    259259==== pythagorean-distance
    260260
    261 <procedure>(pythagorean-distance LAT1 LON1 LAT2 LON2) => real</procedure>
     261<procedure>(pythagorean-distance LAT1 LON1 LAT2 LON2) -> real</procedure>
    262262
    263263==== pythagorean-distance*
    264264
    265 <procedure>(pythagorean-distance* LAT1 LON1 LAT2 LON2) => real</procedure>
     265<procedure>(pythagorean-distance* LAT1 LON1 LAT2 LON2) -> real</procedure>
    266266
    267267==== spherical-surface-distance
    268268
    269 <procedure>(spherical-surface-distance LAT1 LON1 LAT2 LON2 (R EARTH-RADIUS-KILOMETERS)) => real</procedure>
     269<procedure>(spherical-surface-distance LAT1 LON1 LAT2 LON2 (R EARTH-RADIUS-KILOMETERS)) -> real</procedure>
    270270
    271271==== great-circle-distance
    272272
    273 <procedure>(great-circle-distance LAT1 LON1 LAT2 LON2 (R EARTH-RADIUS-KILOMETERS)) => real</procedure>
     273<procedure>(great-circle-distance LAT1 LON1 LAT2 LON2 (R EARTH-RADIUS-KILOMETERS)) -> real</procedure>
    274274
    275275==== great-circle-distance-radians
    276276
    277 <procedure>(great-circle-distance-radians LAT1 LON1 LAT2 LON2 (R EARTH-RADIUS-KILOMETERS)) => real</procedure>
     277<procedure>(great-circle-distance-radians LAT1 LON1 LAT2 LON2 (R EARTH-RADIUS-KILOMETERS)) -> real</procedure>
    278278
    279279==== approximate-ellipsoid-distance
    280280
    281 <procedure>(approximate-ellipsoid-distance LAT1 LON1 LAT2 LON2 (R EARTH-RADIUS-KILOMETERS) (F EARTH-FLATTENING)) => real</procedure>
     281<procedure>(approximate-ellipsoid-distance LAT1 LON1 LAT2 LON2 (R EARTH-RADIUS-KILOMETERS) (F EARTH-FLATTENING)) -> real</procedure>
    282282
    283283==== great-circle-azimuth
    284284
    285 <procedure>(great-circle-azimuth LAT1 LON1 LAT2 LON2 [PREC 5]) => real</procedure>
     285<procedure>(great-circle-azimuth LAT1 LON1 LAT2 LON2 [PREC 5]) -> real</procedure>
    286286
    287287==== great-circle-position
    288288
    289 <procedure>(great-circle-position LAT LON DIS AZI (R EARTH-RADIUS-KILOMETERS)) => (values latitude longitude)</procedure>
     289<procedure>(great-circle-position LAT LON DIS AZI (R EARTH-RADIUS-KILOMETERS)) -> (values latitude longitude)</procedure>
    290290
    291291
     
    310310==== degree-minute-second-text
    311311
    312 <procedure>(degree-minute-second-text [DMS-TEXT]) => (list-of string)</procedure>
     312<procedure>(degree-minute-second-text [DMS-TEXT]) -> (list-of string)</procedure>
    313313
    314314{{DMS-TEXT}} is a 3 element {{list}} of {{string}} of the form {{(<degrees
     
    317317==== dms->degree
    318318
    319 <procedure>(dms->degree D M S) => real</procedure>
     319<procedure>(dms->degree D M S) -> real</procedure>
    320320
    321321==== degree->dms
    322322
    323 <procedure>(degree->dms DEG) => (values D M S)</procedure>
     323<procedure>(degree->dms DEG) -> (values D M S)</procedure>
    324324
    325325Returns the degree+minutes+seconds for the degrees {{DEG}}.
     
    327327==== dms->string
    328328
    329 <procedure>(dms->string D M S [LAT? [LEADING-DIR? [PAD ""]]]) => string</procedure>
     329<procedure>(dms->string D M S [LAT? [LEADING-DIR? [PAD ""]]]) -> string</procedure>
    330330
    331331Example: 122°45'10"W
     
    333333==== dms->string*
    334334
    335 <procedure>(dms->string* D M S [PAD ""]) => string</procedure>
     335<procedure>(dms->string* D M S [PAD ""]) -> string</procedure>
    336336
    337337Example: 122°45'10"
     
    339339==== string-dms->degree
    340340
    341 <procedure>(string-dms->degree STR [LAT?]) => real</procedure>
     341<procedure>(string-dms->degree STR [LAT?]) -> real</procedure>
    342342
    343343Returns the degrees for string form of dms {{STR}}.
     
    345345==== string->degree
    346346
    347 <procedure>(string->degree STR [LAT?]) => real</procedure>
     347<procedure>(string->degree STR [LAT?]) -> real</procedure>
    348348
    349349Synonym of {{string-dms->degree}}.
     
    351351==== degree->string
    352352
    353 <procedure>(degree->string DEG [LAT? [LEADING-DIR? [PAD ""]]]) => string</procedure>
     353<procedure>(degree->string DEG [LAT? [LEADING-DIR? [PAD ""]]]) -> string</procedure>
    354354
    355355Returns the dms-string for the degrees {{DEG}}.
     
    366366==== make-globe
    367367
    368 <procedure>(make-globe RADIUS FLATTENING) => globe</procedure>
     368<procedure>(make-globe RADIUS FLATTENING) -> globe</procedure>
    369369
    370370==== globe?
    371371
    372 <procedure>(globe? OBJ) => boolean</procedure>
     372<procedure>(globe? OBJ) --> boolean</procedure>
    373373
    374374==== check-globe
    375375
    376 <procedure>(check-globe LOC OBJ [VARNAM]) => globe</procedure>
     376<procedure>(check-globe LOC OBJ [VARNAM]) -> globe</procedure>
    377377
    378378==== error-globe
     
    382382==== globe-radius-kilometers
    383383
    384 <procedure>(globe-radius-kilometers GLOBE) => number</procedure>
     384<procedure>(globe-radius-kilometers GLOBE) -> number</procedure>
    385385
    386386==== globe-flattening-factor
    387387
    388 <procedure>(globe-flattening-factor GLOBE) => number</procedure>
     388<procedure>(globe-flattening-factor GLOBE) -> number</procedure>
    389389
    390390==== spherical-surface-distance
    391391
    392 <procedure>(spherical-surface-distance GLOBE GP1 GP2) => number</procedure>
     392<procedure>(spherical-surface-distance GLOBE GP1 GP2) -> number</procedure>
    393393
    394394==== great-circle-distance
    395395
    396 <procedure>(great-circle-distance GLOBE GP1 GP2) => number</procedure>
     396<procedure>(great-circle-distance GLOBE GP1 GP2) -> number</procedure>
    397397
    398398==== great-circle-distance-radians
    399399
    400 <procedure>(great-circle-distance-radians GLOBE GP1 GP2) => number</procedure>
     400<procedure>(great-circle-distance-radians GLOBE GP1 GP2) -> number</procedure>
    401401
    402402==== approximate-ellipsoid-distance
    403403
    404 <procedure>(approximate-ellipsoid-distance GLOBE GP1 GP2) => number</procedure>
     404<procedure>(approximate-ellipsoid-distance GLOBE GP1 GP2) -> number</procedure>
    405405
    406406==== great-circle-azimuth
    407407
    408 <procedure>(great-circle-azimuth GP1 GP2 [PRECISION 5]) => number</procedure>
     408<procedure>(great-circle-azimuth GP1 GP2 [PRECISION 5]) -> number</procedure>
    409409
    410410==== great-circle-position
    411411
    412 <procedure>(great-circle-position GLOBE GP DISTANCE AZIMUTH) => geopoint</procedure>
     412<procedure>(great-circle-position GLOBE GP DISTANCE AZIMUTH) -> geopoint</procedure>
    413413
    414414
     
    423423==== *earth-flattening*
    424424
    425 <variable>*earth-flattening* => real</variable>
     425<variable>*earth-flattening* -> real</variable>
    426426
    427427==== *earth-radius-miles*
    428428
    429 <variable>*earth-radius-miles* => real</variable>
     429<variable>*earth-radius-miles* -> real</variable>
    430430
    431431==== *earth-radius-kilometers*
    432432
    433 <variable>*earth-radius-kilometers* => real</variable>
     433<variable>*earth-radius-kilometers* -> real</variable>
    434434
    435435==== make-earth
    436436
    437 <procedure>(make-earth) => globe</procedure>
     437<procedure>(make-earth) -> globe</procedure>
    438438
    439439
Note: See TracChangeset for help on using the changeset viewer.