API Reference

This reference documents the cuNLS Python package pycunls and the C++ library it is built on: solver classes, key configuration structs, and major helper abstractions.

Each page presents the shared theory once, then the Python API, then the C++ API. Python classes live in the pycunls package and accept CuPy arrays (or raw int device pointers) wherever the C++ API takes const float*. See Installation for setup instructions. The Linear Solver API and Math API pages document C++-only APIs.

• Minimizer API
  • Theory — Gauss-Newton and Levenberg-Marquardt
  • Python API (pycunls)
  • C++ API
• State API
  • Manifolds
  • Python API (pycunls)
  • C++ API
• Factor API
  • Python API (pycunls)
  • C++ API
• Robustifier API
  • Overview
  • Python API (pycunls)
  • C++ API
• Common API
  • Python API (pycunls)
  • C++ API
• Linear Solver API
  • SparseLinearSolverType
  • SparseLinearSolverConfig
  • SparseLinearSolver
  • BlockSparsePCGOptions
  • BlockSparsePCGSolver
  • cuDSSLinearSolverMode
  • cuDSSLinearSolverOptions
  • cuDSSLinearSolver
  • DenseLDLTSolver
  • DenseCholeskySolver
  • DenseQRSolver
  • Factory
• Math API
  • Common parameter semantics
  • Lie math API (lie_math.h)
  • Dense matrix API (dense_matrix_ops.h)