librtree 1.0.4 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b253861945be28133a07d5041b080939164dc3725a4b5b458319899d1ad9b66
-  data.tar.gz: 56704611278f67678693ce56e4cec85ae436ba41d534803e0fb8694c39d5b45b
+  metadata.gz: 1d23f82b41d0757dbca1d30fc447bd2573db6d1584727c3244c84bbae0bc6b83
+  data.tar.gz: 36b7cda50a05140949537890a4ab99ebc555f08d7f7789cd7d4d0bd14c7b4c27
 SHA512:
-  metadata.gz: 904eacdcbbe518f91ccc41d2c03da9191591a0af6e17be87874be1d74525707a10815e68ed0c9c3dacf91afe70384f982723487f3b6434241ec51097745f0f3e
-  data.tar.gz: 8be9c36a56b92d1bea25a2ef352cb1e3062b1d197983c92cd11d0f753451573b454b3af22327c05fa300d52f3036561555bd1464faa79ea304d87811ddd4acd2
+  metadata.gz: 5ad5636536266f5ac027bd9f7ee59b359f4a3b00c07107057c7b83d378122be21343ebb54db36fe0e7683c926e674a7c8e4f3a6013b4a38c3019078851995c38
+  data.tar.gz: 22292e552cd05823802107094df3ff12c0a0a04129e26dd0fe8a9dd1c1b966f47b1b1cf4a1ac046f0965710965235c5e3a195c4de87b5612aa968e042a3c38fb

data/CHANGELOG.md

@@ -1,6 +1,16 @@
 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
+  also accept a `String` or `Pathname` to the file instead.
+
 ### 1.0.4, 30-10-2023
 
 - Check for `__builtin_ctzl` (and use if found)

data/ext/rtree/lib/bindex.c

@@ -20,6 +20,22 @@
 #define UL_BYTES sizeof(unsigned long)
 #define UL_BITS (UL_BYTES << 3)
 
+/*
+  config.h may contain HAVE___BUILTIN_CTZL defined from an autoconf
+  check (for the standalone C library, there will be such a check),
+  but in the embedded case, performing that check may be tricky, so
+  in that case we fall-back onto the __has_builtin macro which has
+  been present in clang for many years, and in gcc since version 10.
+*/
+
+#ifndef HAVE___BUILTIN_CTZL
+#ifdef __has_builtin
+#if __has_builtin(__builtin_ctzl)
+#define HAVE___BUILTIN_CTZL 1
+#endif
+#endif
+#endif
+
 /* see note on branch_sizeof in branch.c */
 
 static size_t bindex_sizeof(size_t n)

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/error.c

@@ -23,7 +23,7 @@ const char* strerror_rtree(int err)
         { RTREE_ERR_NOCSV, "Compiled without CSV support" },
         { RTREE_ERR_JANSSON, "Error from the Jansson library" },
         { RTREE_ERR_NOJSON, "Compiled without JSON support" },
-        { RTREE_ERR_NOJSON, "Compiled without BSRT support" },
+        { RTREE_ERR_NOBSRT, "Compiled without BSRT support" },
         { RTREE_ERR_GETBRANCH, "Error getting branch" },
         { RTREE_ERR_GETCHILD, "Error getting child node" },
         { RTREE_ERR_NODECLONE, "Error cloning node" },

data/ext/rtree/lib/mk/Hdr.mk

@@ -1,3 +1,9 @@
-HDR := rtree/branch.h rtree/error.h rtree/extent.h rtree/node.h \
-	rtree/package.h rtree/postscript.h rtree/rectf.h rtree/search.h \
-	rtree/state.h rtree/types.h rtree.h
+HDR := rtree.h \
+	rtree/error.h \
+	rtree/extent.h \
+	rtree/node.h \
+	rtree/package.h \
+	rtree/postscript.h \
+	rtree/search.h \
+	rtree/state.h \
+	rtree/types.h

data/ext/rtree/lib/package.c

@@ -5,7 +5,7 @@
 
 #include "rtree/package.h"
 
-const char rtree_package_version[] = "1.3.0";
+const char rtree_package_version[] = "1.3.1";
 const char rtree_package_name[] = "librtree";
 const char rtree_package_url[] = "https://gitlab.com/jjg/librtree";
 const char rtree_package_bugreport[] = "j.j.green@gmx.co.uk";

data/ext/rtree/lib/postscript.c

@@ -13,6 +13,7 @@
 #include <time.h>
 #include <errno.h>
 #include <stdbool.h>
+#include <stdlib.h>
 
 #ifdef HAVE_TGMATH_H
 #include <tgmath.h>

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

@@ -35,7 +35,7 @@ static VALUE rt_init(VALUE self, VALUE dim_obj, VALUE flags_obj)
   Check_Type(dim_obj, T_FIXNUM);
   size_t dim = FIX2ULONG(dim_obj);
 
-  Check_Type(dim_obj, T_FIXNUM);
+  Check_Type(flags_obj, T_FIXNUM);
   state_flags_t flags = FIX2UINT(flags_obj);
 
   rtree_t *rtree;
@@ -241,7 +241,7 @@ static VALUE rt_csv_read(VALUE cls,
   Check_Type(dim_obj, T_FIXNUM);
   size_t dim = FIX2ULONG(dim_obj);
 
-  Check_Type(dim_obj, T_FIXNUM);
+  Check_Type(flags_obj, T_FIXNUM);
   state_flags_t flags = FIX2UINT(flags_obj);
 
   rtree_t *rtree;
@@ -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);
@@ -415,14 +442,13 @@ static VALUE rt_postscript(VALUE self,
   Check_Type(axis_obj, T_FIXNUM);
   extent_axis_t axis = FIX2UINT(axis_obj);
 
-  rtree_postscript_t opt =
-    {
-     .style = style,
-     .axis = axis,
-     .extent = extent,
-     .margin = margin,
-     .title = "librtree-ruby output"
-    };
+  rtree_postscript_t opt = {
+    .style = style,
+    .axis = axis,
+    .extent = extent,
+    .margin = margin,
+    .title = "librtree-ruby output"
+  };
 
   int err;
   if ((err = rtree_postscript(rtree, &opt, fp)) != 0)
@@ -519,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

@@ -15,7 +15,7 @@ require 'fcntl'
 # @author RTree J. J. Green
 #
 # A Ruby native extension implementing the R-tree spatial index of
-# Guttman-Green.  The code is an emebded version of
+# Guttman-Green.  The code is an embedded version of
 # {http://soliton.vm.bytemark.co.uk/pub/jjg/en/code/librtree librtree}.
 #
 # Use
@@ -69,6 +69,21 @@ class RTree < RTreeBase
   module IOUtil
     extend self
 
+    # @!visibility private
+    #
+    def io_with_mode(arg, mode)
+      case arg
+      when String, Pathname
+        File.open(arg, mode) do |io|
+          yield io
+        end
+      when File, IO
+        yield arg
+      else
+        raise TypeError, arg
+      end
+    end
+
     # @!visibility private
     #
     def deserialise(string, encoding)
@@ -138,15 +153,19 @@ class RTree < RTreeBase
 
   class << self
 
-    # Create a new RTree instance from JSON stream
-    # @param io [IO] a readable stream object
+    # Create a new RTree instance from JSON path or stream
+    # @param io_arg [String|IO] a path or readable stream
     # @return [RTree] the newly instantiated RTree
     # @see #json_write
-    # @example Read from file
+    # @example Using a path
+    #   rtree = RTree.json_read('rtree.json')
+    # @example Using a stream
     #   rtree = File.open('rtree.json', 'r') { |io| RTree.json_read(io) }
     #
-    def json_read(io)
-      super
+    def json_read(io_arg)
+      RTree::IOUtil.io_with_mode(io_arg, 'r') do |io|
+        super(io)
+      end
     end
 
     # Create a new RTree instance from JSON string
@@ -159,15 +178,17 @@ class RTree < RTreeBase
     end
 
     # Create a new RTree instance from BSRT (binary serialised R-tree)
-    # stream
-    # @param io [IO] a readable stream object
+    # path or stream
+    # @param io_arg [String|IO] a path or readable stream
     # @return [RTree] the newly instantiated RTree
     # @see #bsrt_write
-    # @example Read from file
-    #   rtree = File.open('rtree.bsrt', 'r') { |io| RTree.bsrt_read(io) }
+    # @example Read from path
+    #   rtree = RTree.bsrt_read('rtree.bsrt')
     #
-    def bsrt_read(io)
-      super
+    def bsrt_read(io_arg)
+      RTree::IOUtil.io_with_mode(io_arg, 'rb') do |io|
+        super(io)
+      end
     end
 
     # Create a new RTree instance from BSRT (binary serialised R-tree)
@@ -180,8 +201,8 @@ class RTree < RTreeBase
       deserialise(bsrt, Encoding::BINARY) { |io| bsrt_read(io) }
     end
 
-    # Build a new RTree instance from CSV stream
-    # @param io [IO] a readable stream object
+    # Build a new RTree instance from CSV path or stream
+    # @param io_arg [String|IO] a path or readable stream
     # @param dim [Integer] the dimension of the tree
     # @param split [:linear, :quadratic, :greene] See {#initialize}
     # @param node_page [Integer] See {#initialize}
@@ -192,9 +213,11 @@ class RTree < RTreeBase
     #   useful feature is the reason that the dimension is a required
     #   argument).
     #
-    def csv_read(io, dim, split: :quadratic, node_page: 0)
+    def csv_read(io_arg, dim, split: :quadratic, node_page: 0)
       flags = split_flag(split) | node_page_flag(node_page)
-      super(io, dim, flags)
+       RTree::IOUtil.io_with_mode(io_arg, 'r') do |io|
+         super(io, dim, flags)
+      end
     end
 
     # Build a new RTree instance from CSV string
@@ -363,34 +386,40 @@ class RTree < RTreeBase
     super
   end
 
-  # Serialise to JSON stream
-  # @param io [IO] a writable stream
+  # 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
-  #   File.open('rtree.json', 'w') { |io| rtree.json_write(io) }
+  #   rtree.bsrt_write('rtree.bsrt')
   #
-  def json_write(io)
-    super
+  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) stream
-  # @param io [IO] a writable stream
+  # 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
-  #   File.open('rtree.bsrt', 'w') { |io| rtree.bsrt_write(io) }
+  #   rtree.csv_write('rtree.csv')
   #
-  def bsrt_write(io)
-    super
+  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
@@ -401,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]
   #
@@ -437,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
@@ -476,7 +530,7 @@ class RTree < RTreeBase
 
   # Create a PostScript plot of the RTree
   #
-  # @param io [IO] a writeable stream object
+  # @param io_arg [String|IO] a path or writeable stream
   # @param style [RTree::Style] a style object describing the fill
   #   colour and stroke width and colour for each level of the tree.
   # @param height [Float] the height of the plot in units of PostScript
@@ -487,7 +541,7 @@ class RTree < RTreeBase
   # @param margin [Float] extra space around the plot in units of
   #   PostScript point (1/72 inch), default zero
   #
-  def postscript(io, style, height: nil, width: nil, margin: 0)
+  def postscript(io_arg, style, height: nil, width: nil, margin: 0)
     if height && width then
       raise ArgumentError, 'cannot specify both height and width'
     end
@@ -498,7 +552,9 @@ class RTree < RTreeBase
       axis = AXIS_WIDTH
       extent = width || 216
     end
-    super(style, axis, extent, margin, io)
+    RTree::IOUtil.io_with_mode(io_arg, 'w') do |io|
+      super(style, axis, extent, margin, io)
+    end
   end
 
   private
@@ -523,7 +579,7 @@ class RTree < RTreeBase
 
 end
 
-# @author RTree::Style J. J. Green
+# @author RTree::Style J.J. Green
 #
 # A Ruby wrapper around RTree styles, used in PostScript plotting.
 # in particular by {RTree#postscript}.
@@ -532,16 +588,14 @@ class RTree::Style < RTreeStyleBase
 
   class << self
 
-    # Create a new Style instance from JSON stream
-    # @param io [IO] a readable stream object
+    # Create a new Style instance from JSON path or stream
+    # @param io_arg [String|IO] a path or readable stream
     # @return [RTree::Style] the newly instantiated Style
     # @example Read from file
-    #   style = File.open('some.style', 'r') do |io|
-    #     RTree::Style.json_read(io)
-    #   end
+    #   style = RTree::Style.json_read('some.style')
     #
-    def json_read(io)
-      super
+    def json_read(io_arg)
+      RTree::IOUtil.io_with_mode(io_arg, 'r') { |io| super(io) }
     end
 
     # Create a new Style instance from JSON string

metadata

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