Merge branch 'dev' of https://github.com/OmkarPathak/pygorithms into dev

'Pulled Requests'

Author: OmkarPathak

docs/Geometry.rst

@@ -50,9 +50,11 @@ Features
 
 * Shapes available:
     - Concave Polygons (polygon2)
+    - Rectangles (rect2)
 
 * Algorithms available:
     - Separating Axis Theorem (polygon2)
+    - Broad-phase (rect2)
 
 Vector2
 -------
@@ -82,9 +84,13 @@ Concave Polygon
     :members:
     :special-members:
 
-    
-    
+Axis-Aligned Rectangle
+----------------------
 
+.. autoclass:: pygorithm.geometry.rect2.Rect2
+    :members:
+    :special-members:
+    :private-members:
 
 
 

pygorithm/data_structures/quadtree.py

@@ -0,0 +1,28 @@
+"""
+Author: Timothy Moore
+Created On: 31th August 2017
+
+Defines a two-dimensional quadtree of arbitrary
+depth and bucket size.
+"""
+import inspect
+
+from pygorithm.geometry import (vector2, polygon2, rect2)
+
+class QuadTree(object):
+    """
+    A quadtree is a sorting tool for two-dimensional space, most
+    commonly used to reduce the number of required collision 
+    calculations in a two-dimensional scene. In this context, 
+    the scene is stepped without collision detection, then a 
+    quadtree is constructed from all of the boundaries
+    """
+    @staticmethod
+    def get_code():
+        """
+        Get the code for the QuadTree class
+        
+        :returns: code for QuadTree
+        :rtype: string
+        """
+        return inspect.getsource(QuadTree)

pygorithm/geometry/polygon2.py

@@ -19,7 +19,7 @@ class Polygon2(object):
     index to the larger index will walk clockwise around the polygon.
     
     .. note:: 
-
+        
         Polygons should be used as if they were completely immutable to
         ensure correctness. All attributes of Polygon2 can be reconstructed
         from the points array, and thus cannot be changed on their own and
@@ -205,9 +205,9 @@ def from_regular(cls, sides, length, start_rads = None, start_degs = None, cente
         
         Finally, each vertex is found using ``<radius * cos(angle), radius * sin(angle)>``
         
-        If the center is not specified, the bounding box of the polygon is calculated while the vertices
-        are being found, and the center of the bounding box is set to the center of the circle. This
-        is never greater than (circumradius, circumradius).
+        If the center is not specified, the minimum of the bounding box of the 
+        polygon is calculated while the vertices are being found, and the inverse
+        of that value is offset to the rest of the points in the polygon. 
         
         :param sides: the number of sides in the polygon
         :type sides: :class:`numbers.Number`
@@ -251,8 +251,6 @@ def from_regular(cls, sides, length, start_rads = None, start_degs = None, cente
         pts = []
         _minx = 0
         _miny = 0
-        _maxx = 0
-        _maxy = 0
         for i in range(sides):
             x = center.x + math.cos(angle) * radius
             y = center.y + math.sin(angle) * radius
@@ -262,13 +260,11 @@ def from_regular(cls, sides, length, start_rads = None, start_degs = None, cente
             if _recenter:
                 _minx = min(_minx, x)
                 _miny = min(_miny, y)
-                _maxx = max(_maxx, x)
-                _maxy = max(_maxy, y)
 
         if _recenter:
-            _newcenter = vector2.Vector2((_maxx - _minx) / 2, (_maxy - _miny) / 2)
+            _offset = vector2.Vector2(-_minx, -_miny)
             for i in range(sides):
-                pts[i] += _newcenter
+                pts[i] += _offset
 
         return cls(pts, suppress_errors = True)
 
@@ -407,8 +403,8 @@ def contains_point(polygon, offset, point):
         :type offset: :class:`pygorithm.geometry.vector2.Vector2` or None
         :param point: the point to check
         :type point: :class:`pygorithm.geometry.vector2.Vector2`
-        :returns: (on edge, contained)
-        :rtype: (bool, bool)
+        :returns: on edge, contained
+        :rtype: bool, bool
         """
 
         _previous = polygon.points[0]
@@ -520,7 +516,7 @@ def _create_link(pts):
         :type pts: list of :class:`pygorithm.geometry.vector2.Vector2`
         """
 
-        param0 = "+".join(('%28{}%2C+{}%29'.format(v.x, v.y)) for v in pts)
+        param0 = "+".join(('%28{}%2C+{}%29'.format(round(v.x, 3), round(v.y, 3))) for v in pts)
         xmin = pts[0].x
         xmax = xmin
         ymin = pts[1].y