https://github.com/lycantropos/bentley_ottmann
Detection of line segments & polygon edges intersections
https://github.com/lycantropos/bentley_ottmann
bentley-ottmann shamos-hoey sweep-line-algorithm
Last synced: about 1 year ago
JSON representation
Detection of line segments & polygon edges intersections
- Host: GitHub
- URL: https://github.com/lycantropos/bentley_ottmann
- Owner: lycantropos
- License: mit
- Created: 2020-01-18T13:02:54.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-11-13T09:20:55.000Z (over 2 years ago)
- Last Synced: 2025-04-30T14:29:46.664Z (about 1 year ago)
- Topics: bentley-ottmann, shamos-hoey, sweep-line-algorithm
- Language: Python
- Homepage: https://bentley-ottmann.rtfd.io
- Size: 324 KB
- Stars: 17
- Watchers: 1
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
bentley_ottmann
===============
[](https://github.com/lycantropos/bentley_ottmann/actions/workflows/ci.yml "Github Actions")
[](https://bentley-ottmann.readthedocs.io/en/latest "Documentation")
[](https://codecov.io/gh/lycantropos/bentley_ottmann "Codecov")
[](https://github.com/lycantropos/bentley_ottmann/blob/master/LICENSE "License")
[](https://badge.fury.io/py/bentley-ottmann "PyPI")
In what follows `python` is an alias for `python3.7` or `pypy3.7`
or any later version (`python3.8`, `pypy3.8` and so on).
Installation
------------
Install the latest `pip` & `setuptools` packages versions
```bash
python -m pip install --upgrade pip setuptools
```
### User
Download and install the latest stable version from `PyPI` repository
```bash
python -m pip install --upgrade bentley_ottmann
```
### Developer
Download the latest version from `GitHub` repository
```bash
git clone https://github.com/lycantropos/bentley_ottmann.git
cd bentley_ottmann
```
Install dependencies
```bash
python -m pip install -r requirements.txt
```
Install
```bash
python setup.py install
```
Usage
-----
With segments
```python
>>> from ground.base import get_context
>>> context = get_context()
>>> Point, Segment = context.point_cls, context.segment_cls
>>> unit_segments = [Segment(Point(0, 0), Point(1, 0)),
... Segment(Point(0, 0), Point(0, 1))]
```
we can check if they intersect
```python
>>> from bentley_ottmann.planar import segments_intersect
>>> segments_intersect(unit_segments)
True
```
With contours
```python
>>> Contour = context.contour_cls
>>> triangle = Contour([Point(0, 0), Point(1, 0), Point(0, 1)])
>>> degenerate_triangle = Contour([Point(0, 0), Point(2, 0), Point(1, 0)])
```
we can check if they are self-intersecting or not
```python
>>> from bentley_ottmann.planar import contour_self_intersects
>>> contour_self_intersects(triangle)
False
>>> contour_self_intersects(degenerate_triangle)
True
```
Development
-----------
### Bumping version
#### Preparation
Install
[bump2version](https://github.com/c4urself/bump2version#installation).
#### Pre-release
Choose which version number category to bump following [semver
specification](http://semver.org/).
Test bumping version
```bash
bump2version --dry-run --verbose $CATEGORY
```
where `$CATEGORY` is the target version number category name, possible
values are `patch`/`minor`/`major`.
Bump version
```bash
bump2version --verbose $CATEGORY
```
This will set version to `major.minor.patch-alpha`.
#### Release
Test bumping version
```bash
bump2version --dry-run --verbose release
```
Bump version
```bash
bump2version --verbose release
```
This will set version to `major.minor.patch`.
### Running tests
Install dependencies
```bash
python -m pip install -r requirements-tests.txt
```
Plain
```bash
pytest
```
Inside `Docker` container:
- with `CPython`
```bash
docker-compose --file docker-compose.cpython.yml up
```
- with `PyPy`
```bash
docker-compose --file docker-compose.pypy.yml up
```
`Bash` script:
- with `CPython`
```bash
./run-tests.sh
```
or
```bash
./run-tests.sh cpython
```
- with `PyPy`
```bash
./run-tests.sh pypy
```
`PowerShell` script:
- with `CPython`
```powershell
.\run-tests.ps1
```
or
```powershell
.\run-tests.ps1 cpython
```
- with `PyPy`
```powershell
.\run-tests.ps1 pypy
```