qsppack documentation

qsppack provides polynomial construction, phase synthesis, and numerical verification tools for Quantum Signal Processing (QSP). Start with the workflow guide if you are new to the package; use the reference pages when you already know which function you need.

Start here

• Getting started
  • Installation
  • The QSP workflow
  • Minimal example
  • Coefficient and phase conventions
  • Choosing a synthesis method

Guides and examples

• Example applications
  • Core algorithms
  • Filters and singular-value transformations
  • State preparation
• Polynomial Approximation Examples
  • Constrained Remez approximation
  • Nonlinear Fourier retraction

API reference

• Solver Module
  • solve()
  • Example
• Optimizers Module
  • lbfgs()
  • coordinate_minimization()
  • newton()
  • nlft()
  • Example
• Objective Module
  • obj_sym()
  • grad_sym()
  • grad_sym_real()
  • Example
• Utilities Module
  • Public evaluation and conversion helpers
  • Low-level phase-map helpers
  • Example
• Nonlinear Fourier Analysis Module
  • b_from_cheb()
  • weiss()
  • inverse_nonlinear_FFT()
  • forward_nlft()
  • forward_nonlinear_FFT()
  • Example
• Constrained Remez Approximation
  • remez()
  • RemezResult
  • RemezMetrics
  • RemezOptions
  • ConstrainedRemezFitter
  • plot_remez_result()
  • RemezConvergenceError
  • RemezConvergenceWarning
• Nonlinear Fourier Retraction
  • RetractionMetrics
  • RetractionResult
  • retract()

Project background

This package is based on the QSPPACK MATLAB package. Earlier MATLAB-oriented tutorials are available in the QSPPACK GitBook, which is no longer actively maintained.

Indices

• Index

• Module Index