orient 0.5.1a0

Geometric queries.

orient

In what follows

• python is an alias for python3.5 or any later version (python3.6 and so on),
• pypy is an alias for pypy3.5 or any later version (pypy3.6 and so on).

Installation

Install the latest pip & setuptools packages versions:

• with CPython

  python -m pip install --upgrade pip setuptools
  

• with PyPy

  pypy -m pip install --upgrade pip setuptools
  

User

Download and install the latest stable version from PyPI repository:

• with CPython

  python -m pip install --upgrade orient
  

• with PyPy

  pypy -m pip install --upgrade orient
  

Developer

Download the latest version from GitHub repository

git clone https://github.com/lycantropos/orient.git
cd orient

Install dependencies:

• with CPython

  python -m pip install --force-reinstall -r requirements.txt
  

• with PyPy

  pypy -m pip install --force-reinstall -r requirements.txt
  

Install:

• with CPython

  python setup.py install
  

• with PyPy

  pypy setup.py install
  

Usage

>>> left_bottom = (0, 0)
>>> right_bottom = (4, 0)
>>> left_top = (0, 4)
>>> right_top = (4, 4)
>>> bottom_segment_midpoint = (2, 0)
>>> bottom_segment = (left_bottom, right_bottom)
>>> from orient.planar import Relation, point_in_segment
>>> point_in_segment(left_bottom, bottom_segment) is Relation.COMPONENT
True
>>> (point_in_segment(bottom_segment_midpoint, bottom_segment) 
...  is Relation.COMPONENT)
True
>>> point_in_segment(right_bottom, bottom_segment) is Relation.COMPONENT
True
>>> point_in_segment(left_top, bottom_segment) is Relation.DISJOINT
True
>>> square = [left_bottom, right_bottom, right_top, left_top]
>>> from orient.planar import point_in_region
>>> point_in_region(left_bottom, square) is Relation.COMPONENT
True
>>> point_in_region((1, 1), square) is Relation.WITHIN
True
>>> point_in_region(right_top, square) is Relation.COMPONENT
True
>>> point_in_region((5, 5), square) is Relation.DISJOINT
True
>>> main_diagonal = (left_bottom, right_top)
>>> from orient.planar import segment_in_region
>>> segment_in_region(bottom_segment, square) is Relation.COMPONENT
True
>>> segment_in_region(((1, 0), (5, 0)), square) is Relation.TOUCH
True
>>> segment_in_region(main_diagonal, square) is Relation.ENCLOSED
True
>>> segment_in_region(((1, 1), (2, 2)), square) is Relation.WITHIN
True
>>> segment_in_region(((1, 1), (5, 5)), square) is Relation.CROSS
True
>>> inner_square = [(1, 1), (3, 1), (3, 3), (1, 3)]
>>> from orient.planar import region_in_region
>>> region_in_region(square, square) is Relation.EQUAL
True
>>> region_in_region(inner_square, square) is Relation.WITHIN
True
>>> region_in_region(square, inner_square) is Relation.COVER
True
>>> from orient.planar import region_in_multiregion
>>> region_in_multiregion(square, []) is Relation.DISJOINT
True
>>> region_in_multiregion(square, [square]) is Relation.EQUAL
True
>>> region_in_multiregion(square, [inner_square]) is Relation.COVER
True
>>> region_in_multiregion(inner_square, [square]) is Relation.WITHIN
True
>>> from orient.planar import point_in_polygon
>>> point_in_polygon(left_bottom, (square, [])) is Relation.COMPONENT
True
>>> point_in_polygon((1, 1), (square, [])) is Relation.WITHIN
True
>>> point_in_polygon((2, 2), (square, [])) is Relation.WITHIN
True
>>> point_in_polygon((1, 1), (square, [inner_square])) is Relation.COMPONENT
True
>>> point_in_polygon((2, 2), (square, [inner_square])) is Relation.DISJOINT
True
>>> from orient.planar import segment_in_polygon
>>> segment_in_polygon(bottom_segment, (square, [])) is Relation.COMPONENT
True
>>> segment_in_polygon(((1, 0), (5, 0)), (square, [])) is Relation.TOUCH
True
>>> segment_in_polygon(main_diagonal, (square, [])) is Relation.ENCLOSED
True
>>> (segment_in_polygon(main_diagonal, (square, [inner_square]))
...  is Relation.CROSS)
True
>>> segment_in_polygon(((1, 1), (2, 2)), (square, [])) is Relation.WITHIN
True
>>> (segment_in_polygon(((1, 1), (2, 2)), (square, [inner_square]))
...  is Relation.TOUCH)
True
>>> segment_in_polygon(((1, 1), (5, 5)), (square, [])) is Relation.CROSS
True
>>> (segment_in_polygon(((1, 1), (5, 5)), (square, [inner_square]))
...  is Relation.CROSS)
True
>>> from orient.planar import polygon_in_polygon
>>> polygon_in_polygon((square, []), (square, [])) is Relation.EQUAL
True
>>> polygon_in_polygon((inner_square, []), (square, [])) is Relation.WITHIN
True
>>> polygon_in_polygon((square, []), (inner_square, [])) is Relation.COVER
True
>>> (polygon_in_polygon((inner_square, []), (square, [inner_square]))
...  is Relation.TOUCH)
True
>>> (polygon_in_polygon((square, [inner_square]), (inner_square, []))
...  is Relation.TOUCH)
True

Development

Bumping version

Preparation

Install bump2version.

Pre-release

Choose which version number category to bump following semver specification.

Test bumping version

bump2version --dry-run --verbose $CATEGORY

where $CATEGORY is the target version number category name, possible values are patch/minor/major.

Bump version

bump2version --verbose $CATEGORY

This will set version to major.minor.patch-alpha.

Release

Test bumping version

bump2version --dry-run --verbose release

Bump version

bump2version --verbose release

This will set version to major.minor.patch.

Running tests

Install dependencies:

• with CPython

  python -m pip install --force-reinstall -r requirements-tests.txt
  

• with PyPy

  pypy -m pip install --force-reinstall -r requirements-tests.txt
  

Plain

pytest

Inside Docker container:

• with CPython

  docker-compose --file docker-compose.cpython.yml up
  

• with PyPy

  docker-compose --file docker-compose.pypy.yml up
  

Bash script (e.g. can be used in Git hooks):

• with CPython

  ./run-tests.sh
  

  or

  ./run-tests.sh cpython
  

• with PyPy

  ./run-tests.sh pypy
  

PowerShell script (e.g. can be used in Git hooks):

• with CPython

  .\run-tests.ps1
  

  or

  .\run-tests.ps1 cpython
  

• with PyPy

  .\run-tests.ps1 pypy