geodesic 1.0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (5) hide show
  1. data/COPYING.LESSER +503 -0
  2. data/Changelog +15 -0
  3. data/README.rdoc +91 -0
  4. data/lib/geodesic.rb +119 -0
  5. metadata +65 -0
@@ -0,0 +1,503 @@
1
+ License:
2
+ GNU LESSER GENERAL PUBLIC LICENSE
3
+ Version 2.1, February 1999
4
+
5
+ Copyright (C) 1991, 1999 Free Software Foundation, Inc.
6
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
7
+ Everyone is permitted to copy and distribute verbatim copies
8
+ of this license document, but changing it is not allowed.
9
+
10
+ [This is the first released version of the Lesser GPL. It also counts
11
+ as the successor of the GNU Library Public License, version 2, hence
12
+ the version number 2.1.]
13
+
14
+ Preamble
15
+
16
+ The licenses for most software are designed to take away your
17
+ freedom to share and change it. By contrast, the GNU General Public
18
+ Licenses are intended to guarantee your freedom to share and change
19
+ free software--to make sure the software is free for all its users.
20
+
21
+ This license, the Lesser General Public License, applies to some
22
+ specially designated software packages--typically libraries--of the
23
+ Free Software Foundation and other authors who decide to use it. You
24
+ can use it too, but we suggest you first think carefully about whether
25
+ this license or the ordinary General Public License is the better
26
+ strategy to use in any particular case, based on the explanations below.
27
+
28
+ When we speak of free software, we are referring to freedom of use,
29
+ not price. Our General Public Licenses are designed to make sure that
30
+ you have the freedom to distribute copies of free software (and charge
31
+ for this service if you wish); that you receive source code or can get
32
+ it if you want it; that you can change the software and use pieces of
33
+ it in new free programs; and that you are informed that you can do
34
+ these things.
35
+
36
+ To protect your rights, we need to make restrictions that forbid
37
+ distributors to deny you these rights or to ask you to surrender these
38
+ rights. These restrictions translate to certain responsibilities for
39
+ you if you distribute copies of the library or if you modify it.
40
+
41
+ For example, if you distribute copies of the library, whether gratis
42
+ or for a fee, you must give the recipients all the rights that we gave
43
+ you. You must make sure that they, too, receive or can get the source
44
+ code. If you link other code with the library, you must provide
45
+ complete object files to the recipients, so that they can relink them
46
+ with the library after making changes to the library and recompiling
47
+ it. And you must show them these terms so they know their rights.
48
+
49
+ We protect your rights with a two-step method: (1) we copyright the
50
+ library, and (2) we offer you this license, which gives you legal
51
+ permission to copy, distribute and/or modify the library.
52
+
53
+ To protect each distributor, we want to make it very clear that
54
+ there is no warranty for the free library. Also, if the library is
55
+ modified by someone else and passed on, the recipients should know
56
+ that what they have is not the original version, so that the original
57
+ author's reputation will not be affected by problems that might be
58
+ introduced by others.
59
+
60
+ Finally, software patents pose a constant threat to the existence of
61
+ any free program. We wish to make sure that a company cannot
62
+ effectively restrict the users of a free program by obtaining a
63
+ restrictive license from a patent holder. Therefore, we insist that
64
+ any patent license obtained for a version of the library must be
65
+ consistent with the full freedom of use specified in this license.
66
+
67
+ Most GNU software, including some libraries, is covered by the
68
+ ordinary GNU General Public License. This license, the GNU Lesser
69
+ General Public License, applies to certain designated libraries, and
70
+ is quite different from the ordinary General Public License. We use
71
+ this license for certain libraries in order to permit linking those
72
+ libraries into non-free programs.
73
+
74
+ When a program is linked with a library, whether statically or using
75
+ a shared library, the combination of the two is legally speaking a
76
+ combined work, a derivative of the original library. The ordinary
77
+ General Public License therefore permits such linking only if the
78
+ entire combination fits its criteria of freedom. The Lesser General
79
+ Public License permits more lax criteria for linking other code with
80
+ the library.
81
+
82
+ We call this license the "Lesser" General Public License because it
83
+ does Less to protect the user's freedom than the ordinary General
84
+ Public License. It also provides other free software developers Less
85
+ of an advantage over competing non-free programs. These disadvantages
86
+ are the reason we use the ordinary General Public License for many
87
+ libraries. However, the Lesser license provides advantages in certain
88
+ special circumstances.
89
+
90
+ For example, on rare occasions, there may be a special need to
91
+ encourage the widest possible use of a certain library, so that it becomes
92
+ a de-facto standard. To achieve this, non-free programs must be
93
+ allowed to use the library. A more frequent case is that a free
94
+ library does the same job as widely used non-free libraries. In this
95
+ case, there is little to gain by limiting the free library to free
96
+ software only, so we use the Lesser General Public License.
97
+
98
+ In other cases, permission to use a particular library in non-free
99
+ programs enables a greater number of people to use a large body of
100
+ free software. For example, permission to use the GNU C Library in
101
+ non-free programs enables many more people to use the whole GNU
102
+ operating system, as well as its variant, the GNU/Linux operating
103
+ system.
104
+
105
+ Although the Lesser General Public License is Less protective of the
106
+ users' freedom, it does ensure that the user of a program that is
107
+ linked with the Library has the freedom and the wherewithal to run
108
+ that program using a modified version of the Library.
109
+
110
+ The precise terms and conditions for copying, distribution and
111
+ modification follow. Pay close attention to the difference between a
112
+ "work based on the library" and a "work that uses the library". The
113
+ former contains code derived from the library, whereas the latter must
114
+ be combined with the library in order to run.
115
+
116
+ GNU LESSER GENERAL PUBLIC LICENSE
117
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
118
+
119
+ 0. This License Agreement applies to any software library or other
120
+ program which contains a notice placed by the copyright holder or
121
+ other authorized party saying it may be distributed under the terms of
122
+ this Lesser General Public License (also called "this License").
123
+ Each licensee is addressed as "you".
124
+
125
+ A "library" means a collection of software functions and/or data
126
+ prepared so as to be conveniently linked with application programs
127
+ (which use some of those functions and data) to form executables.
128
+
129
+ The "Library", below, refers to any such software library or work
130
+ which has been distributed under these terms. A "work based on the
131
+ Library" means either the Library or any derivative work under
132
+ copyright law: that is to say, a work containing the Library or a
133
+ portion of it, either verbatim or with modifications and/or translated
134
+ straightforwardly into another language. (Hereinafter, translation is
135
+ included without limitation in the term "modification".)
136
+
137
+ "Source code" for a work means the preferred form of the work for
138
+ making modifications to it. For a library, complete source code means
139
+ all the source code for all modules it contains, plus any associated
140
+ interface definition files, plus the scripts used to control compilation
141
+ and installation of the library.
142
+
143
+ Activities other than copying, distribution and modification are not
144
+ covered by this License; they are outside its scope. The act of
145
+ running a program using the Library is not restricted, and output from
146
+ such a program is covered only if its contents constitute a work based
147
+ on the Library (independent of the use of the Library in a tool for
148
+ writing it). Whether that is true depends on what the Library does
149
+ and what the program that uses the Library does.
150
+
151
+ 1. You may copy and distribute verbatim copies of the Library's
152
+ complete source code as you receive it, in any medium, provided that
153
+ you conspicuously and appropriately publish on each copy an
154
+ appropriate copyright notice and disclaimer of warranty; keep intact
155
+ all the notices that refer to this License and to the absence of any
156
+ warranty; and distribute a copy of this License along with the
157
+ Library.
158
+
159
+ You may charge a fee for the physical act of transferring a copy,
160
+ and you may at your option offer warranty protection in exchange for a
161
+ fee.
162
+
163
+ 2. You may modify your copy or copies of the Library or any portion
164
+ of it, thus forming a work based on the Library, and copy and
165
+ distribute such modifications or work under the terms of Section 1
166
+ above, provided that you also meet all of these conditions:
167
+
168
+ a) The modified work must itself be a software library.
169
+
170
+ b) You must cause the files modified to carry prominent notices
171
+ stating that you changed the files and the date of any change.
172
+
173
+ c) You must cause the whole of the work to be licensed at no
174
+ charge to all third parties under the terms of this License.
175
+
176
+ d) If a facility in the modified Library refers to a function or a
177
+ table of data to be supplied by an application program that uses
178
+ the facility, other than as an argument passed when the facility
179
+ is invoked, then you must make a good faith effort to ensure that,
180
+ in the event an application does not supply such function or
181
+ table, the facility still operates, and performs whatever part of
182
+ its purpose remains meaningful.
183
+
184
+ (For example, a function in a library to compute square roots has
185
+ a purpose that is entirely well-defined independent of the
186
+ application. Therefore, Subsection 2d requires that any
187
+ application-supplied function or table used by this function must
188
+ be optional: if the application does not supply it, the square
189
+ root function must still compute square roots.)
190
+
191
+ These requirements apply to the modified work as a whole. If
192
+ identifiable sections of that work are not derived from the Library,
193
+ and can be reasonably considered independent and separate works in
194
+ themselves, then this License, and its terms, do not apply to those
195
+ sections when you distribute them as separate works. But when you
196
+ distribute the same sections as part of a whole which is a work based
197
+ on the Library, the distribution of the whole must be on the terms of
198
+ this License, whose permissions for other licensees extend to the
199
+ entire whole, and thus to each and every part regardless of who wrote
200
+ it.
201
+
202
+ Thus, it is not the intent of this section to claim rights or contest
203
+ your rights to work written entirely by you; rather, the intent is to
204
+ exercise the right to control the distribution of derivative or
205
+ collective works based on the Library.
206
+
207
+ In addition, mere aggregation of another work not based on the Library
208
+ with the Library (or with a work based on the Library) on a volume of
209
+ a storage or distribution medium does not bring the other work under
210
+ the scope of this License.
211
+
212
+ 3. You may opt to apply the terms of the ordinary GNU General Public
213
+ License instead of this License to a given copy of the Library. To do
214
+ this, you must alter all the notices that refer to this License, so
215
+ that they refer to the ordinary GNU General Public License, version 2,
216
+ instead of to this License. (If a newer version than version 2 of the
217
+ ordinary GNU General Public License has appeared, then you can specify
218
+ that version instead if you wish.) Do not make any other change in
219
+ these notices.
220
+
221
+ Once this change is made in a given copy, it is irreversible for
222
+ that copy, so the ordinary GNU General Public License applies to all
223
+ subsequent copies and derivative works made from that copy.
224
+
225
+ This option is useful when you wish to copy part of the code of
226
+ the Library into a program that is not a library.
227
+
228
+ 4. You may copy and distribute the Library (or a portion or
229
+ derivative of it, under Section 2) in object code or executable form
230
+ under the terms of Sections 1 and 2 above provided that you accompany
231
+ it with the complete corresponding machine-readable source code, which
232
+ must be distributed under the terms of Sections 1 and 2 above on a
233
+ medium customarily used for software interchange.
234
+
235
+ If distribution of object code is made by offering access to copy
236
+ from a designated place, then offering equivalent access to copy the
237
+ source code from the same place satisfies the requirement to
238
+ distribute the source code, even though third parties are not
239
+ compelled to copy the source along with the object code.
240
+
241
+ 5. A program that contains no derivative of any portion of the
242
+ Library, but is designed to work with the Library by being compiled or
243
+ linked with it, is called a "work that uses the Library". Such a
244
+ work, in isolation, is not a derivative work of the Library, and
245
+ therefore falls outside the scope of this License.
246
+
247
+ However, linking a "work that uses the Library" with the Library
248
+ creates an executable that is a derivative of the Library (because it
249
+ contains portions of the Library), rather than a "work that uses the
250
+ library". The executable is therefore covered by this License.
251
+ Section 6 states terms for distribution of such executables.
252
+
253
+ When a "work that uses the Library" uses material from a header file
254
+ that is part of the Library, the object code for the work may be a
255
+ derivative work of the Library even though the source code is not.
256
+ Whether this is true is especially significant if the work can be
257
+ linked without the Library, or if the work is itself a library. The
258
+ threshold for this to be true is not precisely defined by law.
259
+
260
+ If such an object file uses only numerical parameters, data
261
+ structure layouts and accessors, and small macros and small inline
262
+ functions (ten lines or less in length), then the use of the object
263
+ file is unrestricted, regardless of whether it is legally a derivative
264
+ work. (Executables containing this object code plus portions of the
265
+ Library will still fall under Section 6.)
266
+
267
+ Otherwise, if the work is a derivative of the Library, you may
268
+ distribute the object code for the work under the terms of Section 6.
269
+ Any executables containing that work also fall under Section 6,
270
+ whether or not they are linked directly with the Library itself.
271
+
272
+ 6. As an exception to the Sections above, you may also combine or
273
+ link a "work that uses the Library" with the Library to produce a
274
+ work containing portions of the Library, and distribute that work
275
+ under terms of your choice, provided that the terms permit
276
+ modification of the work for the customer's own use and reverse
277
+ engineering for debugging such modifications.
278
+
279
+ You must give prominent notice with each copy of the work that the
280
+ Library is used in it and that the Library and its use are covered by
281
+ this License. You must supply a copy of this License. If the work
282
+ during execution displays copyright notices, you must include the
283
+ copyright notice for the Library among them, as well as a reference
284
+ directing the user to the copy of this License. Also, you must do one
285
+ of these things:
286
+
287
+ a) Accompany the work with the complete corresponding
288
+ machine-readable source code for the Library including whatever
289
+ changes were used in the work (which must be distributed under
290
+ Sections 1 and 2 above); and, if the work is an executable linked
291
+ with the Library, with the complete machine-readable "work that
292
+ uses the Library", as object code and/or source code, so that the
293
+ user can modify the Library and then relink to produce a modified
294
+ executable containing the modified Library. (It is understood
295
+ that the user who changes the contents of definitions files in the
296
+ Library will not necessarily be able to recompile the application
297
+ to use the modified definitions.)
298
+
299
+ b) Use a suitable shared library mechanism for linking with the
300
+ Library. A suitable mechanism is one that (1) uses at run time a
301
+ copy of the library already present on the user's computer system,
302
+ rather than copying library functions into the executable, and (2)
303
+ will operate properly with a modified version of the library, if
304
+ the user installs one, as long as the modified version is
305
+ interface-compatible with the version that the work was made with.
306
+
307
+ c) Accompany the work with a written offer, valid for at
308
+ least three years, to give the same user the materials
309
+ specified in Subsection 6a, above, for a charge no more
310
+ than the cost of performing this distribution.
311
+
312
+ d) If distribution of the work is made by offering access to copy
313
+ from a designated place, offer equivalent access to copy the above
314
+ specified materials from the same place.
315
+
316
+ e) Verify that the user has already received a copy of these
317
+ materials or that you have already sent this user a copy.
318
+
319
+ For an executable, the required form of the "work that uses the
320
+ Library" must include any data and utility programs needed for
321
+ reproducing the executable from it. However, as a special exception,
322
+ the materials to be distributed need not include anything that is
323
+ normally distributed (in either source or binary form) with the major
324
+ components (compiler, kernel, and so on) of the operating system on
325
+ which the executable runs, unless that component itself accompanies
326
+ the executable.
327
+
328
+ It may happen that this requirement contradicts the license
329
+ restrictions of other proprietary libraries that do not normally
330
+ accompany the operating system. Such a contradiction means you cannot
331
+ use both them and the Library together in an executable that you
332
+ distribute.
333
+
334
+ 7. You may place library facilities that are a work based on the
335
+ Library side-by-side in a single library together with other library
336
+ facilities not covered by this License, and distribute such a combined
337
+ library, provided that the separate distribution of the work based on
338
+ the Library and of the other library facilities is otherwise
339
+ permitted, and provided that you do these two things:
340
+
341
+ a) Accompany the combined library with a copy of the same work
342
+ based on the Library, uncombined with any other library
343
+ facilities. This must be distributed under the terms of the
344
+ Sections above.
345
+
346
+ b) Give prominent notice with the combined library of the fact
347
+ that part of it is a work based on the Library, and explaining
348
+ where to find the accompanying uncombined form of the same work.
349
+
350
+ 8. You may not copy, modify, sublicense, link with, or distribute
351
+ the Library except as expressly provided under this License. Any
352
+ attempt otherwise to copy, modify, sublicense, link with, or
353
+ distribute the Library is void, and will automatically terminate your
354
+ rights under this License. However, parties who have received copies,
355
+ or rights, from you under this License will not have their licenses
356
+ terminated so long as such parties remain in full compliance.
357
+
358
+ 9. You are not required to accept this License, since you have not
359
+ signed it. However, nothing else grants you permission to modify or
360
+ distribute the Library or its derivative works. These actions are
361
+ prohibited by law if you do not accept this License. Therefore, by
362
+ modifying or distributing the Library (or any work based on the
363
+ Library), you indicate your acceptance of this License to do so, and
364
+ all its terms and conditions for copying, distributing or modifying
365
+ the Library or works based on it.
366
+
367
+ 10. Each time you redistribute the Library (or any work based on the
368
+ Library), the recipient automatically receives a license from the
369
+ original licensor to copy, distribute, link with or modify the Library
370
+ subject to these terms and conditions. You may not impose any further
371
+ restrictions on the recipients' exercise of the rights granted herein.
372
+ You are not responsible for enforcing compliance by third parties with
373
+ this License.
374
+
375
+ 11. If, as a consequence of a court judgment or allegation of patent
376
+ infringement or for any other reason (not limited to patent issues),
377
+ conditions are imposed on you (whether by court order, agreement or
378
+ otherwise) that contradict the conditions of this License, they do not
379
+ excuse you from the conditions of this License. If you cannot
380
+ distribute so as to satisfy simultaneously your obligations under this
381
+ License and any other pertinent obligations, then as a consequence you
382
+ may not distribute the Library at all. For example, if a patent
383
+ license would not permit royalty-free redistribution of the Library by
384
+ all those who receive copies directly or indirectly through you, then
385
+ the only way you could satisfy both it and this License would be to
386
+ refrain entirely from distribution of the Library.
387
+
388
+ If any portion of this section is held invalid or unenforceable under any
389
+ particular circumstance, the balance of the section is intended to apply,
390
+ and the section as a whole is intended to apply in other circumstances.
391
+
392
+ It is not the purpose of this section to induce you to infringe any
393
+ patents or other property right claims or to contest validity of any
394
+ such claims; this section has the sole purpose of protecting the
395
+ integrity of the free software distribution system which is
396
+ implemented by public license practices. Many people have made
397
+ generous contributions to the wide range of software distributed
398
+ through that system in reliance on consistent application of that
399
+ system; it is up to the author/donor to decide if he or she is willing
400
+ to distribute software through any other system and a licensee cannot
401
+ impose that choice.
402
+
403
+ This section is intended to make thoroughly clear what is believed to
404
+ be a consequence of the rest of this License.
405
+
406
+ 12. If the distribution and/or use of the Library is restricted in
407
+ certain countries either by patents or by copyrighted interfaces, the
408
+ original copyright holder who places the Library under this License may add
409
+ an explicit geographical distribution limitation excluding those countries,
410
+ so that distribution is permitted only in or among countries not thus
411
+ excluded. In such case, this License incorporates the limitation as if
412
+ written in the body of this License.
413
+
414
+ 13. The Free Software Foundation may publish revised and/or new
415
+ versions of the Lesser General Public License from time to time.
416
+ Such new versions will be similar in spirit to the present version,
417
+ but may differ in detail to address new problems or concerns.
418
+
419
+ Each version is given a distinguishing version number. If the Library
420
+ specifies a version number of this License which applies to it and
421
+ "any later version", you have the option of following the terms and
422
+ conditions either of that version or of any later version published by
423
+ the Free Software Foundation. If the Library does not specify a
424
+ license version number, you may choose any version ever published by
425
+ the Free Software Foundation.
426
+
427
+ 14. If you wish to incorporate parts of the Library into other free
428
+ programs whose distribution conditions are incompatible with these,
429
+ write to the author to ask for permission. For software which is
430
+ copyrighted by the Free Software Foundation, write to the Free
431
+ Software Foundation; we sometimes make exceptions for this. Our
432
+ decision will be guided by the two goals of preserving the free status
433
+ of all derivatives of our free software and of promoting the sharing
434
+ and reuse of software generally.
435
+
436
+ NO WARRANTY
437
+
438
+ 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO
439
+ WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW.
440
+ EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR
441
+ OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY
442
+ KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
443
+ IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
444
+ PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE
445
+ LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME
446
+ THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
447
+
448
+ 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
449
+ WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY
450
+ AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU
451
+ FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR
452
+ CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
453
+ LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
454
+ RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
455
+ FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
456
+ SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
457
+ DAMAGES.
458
+
459
+ END OF TERMS AND CONDITIONS
460
+
461
+ How to Apply These Terms to Your New Libraries
462
+
463
+ If you develop a new library, and you want it to be of the greatest
464
+ possible use to the public, we recommend making it free software that
465
+ everyone can redistribute and change. You can do so by permitting
466
+ redistribution under these terms (or, alternatively, under the terms of the
467
+ ordinary General Public License).
468
+
469
+ To apply these terms, attach the following notices to the library. It is
470
+ safest to attach them to the start of each source file to most effectively
471
+ convey the exclusion of warranty; and each file should have at least the
472
+ "copyright" line and a pointer to where the full notice is found.
473
+
474
+ <one line to give the library's name and a brief idea of what it does.>
475
+ Copyright (C) <year> <name of author>
476
+
477
+ This library is free software; you can redistribute it and/or
478
+ modify it under the terms of the GNU Lesser General Public
479
+ License as published by the Free Software Foundation; either
480
+ version 2.1 of the License, or (at your option) any later version.
481
+
482
+ This library is distributed in the hope that it will be useful,
483
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
484
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
485
+ Lesser General Public License for more details.
486
+
487
+ You should have received a copy of the GNU Lesser General Public
488
+ License along with this library; if not, write to the Free Software
489
+ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
490
+
491
+ Also add information on how to contact you by electronic and paper mail.
492
+
493
+ You should also get your employer (if you work as a programmer) or your
494
+ school, if any, to sign a "copyright disclaimer" for the library, if
495
+ necessary. Here is a sample; alter the names:
496
+
497
+ Yoyodyne, Inc., hereby disclaims all copyright interest in the
498
+ library `Frob' (a library for tweaking knobs) written by James Random Hacker.
499
+
500
+ <signature of Ty Coon>, 1 April 1990
501
+ Ty Coon, President of Vice
502
+
503
+ That's all there is to it!
@@ -0,0 +1,15 @@
1
+ = Geodesic Changelog
2
+
3
+ == Version 1.0.1
4
+
5
+ * Moved gem hosting to gemcutter.org. No functional change.
6
+
7
+ == Version 1.0.0
8
+
9
+ * Changed API call, Geodesic.dest_point to Geodesic.dest_position to be more consistent.
10
+
11
+ * Cleaned up and completed API and README documentation.
12
+
13
+ == Version 0.0.1
14
+
15
+ * Initial realease
@@ -0,0 +1,91 @@
1
+ = Geodesic -- Distance and bearing calculations over the Earth's surface
2
+
3
+ This package contains Geodesic, which calculates distance and bearing
4
+ over the Earth's surface.
5
+
6
+ Geodesic contains the following features:
7
+
8
+ * A Position class to encapsulate an Earth position (latitude and longitude)
9
+
10
+ * A method to calculate the distance between two positions using Haversine formula
11
+
12
+ * A method to calculate the distance between two positions using the Law of Cosines
13
+
14
+ * A method to calculate the initial bearing between two positions
15
+
16
+ * A method to calculate a position a given distance from another position along a bearing
17
+
18
+ All input parameters to these functions are Floats. Longitudes
19
+ are expected to be in the range of -180.0 to 180.0 decimal degrees,
20
+ latitudes in the range of -90.0 to 90.0 decimal degrees and bearings in
21
+ the range of 0.0 to 360.0 (where 0.0 is North). Distances are measured in
22
+ kilometers.
23
+
24
+ == Installation
25
+
26
+ Geodesic can be installed as a Gem from Gemcutter. If Gemcutter is not listed as
27
+ one of your sources, do this ONCE. You can check with the --list option first.
28
+
29
+ gem sources --list
30
+ gem sources -a http://gemcutter.org
31
+
32
+ Then, install.
33
+
34
+ sudo gem install geodesic
35
+
36
+ == Sample Usage
37
+
38
+ require 'rubygems'
39
+ require 'geodesic'
40
+
41
+ fremont = Geodesic::Position.new(37.549531, -121.998711)
42
+ farmington = Geodesic::Position.new(37.923482, -121.015263)
43
+
44
+ d = Geodesic::dist_haversine(fremont.lat, fremont.lon, farmington.lat, farmington.lon)
45
+ print "distance from Fremont to Farmington is ", d, " kilometers\n"
46
+
47
+ b = Geodesic::bearing(fremont.lat, fremont.lon, farmington.lat, farmington.lon)
48
+ print "bearing is ", b, " degrees\n"
49
+
50
+ p = Geodesic::dest_position(fremont.lat, fremont.lon, b, d + 10)
51
+ print "10 kilometers beyond farmington is ", p.lat, ", ", p.lon, "\n"
52
+
53
+ The output is:
54
+
55
+ distance from Fremont to Farmington is 95.957632116596 kilometers
56
+ bearing is 64.0206814526114 degrees
57
+ 10 kilometers beyond farmington is 37.9619800970259, -120.912203460738
58
+
59
+ == Development
60
+ === Source Repository
61
+
62
+ Geodesic is currently hosted at github. The github web page is
63
+ http://github.com/kookjr/geodesic. The public git clone URL is
64
+
65
+ * git://github.com/kookjr/geodesic.git
66
+
67
+ === Running the Test Suite
68
+
69
+ Unit tests can be run with the following command.
70
+
71
+ ruby -Ilib test/tc_geodesic.rb
72
+ or
73
+ rake test
74
+
75
+ === Issues and Bug Reports
76
+
77
+ Report and follow issue status at the project's GitHub site.
78
+
79
+ http://github.com/kookjr/geodesic/issues
80
+
81
+ == Credits
82
+
83
+ The original author of the JavaScript implementation, Chris Veness,
84
+ can be found at:
85
+
86
+ http://www.movable-type.co.uk/scripts/latlong.html
87
+
88
+ == License
89
+
90
+ GNU LGPL, Lesser General Public License version 2.1. For details,
91
+ see file "COPYING.LESSER".
@@ -0,0 +1,119 @@
1
+ # geodesic - Latitude/longitude spherical geodesy formulae & scripts
2
+ #
3
+ # Copyright (C) Chris Veness 2002-2009
4
+ # Copyright (C) 2009 Mathew Cucuzella (kookjr@gmail.com)
5
+ #
6
+ # This library is free software; you can redistribute it and/or
7
+ # modify it under the terms of the GNU Lesser General Public
8
+ # License as published by the Free Software Foundation; either
9
+ # version 2.1 of the License, or (at your option) any later version.
10
+ #
11
+ # This library is distributed in the hope that it will be useful,
12
+ # but WITHOUT ANY WARRANTY; without even the implied warranty of
13
+ # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14
+ # Lesser General Public License for more details.
15
+ #
16
+ # You should have received a copy of the GNU Lesser General Public
17
+ # License along with this library; if not, write to the Free Software
18
+ # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19
+
20
+ # Additions to Float for conversion between various units.
21
+ class Float
22
+ # Convert decimal degrees to radians. Input range is either -180.0 to 180.0
23
+ # for longitudes, or -90.0 to 90.0 for latitudes.
24
+ def to_radians
25
+ self * Math::PI / 180.0
26
+ end
27
+
28
+ # Convert radians to degrees. Return range is -180.0 to 180.0.
29
+ def to_degrees
30
+ self * 180 / Math::PI
31
+ end
32
+
33
+ # Convert radians to bearing. Return degrees range 0.0 to 360.0.
34
+ def to_bearing
35
+ (self.to_degrees()+360.0) % 360.0
36
+ end
37
+ end
38
+
39
+ # Geodesic is a Ruby library for calculating distance and bearing on
40
+ # the Earth's surface. Positions are defined by longitude and
41
+ # latitude. The API uses Float values for all input and returned
42
+ # types. Distances are memasured in kilometers (km).
43
+ module Geodesic
44
+
45
+ # Earth's radius in kilometers
46
+ EARTH_RADIUS = 6371.0
47
+
48
+
49
+ # Class to hold the latitude and longitude of a position.
50
+ class Position
51
+ attr_accessor :lat
52
+ attr_accessor :lon
53
+
54
+ # Construct a position with a given latitude and longitude.
55
+ def initialize(lat, lon)
56
+ @lat = lat
57
+ @lon = lon
58
+ end
59
+ end
60
+
61
+ # Use Haversine formula to Calculate distance (in kilometers) between two positions specified by
62
+ # latitude/longitude in numeric degrees of type Float.
63
+ def Geodesic.dist_haversine(lat1, lon1, lat2, lon2)
64
+ dLat = (lat2-lat1).to_radians()
65
+ dLon = (lon2-lon1).to_radians()
66
+ lat1 = lat1.to_radians()
67
+ lat2 = lat2.to_radians()
68
+
69
+ a = Math::sin(dLat/2) * Math::sin(dLat/2) +
70
+ Math::cos(lat1) * Math::cos(lat2) *
71
+ Math::sin(dLon/2) * Math::sin(dLon/2)
72
+ c = 2 * Math::atan2(Math::sqrt(a), Math::sqrt(1-a))
73
+ d = EARTH_RADIUS * c
74
+ return d
75
+ end
76
+
77
+ # Use Law of Cosines formula to calculate distance (in kilometers) between two positions specified by
78
+ # latitude/longitude in numeric degrees of type Float.
79
+ def Geodesic.dist_cosine_law(lat1, lon1, lat2, lon2)
80
+ d = Math::acos(Math::sin(lat1.to_radians())*Math::sin(lat2.to_radians()) +
81
+ Math::cos(lat1.to_radians())*Math::cos(lat2.to_radians()) *
82
+ Math::cos((lon2-lon1).to_radians())) * EARTH_RADIUS
83
+ return d
84
+ end
85
+
86
+ # Calculate (initial) bearing in degrees between two positions. Return
87
+ # range is 0.0 to 360.0. Latitudes and longitudes are of type Float.
88
+ # see http://williams.best.vwh.net/avform.htm#Crs
89
+ def Geodesic.bearing(lat1, lon1, lat2, lon2)
90
+ lat1 = lat1.to_radians()
91
+ lat2 = lat2.to_radians()
92
+ dLon = (lon2-lon1).to_radians()
93
+
94
+ y = Math::sin(dLon) * Math::cos(lat2)
95
+ x = Math::cos(lat1)*Math::sin(lat2) -
96
+ Math::sin(lat1)*Math::cos(lat2)*Math::cos(dLon)
97
+ return Math::atan2(y, x).to_bearing()
98
+ end
99
+
100
+ # Calculate destination position given start position, initial bearing (degrees 0.0 to
101
+ # 360.0) and distance (kilometers).
102
+ # All values of type Float. Return a Position class or nil.
103
+ # see http://williams.best.vwh.net/avform.htm#LL
104
+ def Geodesic.dest_position(lat1, lon1, brng, d)
105
+ lat1 = lat1.to_radians()
106
+ lon1 = lon1.to_radians()
107
+ brng = brng.to_radians()
108
+
109
+ lat2 = Math::asin(Math::sin(lat1)*Math::cos(d/EARTH_RADIUS) +
110
+ Math::cos(lat1)*Math::sin(d/EARTH_RADIUS)*Math::cos(brng) )
111
+ lon2 = lon1 + Math::atan2(Math::sin(brng)*Math::sin(d/EARTH_RADIUS)*Math::cos(lat1),
112
+ Math::cos(d/EARTH_RADIUS)-Math::sin(lat1)*Math::sin(lat2))
113
+ lon2 = (lon2+Math::PI)%(2*Math::PI) - Math::PI # normalise to +/-radians
114
+
115
+ return nil if lat2.nan? || lon2.nan?
116
+ return Position.new(lat2.to_degrees(), lon2.to_degrees())
117
+ end
118
+
119
+ end
metadata ADDED
@@ -0,0 +1,65 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: geodesic
3
+ version: !ruby/object:Gem::Version
4
+ version: 1.0.1
5
+ platform: ruby
6
+ authors:
7
+ - Mathew Cucuzella
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+
12
+ date: 2009-11-20 00:00:00 -07:00
13
+ default_executable:
14
+ dependencies: []
15
+
16
+ description: Geodesic is a Ruby library for calculating distance and bearing on the Earth's surface. Positions are defined by longitude and latitude. The API uses Float values for all input and returned types. Distances are memasured in kilometers (km).
17
+ email: kookjr@gmail.com
18
+ executables: []
19
+
20
+ extensions: []
21
+
22
+ extra_rdoc_files:
23
+ - Changelog
24
+ - COPYING.LESSER
25
+ - README.rdoc
26
+ files:
27
+ - lib/geodesic.rb
28
+ - Changelog
29
+ - COPYING.LESSER
30
+ - README.rdoc
31
+ has_rdoc: true
32
+ homepage: http://github.com/kookjr/geodesic
33
+ licenses: []
34
+
35
+ post_install_message:
36
+ rdoc_options:
37
+ - --line-numbers
38
+ - --inline-source
39
+ - --main
40
+ - README.rdoc
41
+ - --title
42
+ - Geodesic Documenatation
43
+ require_paths:
44
+ - lib
45
+ required_ruby_version: !ruby/object:Gem::Requirement
46
+ requirements:
47
+ - - ">="
48
+ - !ruby/object:Gem::Version
49
+ version: "0"
50
+ version:
51
+ required_rubygems_version: !ruby/object:Gem::Requirement
52
+ requirements:
53
+ - - ">="
54
+ - !ruby/object:Gem::Version
55
+ version: "0"
56
+ version:
57
+ requirements: []
58
+
59
+ rubyforge_project:
60
+ rubygems_version: 1.3.5
61
+ signing_key:
62
+ specification_version: 3
63
+ summary: Geodesic is a ruby library for calculating distance and bearing on the Earth's surface.
64
+ test_files: []
65
+