librtree 1.0.5 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b945bd1abd981557382119ef56ebde1c6bd1f3e75dfa0ca4656b43a59c99d833
-  data.tar.gz: 9af9d2d1317582970d0b27fd43c2947472d66be2383f29bdb7f3d8d19743a897
+  metadata.gz: 1d23f82b41d0757dbca1d30fc447bd2573db6d1584727c3244c84bbae0bc6b83
+  data.tar.gz: 36b7cda50a05140949537890a4ab99ebc555f08d7f7789cd7d4d0bd14c7b4c27
 SHA512:
-  metadata.gz: 752765087a236c6ae456475af539ffafb72f02ba13521ff75c094e997c367b717f6d3166e97146a9bc45f2b58581ec6b292aea1faaababf18e6f57d2b8cbc705
-  data.tar.gz: 6aa633e4d38ca15f6a4dc6392870cb0ec8d3713bb15b53a9142b06a00a8e7d295eb5a5f57494eb72cdfdf2b9f8098b86e4703f310a9b3382b39d47df971f29d0
+  metadata.gz: 5ad5636536266f5ac027bd9f7ee59b359f4a3b00c07107057c7b83d378122be21343ebb54db36fe0e7683c926e674a7c8e4f3a6013b4a38c3019078851995c38
+  data.tar.gz: 22292e552cd05823802107094df3ff12c0a0a04129e26dd0fe8a9dd1c1b966f47b1b1cf4a1ac046f0965710965235c5e3a195c4de87b5612aa968e042a3c38fb

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Changelog
 ---------
 
+### 1.0.6, 07-04-2024
+
+- Update to librtree 1.3.0
+- Adds `#envelope` `#csv_write`, `#to_csv`
+
 ### 1.0.5, 16-01-2024
 
 - All methods which take a `File` object (i.e., a stream), now

data/ext/rtree/lib/csv.c

@@ -81,3 +81,78 @@ rtree_t* csv_rtree_read(FILE *stream, size_t dims, state_flags_t flags)
 
   return NULL;
 }
+
+static int write_node(const state_t*, const node_t*, FILE *);
+
+static int write_internal_branch(const state_t *state,
+                                 const branch_t *branch,
+                                 void *arg)
+{
+  return write_node(state, branch_get_child(branch), arg);
+}
+
+#if SIZEOF_RTREE_COORD_T == 4
+#define PRECISION 6
+#elif SIZEOF_RTREE_COORD_T == 8
+#define PRECISION 14
+#else
+#error "strange size for rtree_coord_t"
+#endif
+
+static int write_leaf_branch(const state_t *state,
+                             const branch_t *branch,
+                             void *arg)
+{
+  FILE *stream = arg;
+  rtree_id_t id = branch_get_id(branch);
+
+  fprintf(stream, "%li", (long int)id);
+
+  const rtree_coord_t *rect = branch_get_rect(branch);
+  size_t n = state_dims(state);
+
+  for (size_t i = 0 ; i < 2 * n ; i++)
+    fprintf(stream, ",%.*e", PRECISION, (double)rect[i]);
+
+  fprintf(stream, "\r\n");
+
+  return RTREE_OK;
+}
+
+#undef PRECISION
+
+static int write_internal_node(const state_t *state,
+                               const node_t *node,
+                               FILE *stream)
+{
+  return node_branch_each(state, node, write_internal_branch, stream);
+}
+
+static int write_leaf_node(const state_t *state,
+                           const node_t *node,
+                           FILE *stream)
+{
+  return node_branch_each(state, node, write_leaf_branch, stream);
+}
+
+static int write_node(const state_t *state,
+                      const node_t *node,
+                      FILE *stream)
+{
+  int err;
+
+  if (node_level(node) > 0)
+    err = write_internal_node(state, node, stream);
+  else
+    err = write_leaf_node(state, node, stream);
+
+  return err;
+}
+
+int csv_rtree_write(const rtree_t *rtree, FILE *stream)
+{
+  if ((rtree == NULL) || (stream == NULL))
+    return RTREE_ERR_INVAL;
+
+  return write_node(rtree->state, rtree->root, stream);
+}

data/ext/rtree/lib/private/csv.h

@@ -11,6 +11,7 @@
 
 #include <stdio.h>
 
+int csv_rtree_write(const rtree_t*, FILE*);
 rtree_t* csv_rtree_read(FILE*, size_t, state_flags_t);
 
 #endif

data/ext/rtree/lib/rtree-base.c

@@ -104,9 +104,9 @@ void rtree_destroy(rtree_t *rtree)
   free(rtree);
 }
 
-rtree_height_t rtree_height(const rtree_t *rtree)
+int rtree_csv_write(const rtree_t *rtree, FILE *stream)
 {
-  return node_height(rtree->state, rtree->root);
+  return csv_rtree_write(rtree, stream);
 }
 
 rtree_t* rtree_csv_read(FILE *stream, size_t dim, state_flags_t flags)
@@ -182,6 +182,11 @@ const char* rtree_strerror(int err)
   return strerror_rtree(err);
 }
 
+rtree_height_t rtree_height(const rtree_t *rtree)
+{
+  return node_height(rtree->state, rtree->root);
+}
+
 size_t rtree_bytes(const rtree_t *rtree)
 {
   if (rtree == NULL)
@@ -255,3 +260,11 @@ bool rtree_empty(const rtree_t *rtree)
     (rtree == NULL) ||
     (! node_nonempty(rtree->state, rtree->root));
 }
+
+int rtree_envelope(const rtree_t *rtree, rtree_coord_t *rect)
+{
+  if (rtree_empty(rtree))
+    return 1;
+  else
+    return node_envelope(rtree->state, rtree->root, rect);
+}

data/ext/rtree/lib/rtree.h

@@ -34,6 +34,7 @@ int rtree_search(const rtree_t*, const rtree_coord_t*, rtree_search_t*, void*);
 int rtree_add_rect(rtree_t*, rtree_id_t, rtree_coord_t*);
 int rtree_update(rtree_t*, rtree_update_t*, void*);
 bool rtree_identical(const rtree_t*, const rtree_t*);
+int rtree_csv_write(const rtree_t*, FILE*);
 rtree_t* rtree_csv_read(FILE*, size_t, state_flags_t);
 int rtree_json_write(const rtree_t*, FILE*);
 rtree_t* rtree_json_read(FILE*);
@@ -50,6 +51,7 @@ size_t rtree_branch_size(const rtree_t*);
 size_t rtree_branching_factor(const rtree_t*);
 double rtree_unit_sphere_volume(const rtree_t*);
 bool rtree_empty(const rtree_t*);
+int rtree_envelope(const rtree_t*, rtree_coord_t*);
 
 #ifdef __cplusplus
 }

data/ext/rtree/rtree.c

@@ -281,14 +281,19 @@ static VALUE serialise(VALUE self, VALUE io_obj, serialise_t *f)
   return self;
 }
 
-static VALUE rt_json_write(VALUE self, VALUE io_obj)
+static VALUE rt_bsrt_write(VALUE self, VALUE io_obj)
 {
-  return serialise(self, io_obj, rtree_json_write);
+  return serialise(self, io_obj, rtree_bsrt_write);
 }
 
-static VALUE rt_bsrt_write(VALUE self, VALUE io_obj)
+static VALUE rt_csv_write(VALUE self, VALUE io_obj)
 {
-  return serialise(self, io_obj, rtree_bsrt_write);
+  return serialise(self, io_obj, rtree_csv_write);
+}
+
+static VALUE rt_json_write(VALUE self, VALUE io_obj)
+{
+  return serialise(self, io_obj, rtree_json_write);
 }
 
 static VALUE rt_identical(VALUE self, VALUE other)
@@ -373,6 +378,28 @@ static VALUE rt_size(VALUE self)
   return INT2NUM(rtree_bytes(rtree));
 }
 
+static VALUE rt_envelope(VALUE self)
+{
+  rtree_t *rtree;
+  TypedData_Get_Struct(self, rtree_t, &rtree_type, rtree);
+
+  if (rtree_empty(rtree))
+    return Qnil;
+
+  size_t n = 2 * rtree_dims(rtree);
+  double u[n];
+
+  if (rtree_envelope(rtree, u) != 0)
+    rb_sys_fail(__func__);
+
+  VALUE v = rb_ary_new_capa(n);
+
+  for (size_t i = 0 ; i < n ; i++)
+    rb_ary_store(v, i, DBL2NUM(u[i]));
+
+  return v;
+}
+
 static VALUE rt_version(VALUE self)
 {
   return rb_str_new_cstr(rtree_package_version);
@@ -518,11 +545,13 @@ void Init_rtree(void)
   rb_define_method(cRTreeBase, "height", rt_height, 0);
   rb_define_method(cRTreeBase, "add_rect", rt_add_rect, 2);
   rb_define_method(cRTreeBase, "search", rt_search, 1);
-  rb_define_method(cRTreeBase, "json_write", rt_json_write, 1);
   rb_define_method(cRTreeBase, "bsrt_write", rt_bsrt_write, 1);
+  rb_define_method(cRTreeBase, "csv_write", rt_csv_write, 1);
+  rb_define_method(cRTreeBase, "json_write", rt_json_write, 1);
   rb_define_method(cRTreeBase, "eq?", rt_identical, 1);
   rb_define_method(cRTreeBase, "dim", rt_dim, 0);
   rb_define_method(cRTreeBase, "size", rt_size, 0);
+  rb_define_method(cRTreeBase, "envelope", rt_envelope, 0);
   rb_define_method(cRTreeBase, "page_size", rt_page_size, 0);
   rb_define_method(cRTreeBase, "node_size", rt_node_size, 0);
   rb_define_method(cRTreeBase, "rect_size", rt_rect_size, 0);

data/lib/rtree.rb

@@ -386,36 +386,40 @@ class RTree < RTreeBase
     super
   end
 
-  # Serialise to JSON
+  # Serialise to BSRT (binary serialised R-tree)
   # @param io_arg [String|IO] a path or writable stream
   # @return [self]
-  # @see .json_read
+  # @see .bsrt_read
   # @example Write to file
-  #   rtree.json_write('rtree.json')
+  #   rtree.bsrt_write('rtree.bsrt')
   #
-  def json_write(io_arg)
-    RTree::IOUtil.io_with_mode(io_arg, 'w') { |io| super(io) }
+  def bsrt_write(io_arg)
+    RTree::IOUtil.io_with_mode(io_arg, 'wb') { |io| super(io) }
     self
   end
 
-  # Serialise to BSRT (binary serialised R-tree)
+  # Serialise to CSV
   # @param io_arg [String|IO] a path or writable stream
   # @return [self]
-  # @see .bsrt_read
+  # @see .csv_read
   # @example Write to file
-  #   rtree.bsrt_write('rtree.bsrt')
+  #   rtree.csv_write('rtree.csv')
   #
-  def bsrt_write(io_arg)
+  def csv_write(io_arg)
     RTree::IOUtil.io_with_mode(io_arg, 'wb') { |io| super(io) }
     self
   end
 
-  # Serialise to JSON string
-  # @return [String] the UTF-8 encoded JSON
-  # @see .from_json
+  # Serialise to JSON
+  # @param io_arg [String|IO] a path or writable stream
+  # @return [self]
+  # @see .json_read
+  # @example Write to file
+  #   rtree.json_write('rtree.json')
   #
-  def to_json
-    serialise(Encoding::UTF_8) { |io| json_write(io) }
+  def json_write(io_arg)
+    RTree::IOUtil.io_with_mode(io_arg, 'w') { |io| super(io) }
+    self
   end
 
   # Serialise to BSRT string
@@ -426,6 +430,22 @@ class RTree < RTreeBase
     serialise(Encoding::BINARY) { |io| bsrt_write(io) }
   end
 
+  # Serialise to CSV string
+  # @return [String] the CSV
+  # @see .from_csv
+  #
+  def to_csv
+    serialise(Encoding::BINARY) { |io| csv_write(io) }
+  end
+
+  # Serialise to JSON string
+  # @return [String] the UTF-8 encoded JSON
+  # @see .from_json
+  #
+  def to_json
+    serialise(Encoding::UTF_8) { |io| json_write(io) }
+  end
+
   # The RTree structure in hash form
   # @return [Hash]
   #
@@ -462,6 +482,15 @@ class RTree < RTreeBase
     super
   end
 
+  # @return [Array[float]] the bounding rectangle
+  # @note Ruturns the bounding rectangle (in the same format
+  #   as the rectangle input) for all rectangles in the tree.
+  #   In the case that the input is empty, returns nil.
+  #
+  def envelope
+    super
+  end
+
   # @return [Integer] the bytes in a page of memory
   #
   def page_size

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: librtree
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.6
 platform: ruby
 authors:
 - J.J. Green
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-01-16 00:00:00.000000000 Z
+date: 2024-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler