geographiclib 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fa8370a9028f271543b408485a76114b2d7f396f
-  data.tar.gz: 21443c4c505ce041d24155701c38e4a5a3ffa420
+  metadata.gz: cb0f807373f145e2b92afb212b290d8ba06126a3
+  data.tar.gz: 3cfb57e02c66a827b79d22daf013feeaeea431b4
 SHA512:
-  metadata.gz: 3c0efaf0dbadca39751487f1626cb3124b6554fb66e367455e9431316944bcbe5dfb19af4517009349730d306dd59e8c5e07a1bb5c693598cb7dcf3232c9a4ad
-  data.tar.gz: 6b4e08090d147a0e4ebaf5adf219485b4f20c7b1b749facbffe63193706b3b5ec4eec4f74bf3049365e4e22f1ce5e45bdcd33a4a2d7ac520be9569b17ab4ad8a
+  metadata.gz: e9caa261f5a9d99f9b1e9163877ab8eb36c02fda93df024503c71026cad265908a3e1e0cf8b8b15f500667b72361f25b044d845845e1ffa634f5cb128f8c8bcf
+  data.tar.gz: 1a9696ef61ce6faae4a230ba3810c9f2b472a84ae4376e6fe55084f35b3597f99787eef0f471d0766b1049d905e2836ffa9f285ada09d001693349e579b54c0e

data/ext/geographiclib/geographiclib.cpp

@@ -1,62 +1,281 @@
 #include <ruby.h>
 #include <GeographicLib/Constants.hpp>
 #include <GeographicLib/Geodesic.hpp>
+#include <GeographicLib/DMS.hpp>
+#include <GeographicLib/Geocentric.hpp>
+#include <GeographicLib/LocalCartesian.hpp>
+
+#define rb_symbol(s) rb_id2sym(rb_intern_const(s))
+
+static void decode_lat_lon(VALUE vlat, VALUE vlon, GeographicLib::Math::real &lat, GeographicLib::Math::real &lon)
+{
+  std::string slat, slon;
+  if (rb_type(vlat) == T_STRING && rb_type(vlon) == T_STRING) {
+    slat = rb_string_value_cstr(&vlat);
+    slon = rb_string_value_cstr(&vlon);
+    try {
+      GeographicLib::DMS::DecodeLatLon(slat, slon, lat, lon);
+    } catch (GeographicLib::GeographicErr e) {
+      rb_raise(rb_eRuntimeError, "This is not a valid position.");
+    }
+  } else {
+    lat = rb_num2dbl(vlat);
+    lon = rb_num2dbl(vlon);
+  }
+}
+
+static void decode_azi(VALUE vazi, GeographicLib::Math::real &azi)
+{
+  std::string sazi;
+  if (rb_type(vazi) == T_STRING) {
+    sazi = rb_string_value_cstr(&vazi);
+    try {
+      azi = GeographicLib::DMS::DecodeAzimuth(sazi);
+    } catch (GeographicLib::GeographicErr e) {
+      rb_raise(rb_eRuntimeError, "This is not a valid azimuth.");
+    }
+  } else {
+    azi = rb_num2dbl(vazi);
+  }
+}
 
 static VALUE geographiclib_geodesic_direct(VALUE self, VALUE a, VALUE f, VALUE vlat1, VALUE vlon1, VALUE vazi1, VALUE arcmode, VALUE vs12_a12)
 {
-  GeographicLib::Geodesic g(NUM2DBL(a), NUM2DBL(f));
+  GeographicLib::Geodesic g(rb_num2dbl(a), rb_num2dbl(f));
   GeographicLib::Math::real lat1, lon1, s12_a12, lat2, lon2, s12, azi1, azi2, m12, M12, M21, S12;
-  lat1 = NUM2DBL(vlat1);
-  lon1 = NUM2DBL(vlon1);
-  azi1 = NUM2DBL(vazi1);
-  s12_a12 = NUM2DBL(vs12_a12);
+  decode_lat_lon(vlat1, vlon1, lat1, lon1);
+  decode_azi(vazi1, azi1);
+  s12_a12 = rb_num2dbl(vs12_a12);
   g.GenDirect(lat1, lon1, azi1, arcmode, s12_a12, GeographicLib::Geodesic::ALL, lat2, lon2, azi2, s12, m12, M12, M21, S12);
   VALUE r = rb_hash_new();
-  rb_hash_aset(r, rb_id2sym(rb_intern_const("lat1")), DBL2NUM(lat1));
-  rb_hash_aset(r, rb_id2sym(rb_intern_const("lon1")), DBL2NUM(lon1));
-  rb_hash_aset(r, rb_id2sym(rb_intern_const("lat2")), DBL2NUM(lat2));
-  rb_hash_aset(r, rb_id2sym(rb_intern_const("lon2")), DBL2NUM(lon2));
-  rb_hash_aset(r, rb_id2sym(rb_intern_const("s12")), DBL2NUM(s12));
-  rb_hash_aset(r, rb_id2sym(rb_intern_const("azi1")), DBL2NUM(azi1));
-  rb_hash_aset(r, rb_id2sym(rb_intern_const("azi2")), DBL2NUM(azi2));
-  rb_hash_aset(r, rb_id2sym(rb_intern_const("m12")), DBL2NUM(m12));
-  rb_hash_aset(r, rb_id2sym(rb_intern_const("M12")), DBL2NUM(M12));
-  rb_hash_aset(r, rb_id2sym(rb_intern_const("M21")), DBL2NUM(M21));
-  rb_hash_aset(r, rb_id2sym(rb_intern_const("S12")), DBL2NUM(S12));
+  rb_hash_aset(r, rb_symbol("lat1"), rb_float_new(lat1));
+  rb_hash_aset(r, rb_symbol("lon1"), rb_float_new(lon1));
+  rb_hash_aset(r, rb_symbol("lat2"), rb_float_new(lat2));
+  rb_hash_aset(r, rb_symbol("lon2"), rb_float_new(lon2));
+  rb_hash_aset(r, rb_symbol("s12"), rb_float_new(s12));
+  rb_hash_aset(r, rb_symbol("azi1"), rb_float_new(azi1));
+  rb_hash_aset(r, rb_symbol("azi2"), rb_float_new(azi2));
+  rb_hash_aset(r, rb_symbol("m12"), rb_float_new(m12));
+  rb_hash_aset(r, rb_symbol("M12"), rb_float_new(M12));
+  rb_hash_aset(r, rb_symbol("M21"), rb_float_new(M21));
+  rb_hash_aset(r, rb_symbol("S12"), rb_float_new(S12));
   return r;
 }
 
 static VALUE geographiclib_geodesic_inverse(VALUE self, VALUE a, VALUE f, VALUE vlat1, VALUE vlon1, VALUE vlat2, VALUE vlon2)
 {
-  GeographicLib::Geodesic g(NUM2DBL(a), NUM2DBL(f));
+  GeographicLib::Geodesic g(rb_num2dbl(a), rb_num2dbl(f));
   GeographicLib::Math::real lat1, lon1, lat2, lon2, s12, azi1, azi2, m12, M12, M21, S12;
-  lat1 = NUM2DBL(vlat1);
-  lon1 = NUM2DBL(vlon1);
-  lat2 = NUM2DBL(vlat2);
-  lon2 = NUM2DBL(vlon2);
+  decode_lat_lon(vlat1, vlon1, lat1, lon1);
+  decode_lat_lon(vlat2, vlon2, lat2, lon2);
   g.GenInverse(lat1, lon1, lat2, lon2, GeographicLib::Geodesic::ALL, s12, azi1, azi2, m12, M12, M21, S12);
   VALUE r = rb_hash_new();
-  rb_hash_aset(r, rb_id2sym(rb_intern_const("lat1")), DBL2NUM(lat1));
-  rb_hash_aset(r, rb_id2sym(rb_intern_const("lon1")), DBL2NUM(lon1));
-  rb_hash_aset(r, rb_id2sym(rb_intern_const("lat2")), DBL2NUM(lat2));
-  rb_hash_aset(r, rb_id2sym(rb_intern_const("lon2")), DBL2NUM(lon2));
-  rb_hash_aset(r, rb_id2sym(rb_intern_const("s12")), DBL2NUM(s12));
-  rb_hash_aset(r, rb_id2sym(rb_intern_const("azi1")), DBL2NUM(azi1));
-  rb_hash_aset(r, rb_id2sym(rb_intern_const("azi2")), DBL2NUM(azi2));
-  rb_hash_aset(r, rb_id2sym(rb_intern_const("m12")), DBL2NUM(m12));
-  rb_hash_aset(r, rb_id2sym(rb_intern_const("M12")), DBL2NUM(M12));
-  rb_hash_aset(r, rb_id2sym(rb_intern_const("M21")), DBL2NUM(M21));
-  rb_hash_aset(r, rb_id2sym(rb_intern_const("S12")), DBL2NUM(S12));
+  rb_hash_aset(r, rb_symbol("lat1"), rb_float_new(lat1));
+  rb_hash_aset(r, rb_symbol("lon1"), rb_float_new(lon1));
+  rb_hash_aset(r, rb_symbol("lat2"), rb_float_new(lat2));
+  rb_hash_aset(r, rb_symbol("lon2"), rb_float_new(lon2));
+  rb_hash_aset(r, rb_symbol("s12"), rb_float_new(s12));
+  rb_hash_aset(r, rb_symbol("azi1"), rb_float_new(azi1));
+  rb_hash_aset(r, rb_symbol("azi2"), rb_float_new(azi2));
+  rb_hash_aset(r, rb_symbol("m12"), rb_float_new(m12));
+  rb_hash_aset(r, rb_symbol("M12"), rb_float_new(M12));
+  rb_hash_aset(r, rb_symbol("M21"), rb_float_new(M21));
+  rb_hash_aset(r, rb_symbol("S12"), rb_float_new(S12));
+  return r;
+}
+
+static VALUE geographiclib_dms_decode(VALUE self, VALUE str)
+{
+  std::string s = rb_string_value_cstr(&str);
+  try {
+    GeographicLib::DMS::flag f;
+    GeographicLib::Math::real angle = GeographicLib::DMS::Decode(s, f);
+    VALUE r = rb_ary_new();
+    rb_ary_push(r, rb_float_new(angle));
+    switch (f) {
+      case GeographicLib::DMS::LATITUDE: rb_ary_push(r, rb_symbol("lat")); break;
+      case GeographicLib::DMS::LONGITUDE: rb_ary_push(r, rb_symbol("lon")); break;
+      case GeographicLib::DMS::AZIMUTH: rb_ary_push(r, rb_symbol("azi")); break;
+      case GeographicLib::DMS::NUMBER: rb_ary_push(r, rb_symbol("number")); break;
+      default: rb_ary_push(r, rb_symbol("none")); break;
+    }
+    return r;
+  } catch (GeographicLib::GeographicErr e) {
+    rb_raise(rb_eRuntimeError, "String is malformed.");
+  }
+}
+
+static VALUE geographiclib_dms_decode_lat_lon(VALUE self, VALUE vlat, VALUE vlon)
+{
+  GeographicLib::Math::real lat, lon;
+  decode_lat_lon(vlat, vlon, lat, lon);
+  VALUE r = rb_ary_new();
+  rb_ary_push(r, rb_float_new(lat));
+  rb_ary_push(r, rb_float_new(lon));
+  return r;
+}
+
+static VALUE geographiclib_dms_decode_azi(VALUE self, VALUE vazi)
+{
+  GeographicLib::Math::real azi;
+  decode_azi(vazi, azi);
+  return rb_float_new(azi);
+}
+
+static void geographiclib_local_cartesian_free(void *x)
+{
+  if (x) {
+    delete (GeographicLib::LocalCartesian *) x;
+  }
+}
+
+static size_t geographiclib_local_cartesian_size(const void *x)
+{
+  if (x) {
+    return sizeof(GeographicLib::LocalCartesian);
+  } else {
+    return 0;
+  }
+}
+
+static const rb_data_type_t geographiclib_local_cartesian_type = {
+  "geographiclib_local_cartesian",
+  {
+    0,
+    geographiclib_local_cartesian_free,
+    geographiclib_local_cartesian_size
+  },
+  0,
+  0,
+  RUBY_TYPED_FREE_IMMEDIATELY
+};
+
+static VALUE geographiclib_local_cartesian_alloc(VALUE klass)
+{
+  return TypedData_Wrap_Struct(klass, &geographiclib_local_cartesian_type, 0);
+}
+
+static GeographicLib::LocalCartesian *geographiclib_local_cartesian_get(VALUE v)
+{
+  GeographicLib::LocalCartesian *x;
+  TypedData_Get_Struct(v, GeographicLib::LocalCartesian, &geographiclib_local_cartesian_type, x);
+  if (x) {
+    return x;
+  } else {
+    rb_raise(rb_eRuntimeError, "Object not initialized.");
+  }
+}
+
+static VALUE geographiclib_local_cartesian_initialize(int argc, VALUE *argv, VALUE self)
+{
+  GeographicLib::Math::real lat = 0.0, lon = 0.0, h = 0.0;
+  switch (argc) {
+  default:
+    rb_raise(rb_eArgError, "Wrong number of arguments. Expecting 0, 1, 2 or 3.");
+  case 3:
+    h = rb_num2dbl(argv[2]);
+  case 2:
+    decode_lat_lon(argv[0], argv[1], lat, lon);
+  case 0:
+    break;
+  case 1:
+    rb_check_type(argv[0], T_HASH);
+    decode_lat_lon(rb_hash_lookup(argv[0], rb_symbol("lat")), rb_hash_lookup(argv[0], rb_symbol("lon")), lat, lon);
+    VALUE vh = rb_hash_lookup(argv[0], rb_symbol("h"));
+    if (vh != Qnil) {
+      h = rb_num2dbl(vh);
+    }
+    break;
+  }
+  geographiclib_local_cartesian_free(DATA_PTR(self));
+  DATA_PTR(self) = new GeographicLib::LocalCartesian(lat, lon, h);
+  return self;
+}
+
+static VALUE geographiclib_local_cartesian_forward(int argc, VALUE *argv, VALUE self)
+{
+  GeographicLib::Math::real lat = 0.0, lon = 0.0, h = 0.0, x, y, z;
+  switch (argc) {
+  default:
+    rb_raise(rb_eArgError, "Wrong number of arguments. Expecting 1, 2 or 3.");
+  case 3:
+    h = rb_num2dbl(argv[2]);
+  case 2:
+    decode_lat_lon(argv[0], argv[1], lat, lon);
+    break;
+  case 1:
+    rb_check_type(argv[0], T_HASH);
+    decode_lat_lon(rb_hash_lookup(argv[0], rb_symbol("lat")), rb_hash_lookup(argv[0], rb_symbol("lon")), lat, lon);
+    VALUE vh = rb_hash_lookup(argv[0], rb_symbol("h"));
+    if (vh != Qnil) {
+      h = rb_num2dbl(vh);
+    }
+    break;
+  }
+  GeographicLib::LocalCartesian *lc = geographiclib_local_cartesian_get(self);
+  lc->Forward(lat, lon, h, x, y, z);
+  VALUE r = rb_hash_new();
+  rb_hash_aset(r, rb_symbol("x"), rb_float_new(x));
+  rb_hash_aset(r, rb_symbol("y"), rb_float_new(y));
+  rb_hash_aset(r, rb_symbol("z"), rb_float_new(z));
+  return r;
+}
+
+static VALUE geographiclib_local_cartesian_reverse(int argc, VALUE *argv, VALUE self)
+{
+  GeographicLib::Math::real lat, lon, h, x, y, z = 0.0;
+  switch (argc) {
+  default:
+    rb_raise(rb_eArgError, "Wrong number of arguments. Expecting 1 or 3.");
+  case 3:
+    x = rb_num2dbl(argv[0]);
+    y = rb_num2dbl(argv[1]);
+    z = rb_num2dbl(argv[2]);
+    break;
+  case 1:
+    rb_check_type(argv[0], T_HASH);
+    x = rb_num2dbl(rb_hash_lookup(argv[0], rb_symbol("x")));
+    y = rb_num2dbl(rb_hash_lookup(argv[0], rb_symbol("y")));
+    z = rb_num2dbl(rb_hash_lookup(argv[0], rb_symbol("z")));
+    break;
+  }
+  GeographicLib::LocalCartesian *lc = geographiclib_local_cartesian_get(self);
+  lc->Reverse(x, y, z, lat, lon, h);
+  VALUE r = rb_hash_new();
+  rb_hash_aset(r, rb_symbol("lat"), rb_float_new(lat));
+  rb_hash_aset(r, rb_symbol("lon"), rb_float_new(lon));
+  rb_hash_aset(r, rb_symbol("h"), rb_float_new(h));
   return r;
 }
 
 extern "C" void Init_geographiclib(void)
 {
   VALUE geographiclib = rb_define_module("GeographicLib");
+
   VALUE constants = rb_define_module_under(geographiclib, "Constants");
-  rb_define_const(constants, "WGS84_a", DBL2NUM(GeographicLib::Constants::WGS84_a()));
-  rb_define_const(constants, "WGS84_f", DBL2NUM(GeographicLib::Constants::WGS84_f()));
+  rb_define_const(constants, "WGS84_a", rb_float_new(GeographicLib::Constants::WGS84_a()));
+  rb_define_const(constants, "WGS84_f", rb_float_new(GeographicLib::Constants::WGS84_f()));
+
   VALUE geodesic = rb_define_class_under(geographiclib, "Geodesic", rb_cObject);
-  rb_define_singleton_method(geodesic, "direct", (VALUE (*)(...)) geographiclib_geodesic_direct, 7);
-  rb_define_singleton_method(geodesic, "inverse", (VALUE (*)(...)) geographiclib_geodesic_inverse, 6);
+  rb_define_singleton_method(geodesic, "direct",
+    (VALUE (*)(...)) geographiclib_geodesic_direct, 7);
+  rb_define_singleton_method(geodesic, "inverse",
+    (VALUE (*)(...)) geographiclib_geodesic_inverse, 6);
+
+  VALUE dms = rb_define_module_under(geographiclib, "DMS");
+  rb_define_module_function(dms, "decode",
+    (VALUE (*)(...)) geographiclib_dms_decode, 1);
+  rb_define_module_function(dms, "decode_lat_lon",
+    (VALUE (*)(...)) geographiclib_dms_decode_lat_lon, 2);
+  rb_define_module_function(dms, "decode_azi",
+    (VALUE (*)(...)) geographiclib_dms_decode_azi, 1);
+
+  VALUE local_cartesian = rb_define_class_under(geographiclib, "LocalCartesian", rb_cObject);
+  rb_define_alloc_func(local_cartesian, geographiclib_local_cartesian_alloc);
+  rb_define_method(local_cartesian, "initialize",
+    (VALUE (*)(...)) geographiclib_local_cartesian_initialize, -1);
+  rb_define_method(local_cartesian, "forward",
+    (VALUE (*)(...)) geographiclib_local_cartesian_forward, -1);
+  rb_define_method(local_cartesian, "reverse",
+    (VALUE (*)(...)) geographiclib_local_cartesian_reverse, -1);
 }

data/lib/geographiclib.rb

@@ -2,19 +2,26 @@ require 'geographiclib/geographiclib'
 
 module GeographicLib
   class Geodesic
+    attr_accessor :a, :f
+
+    # Creates an ellipsoid with semi-major-axis a and flattening f.
     def initialize a, f
       @a = a
       @f = f
     end
 
+    # Calculates the direct geodesic problem given a point, an azimuth and a distance.
+    # If arcmode is false, the distance is in meters, otherwise it is an angle.
     def direct lat1, lon1, azi1, arcmode, s12_a12
       Geodesic.direct @a, @f, lat1, lon1, azi1, !!arcmode, s12_a12
     end
 
+    # Calculates the inverse geodesic problem given two points.
     def inverse lat1, lon1, lat2, lon2
       Geodesic.inverse @a, @f, lat1, lon1, lat2, lon2
     end
 
-    WGS84 = Geodesic.new Constants::WGS84_a, Constants::WGS84_f
+    # An instance of Geodesic initialized with the parameters for the WGS84 ellipsoid.
+    WGS84 = Geodesic.new(Constants::WGS84_a, Constants::WGS84_f).freeze
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: geographiclib
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Charles Karney <charles@karney.com>
@@ -19,7 +19,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-28 00:00:00.000000000 Z
+date: 2016-05-27 00:00:00.000000000 Z
 dependencies: []
 description: A wrapper for GeograpicLib.
 email: "—"