quadtree 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d5db2d5026956693fb12005b6f413baec2df1c55336d54612c69c2d2ea5daee7
-  data.tar.gz: 64fad915c832732dce1b3d8f5d4e09153d6c2a5d0eacbe341ae9e36432ae910f
+  metadata.gz: e77411d8a1691d1187b9fe70bd783838b2b29c9f462445c7c00535a97f1f1647
+  data.tar.gz: 46b84bb36f80750c9f20688532860e54bf573ba1d2f72a5687d093a8f17384bc
 SHA512:
-  metadata.gz: ba095f44c64f53fe6c708a55e59b2da9e43f4317c309fb8677ca24d0e9538c6104eec212c3ce05e092b17816a0b226e2a114ee86b16b5ce92cfc1a8dd582a681
-  data.tar.gz: 3d2ea5d459b276877dae1e42300f5b457c88b557cd88dc3240c4f6864cb430c0044c5ee27ceac0d0d6b1b2a1ee573f627548d12373a66eb4760f0b9c09f91712
+  metadata.gz: 6411caa3b61a5b9c3f2e5ca06c15301334957d3ccfb42fb7d7b0eabc22f1edf1e0e4f60a108265ee647af9084c6645c87e0b89c11cd8194964f8aed2857eebf0
+  data.tar.gz: 2eba1b1e00508e045030ebda1dc2d49f691fa73c674e4f736f8d0d69e0189cfd1eee079797822c6c2d3c3913a29bb5c0f34d76194de21c26f591660e3064ec68

data/README.md

@@ -1,5 +1,7 @@
 # Quadtree
 
+[![Gem Version](https://badge.fury.io/rb/quadtree.svg)](https://badge.fury.io/rb/quadtree)
+
 Quadtrees in Ruby. For searching spatially related nodes in some space, you know.
 
 ## Installation

data/bitbucket-pipelines.yml

@@ -1,5 +1,3 @@
-# This is a sample build configuration for Ruby.
-# Check our guides at https://confluence.atlassian.com/x/8r-5Mw for more examples.
 image: ruby:2.4.0
 
 pipelines:
@@ -9,8 +7,10 @@ pipelines:
         caches:
           - bundler
         script:
-          - bundle install
+          - bundle install --path ./vendor
+          - bundle exec rake build
           - bundle exec rake spec
+          - bundle exec rake yard
 
 definitions:
   caches:

data/lib/quadtree/axis_aligned_bounding_box.rb

@@ -2,72 +2,98 @@ module Quadtree
   # Axis-aligned bounding box with half dimension and center.
   class AxisAlignedBoundingBox
 
-    # @return [Point]
+    # Center {Point} of this instance.
+    #
+    # @return [Point] the {Point} marking the center of this instance.
     attr_accessor :center
-    # @return [Float]
+
+    # Half dimension of this instance (distance from the center {Point} to the
+    # edge).
+    #
+    # @return [Float] distance from the center {Point} to the edge.
     attr_accessor :half_dimension
 
-    # @param [Point] center
-    # @param [Float] half_dimension
+    # @param center [Point]
+    # @param half_dimension [Float]
     def initialize(center, half_dimension)
       @center = center
       @half_dimension = half_dimension.to_f
     end
 
-    # @param [Point] point
-    # @return [Boolean]
+    # Check if this instance contains a given {Point}.
+    #
+    # @param point [Point] the {Point} to check for.
+    # @return [Boolean] +true+ if given {Point} is contained, +false+
+    #   otherwise.
     def contains_point?(point)
-      if point.x >= self.center.x - self.half_dimension and point.x <= self.center.x + self.half_dimension
-        if point.y >= self.center.y - self.half_dimension and point.y <= self.center.y + self.half_dimension
+      if point.x >= self.center.x - self.half_dimension &&
+          point.x <= self.center.x + self.half_dimension
+        if point.y >= self.center.y - self.half_dimension &&
+          point.y <= self.center.y + self.half_dimension
           return true
         end
       end
       false
     end
 
-    # @param [AxisAlignedBoundingBox] other
-    # @return [Boolean]
+    # Check if this instance intersects with another instance.
+    #
+    # @param other [AxisAlignedBoundingBox] the other instance to check for.
+    # @return [Boolean] +true+ if these intersects, +false+ otherwise.
     def intersects?(other)
       other_lt_corner = Point.new(other.left, other.top)
       other_rt_corner = Point.new(other.right, other.top)
       other_lb_corner = Point.new(other.left, other.bottom)
       other_rb_corner = Point.new(other.right, other.bottom)
 
-      [other_lt_corner, other_rt_corner, other_lb_corner, other_rb_corner].each do |corner|
+      [
+        other_lt_corner,
+        other_rt_corner,
+        other_lb_corner,
+        other_rb_corner
+      ].each do |corner|
         return true if self.contains_point?(corner)
       end
       false
     end
 
-    # @return [Float]
+    # Get the X coordinate of the left edge of this instance.
+    #
+    # @return [Float] the X coordinate of the left edge of this instance.
     def left
       @center.x - @half_dimension
     end
 
-    # @return [Float]
+    # Get the X coordinate of the right edge of this instance.
+    #
+    # @return [Float] the X coordinate of the right edge of this instance.
     def right
       @center.x + @half_dimension
     end
 
-    # Get the Y coordinate of the top edge of this AABB.
+    # Get the Y coordinate of the top edge of this instance.
     #
-    # @return [Float] the Y coordinate of the top edge of this AABB.
+    # @return [Float] the Y coordinate of the top edge of this instance.
     def top
       @center.y + @half_dimension
     end
 
-    # Get the Y coordinate of the bottom edge of this AABB.
+    # Get the Y coordinate of the bottom edge of this instance.
     #
-    # @return [Float] the Y coordinate of the bottom edge of this AABB.
+    # @return [Float] the Y coordinate of the bottom edge of this instance.
     def bottom
       @center.y - @half_dimension
     end
 
+    # Get the width of this instance.
+    #
     # @return [Float]
     def width
       span
     end
 
+    # Get the height of this instance.
+    #
     # @return [Float]
     def height
       span

data/lib/quadtree/point.rb

@@ -2,48 +2,52 @@ module Quadtree
     # Simple coordinate object to represent points in some space.
     class Point
 
-      # @return [Float] X coordinate
+      # The X coordinate of this instance.
+      # @return [Float] X coordinate.
       attr_accessor :x
 
-      # @return [Float] Y coordinate
+      # The Y coordinate of this instance.
+      # @return [Float] Y coordinate.
       attr_accessor :y
 
-      # @return [Object] Payload attached to this {Point}.
+      # Optional payload attached to this instance.
+      # @return [Object] payload attached to this instance.
       attr_accessor :data
 
-      # Create a new {Point}.
-      #
-      # @param [Float, Numeric] x X coordinate.
-      # @param [Float, Numeric] y Y coordinate.
-      # @param [Object] data {Point} payload (optional).
+      # @param x [Float, Numeric] X coordinate.
+      # @param y [Float, Numeric] Y coordinate.
+      # @param data [Object] payload payload attached to this instance
+      #   (optional).
       def initialize(x, y, data=nil)
         @x = x.to_f
         @y = y.to_f
         @data = data unless data.nil?
       end
 
-      # This will calculate distance to another, given that they are both
-      # on the same flat two dimensional plane.
+      # This will calculate distance to another {Point}, given that they are
+      # both in the same 2D space.
       #
-      # @param [Point] other the other {Point}.
+      # @param other [Point] the other {Point}.
       # @return [Float] the distance to the other {Point}.
       def distance_to(other)
         Math.sqrt((other.x - self.x) ** 2 + (other.y - self.y) ** 2)
       end
 
-      # This will calculate distance to another point using the Haversine
-      # formula. This means that it will treat #x as longitude and #y as
+      # This will calculate distance to another {Point} using the Haversine
+      # formula. This means that it will treat {#x} as longitude and {#y} as
       # latitude!
       #
       # a = sin²(Δφ/2) + cos φ_1 ⋅ cos φ_2 ⋅ sin²(Δλ/2)
+      #
       # c = 2 ⋅ atan2( √a, √(1−a) )
+      #
       # d = R ⋅ c
       #
       # where φ is latitude, λ is longitude, R is earth’s radius (mean
       # radius = 6 371 km);
       # note that angles need to be in radians to pass to trig functions!
       #
-      # @param [Point] other the other {Point}.
+      # @param other [Point] the other {Point}.
       # @return [Float] the distance, in meters, to the other {Point}.
       def haversine_distance_to(other)
         # earth's radius

data/lib/quadtree/quadtree.rb

@@ -1,10 +1,10 @@
 module Quadtree
-  # A Quadtree
+  # A Quadtree.
   class Quadtree
 
     # Arbitrary constant to indicate how many elements can be stored in this
     # quad tree node.
-    # @return [Integer]
+    # @return [Integer] number of {Point}s this {Quadtree} can hold.
     NODE_CAPACITY = 4
 
     # Axis-aligned bounding box stored as a center with half-dimensions to
@@ -18,15 +18,23 @@ module Quadtree
 
     # Children
 
+    # North west corner of this quad.
     # @return [Quadtree]
     attr_accessor :north_west
+
+    # North east corner of this quad.
     # @return [Quadtree]
     attr_accessor :north_east
+
+    # South west corner of this quad.
     # @return [Quadtree]
     attr_accessor :south_west
+
+    # South east corner of this quad.
     # @return [Quadtree]
     attr_accessor :south_east
 
+    # @param boundary [AxisAlignedBoundingBox] the boundary for this {Quadtree}
     def initialize(boundary)
       self.boundary = boundary
       self.points = []
@@ -36,8 +44,10 @@ module Quadtree
       self.south_east = nil
     end
 
-    # @param [Point] point
-    # @return [Boolean]
+    # Insert a {Point} in this {Quadtree}.
+    #
+    # @param point [Point] the point to insert.
+    # @return [Boolean] +true+ on success, +false+ otherwise.
     def insert!(point)
       return false unless self.boundary.contains_point?(point)
 
@@ -57,7 +67,7 @@ module Quadtree
 
     # Finds all points contained within a range.
     #
-    # @param [AxisAlignedBoundingBox] range the range to search within.
+    # @param range [AxisAlignedBoundingBox] the range to search within.
     # @return [Array<Point>]
     def query_range(range)
       # Prepare an array of results

data/lib/quadtree/version.rb

@@ -1,3 +1,4 @@
 module Quadtree
-  VERSION = "1.0.3"
+  # Current version
+  VERSION = "1.0.4"
 end

data/lib/quadtree.rb

@@ -6,7 +6,6 @@ require "quadtree/quadtree"
 
 # Quadtrees.
 #
-# @since 1.0.0
 # @author Jan Lindblom <janlindblom@fastmail.fm>
 module Quadtree
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quadtree
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - Jan Lindblom
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-26 00:00:00.000000000 Z
+date: 2018-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler