Skip to main content

A package to project onto quadratic hypersurfaces.

Project description

codecov pipeline status PyPI PyPI - License Conda Documentation

quadproj

A simple library to project a point onto a quadratic surface, or quadric.

How to install quadproj?

It is a one-liner!

python3 -m pip install quadproj

See installation page for further information and the requirements.

Documentation

The documentation is hosted on GitLab: https://loicvh.gitlab.io/quadproj

How does quadproj work?

The projection is obtained by computing exhaustively all KKT point from the optimization problem defining the projection. The authors of [1] show that for non-cylindrical central quadrics, the solutions belong to the KKT points that consist in the intersection between:

  • a unique root of a nonlinear function on a specific interval;
  • a set of closed-form points.

Either set can be empty but for a nonempty quadric, at least one is nonempty and contains (one of the) projections.

The full explanation is provided in [1].

How to use quadproj?

See the quickstart page or the API documentation.

Dependencies

See requirements.txt.

[1]

(2021) L. Van Hoorebeeck, P.-A. Absil and A. Papavasiliou, “Projection onto quadratic hypersurfaces”, submitted. (preprint, abstract/BibTex)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

quadproj-2.1.0.tar.gz (28.2 kB view details)

Uploaded Source

Built Distribution

quadproj-2.1.0-py3-none-any.whl (19.8 kB view details)

Uploaded Python 3

File details

Details for the file quadproj-2.1.0.tar.gz.

File metadata

  • Download URL: quadproj-2.1.0.tar.gz
  • Upload date:
  • Size: 28.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.10.15

File hashes

Hashes for quadproj-2.1.0.tar.gz
Algorithm Hash digest
SHA256 b57403a21765ab16f57295417e46110660b6c3450117e18fd20a7cffa80eae2e
MD5 d2180a5225902aa3c25f8676bf51837e
BLAKE2b-256 85b2930a0cf991407fc1fa190a011f3d2c10d59ed38e5ab542d79fbdd98c74d2

See more details on using hashes here.

File details

Details for the file quadproj-2.1.0-py3-none-any.whl.

File metadata

  • Download URL: quadproj-2.1.0-py3-none-any.whl
  • Upload date:
  • Size: 19.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.10.15

File hashes

Hashes for quadproj-2.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c6eb561ca6a726d41e2484443da493333187ea4ff72e1cd7bf78d6d7224bc17a
MD5 ed9054ad9f98a0d6ff59890370be3b7d
BLAKE2b-256 8d5717a07fc016cfa7ee7fb6fda7105b84326d9c1853dfbdcefe9c08a11020cf

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page