Skip to main content

A package to project onto quadratic hypersurface.

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.0.1.tar.gz (27.0 kB view details)

Uploaded Source

Built Distribution

quadproj-2.0.1-py3-none-any.whl (19.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for quadproj-2.0.1.tar.gz
Algorithm Hash digest
SHA256 e32c577e968d0d06ebd103e69ced5388bb203c824cff2cbda0f6f4902313ff3d
MD5 1d4cd4c83efa87e7267b65adea57652f
BLAKE2b-256 9fc4c1c9aaa8814cc1ae6525cef7464b02abc8cba7cb2e192dac8da1b5ee2188

See more details on using hashes here.

File details

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

File metadata

  • Download URL: quadproj-2.0.1-py3-none-any.whl
  • Upload date:
  • Size: 19.6 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.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 66ba75b649c87cc3c2bafb27462840f33548bc6457c394fd33953a7f45fbf60b
MD5 335705f99b94856ebbb72730157bf403
BLAKE2b-256 aa753427e2a0ddef5c99c41866735d7aea527cc3680358b2c6456134af36f16a

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