pymomentum-cpu 0.1.78.post11__cp312-cp312-win_amd64.whl

include/momentum/solver/fwd.h

@@ -0,0 +1,131 @@
+/*
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+// This file is @generated by gen_fwd.py
+// Do not edit this file directly, instead update gen_fwd_input.toml and run:
+// buck run @arvr/mode/platform010/opt //arvr/libraries/momentum:gen_fwd
+
+#pragma once
+
+#include <memory>
+
+namespace momentum {
+
+struct SolverOptions;
+
+using SolverOptions_p = ::std::shared_ptr<SolverOptions>;
+using SolverOptions_u = ::std::unique_ptr<SolverOptions>;
+using SolverOptions_w = ::std::weak_ptr<SolverOptions>;
+using SolverOptions_const_p = ::std::shared_ptr<const SolverOptions>;
+using SolverOptions_const_u = ::std::unique_ptr<const SolverOptions>;
+using SolverOptions_const_w = ::std::weak_ptr<const SolverOptions>;
+
+struct GaussNewtonSolverOptions;
+
+using GaussNewtonSolverOptions_p = ::std::shared_ptr<GaussNewtonSolverOptions>;
+using GaussNewtonSolverOptions_u = ::std::unique_ptr<GaussNewtonSolverOptions>;
+using GaussNewtonSolverOptions_w = ::std::weak_ptr<GaussNewtonSolverOptions>;
+using GaussNewtonSolverOptions_const_p = ::std::shared_ptr<const GaussNewtonSolverOptions>;
+using GaussNewtonSolverOptions_const_u = ::std::unique_ptr<const GaussNewtonSolverOptions>;
+using GaussNewtonSolverOptions_const_w = ::std::weak_ptr<const GaussNewtonSolverOptions>;
+
+template <typename T>
+class SolverT;
+using Solver = SolverT<float>;
+using Solverd = SolverT<double>;
+
+using Solver_p = ::std::shared_ptr<Solver>;
+using Solver_u = ::std::unique_ptr<Solver>;
+using Solver_w = ::std::weak_ptr<Solver>;
+using Solver_const_p = ::std::shared_ptr<const Solver>;
+using Solver_const_u = ::std::unique_ptr<const Solver>;
+using Solver_const_w = ::std::weak_ptr<const Solver>;
+
+using Solverd_p = ::std::shared_ptr<Solverd>;
+using Solverd_u = ::std::unique_ptr<Solverd>;
+using Solverd_w = ::std::weak_ptr<Solverd>;
+using Solverd_const_p = ::std::shared_ptr<const Solverd>;
+using Solverd_const_u = ::std::unique_ptr<const Solverd>;
+using Solverd_const_w = ::std::weak_ptr<const Solverd>;
+
+template <typename T>
+class SolverFunctionT;
+using SolverFunction = SolverFunctionT<float>;
+using SolverFunctiond = SolverFunctionT<double>;
+
+using SolverFunction_p = ::std::shared_ptr<SolverFunction>;
+using SolverFunction_u = ::std::unique_ptr<SolverFunction>;
+using SolverFunction_w = ::std::weak_ptr<SolverFunction>;
+using SolverFunction_const_p = ::std::shared_ptr<const SolverFunction>;
+using SolverFunction_const_u = ::std::unique_ptr<const SolverFunction>;
+using SolverFunction_const_w = ::std::weak_ptr<const SolverFunction>;
+
+using SolverFunctiond_p = ::std::shared_ptr<SolverFunctiond>;
+using SolverFunctiond_u = ::std::unique_ptr<SolverFunctiond>;
+using SolverFunctiond_w = ::std::weak_ptr<SolverFunctiond>;
+using SolverFunctiond_const_p = ::std::shared_ptr<const SolverFunctiond>;
+using SolverFunctiond_const_u = ::std::unique_ptr<const SolverFunctiond>;
+using SolverFunctiond_const_w = ::std::weak_ptr<const SolverFunctiond>;
+
+template <typename T>
+class GaussNewtonSolverT;
+using GaussNewtonSolver = GaussNewtonSolverT<float>;
+using GaussNewtonSolverd = GaussNewtonSolverT<double>;
+
+using GaussNewtonSolver_p = ::std::shared_ptr<GaussNewtonSolver>;
+using GaussNewtonSolver_u = ::std::unique_ptr<GaussNewtonSolver>;
+using GaussNewtonSolver_w = ::std::weak_ptr<GaussNewtonSolver>;
+using GaussNewtonSolver_const_p = ::std::shared_ptr<const GaussNewtonSolver>;
+using GaussNewtonSolver_const_u = ::std::unique_ptr<const GaussNewtonSolver>;
+using GaussNewtonSolver_const_w = ::std::weak_ptr<const GaussNewtonSolver>;
+
+using GaussNewtonSolverd_p = ::std::shared_ptr<GaussNewtonSolverd>;
+using GaussNewtonSolverd_u = ::std::unique_ptr<GaussNewtonSolverd>;
+using GaussNewtonSolverd_w = ::std::weak_ptr<GaussNewtonSolverd>;
+using GaussNewtonSolverd_const_p = ::std::shared_ptr<const GaussNewtonSolverd>;
+using GaussNewtonSolverd_const_u = ::std::unique_ptr<const GaussNewtonSolverd>;
+using GaussNewtonSolverd_const_w = ::std::weak_ptr<const GaussNewtonSolverd>;
+
+template <typename T>
+class GradientDescentSolverT;
+using GradientDescentSolver = GradientDescentSolverT<float>;
+using GradientDescentSolverd = GradientDescentSolverT<double>;
+
+using GradientDescentSolver_p = ::std::shared_ptr<GradientDescentSolver>;
+using GradientDescentSolver_u = ::std::unique_ptr<GradientDescentSolver>;
+using GradientDescentSolver_w = ::std::weak_ptr<GradientDescentSolver>;
+using GradientDescentSolver_const_p = ::std::shared_ptr<const GradientDescentSolver>;
+using GradientDescentSolver_const_u = ::std::unique_ptr<const GradientDescentSolver>;
+using GradientDescentSolver_const_w = ::std::weak_ptr<const GradientDescentSolver>;
+
+using GradientDescentSolverd_p = ::std::shared_ptr<GradientDescentSolverd>;
+using GradientDescentSolverd_u = ::std::unique_ptr<GradientDescentSolverd>;
+using GradientDescentSolverd_w = ::std::weak_ptr<GradientDescentSolverd>;
+using GradientDescentSolverd_const_p = ::std::shared_ptr<const GradientDescentSolverd>;
+using GradientDescentSolverd_const_u = ::std::unique_ptr<const GradientDescentSolverd>;
+using GradientDescentSolverd_const_w = ::std::weak_ptr<const GradientDescentSolverd>;
+
+template <typename T>
+class SubsetGaussNewtonSolverT;
+using SubsetGaussNewtonSolver = SubsetGaussNewtonSolverT<float>;
+using SubsetGaussNewtonSolverd = SubsetGaussNewtonSolverT<double>;
+
+using SubsetGaussNewtonSolver_p = ::std::shared_ptr<SubsetGaussNewtonSolver>;
+using SubsetGaussNewtonSolver_u = ::std::unique_ptr<SubsetGaussNewtonSolver>;
+using SubsetGaussNewtonSolver_w = ::std::weak_ptr<SubsetGaussNewtonSolver>;
+using SubsetGaussNewtonSolver_const_p = ::std::shared_ptr<const SubsetGaussNewtonSolver>;
+using SubsetGaussNewtonSolver_const_u = ::std::unique_ptr<const SubsetGaussNewtonSolver>;
+using SubsetGaussNewtonSolver_const_w = ::std::weak_ptr<const SubsetGaussNewtonSolver>;
+
+using SubsetGaussNewtonSolverd_p = ::std::shared_ptr<SubsetGaussNewtonSolverd>;
+using SubsetGaussNewtonSolverd_u = ::std::unique_ptr<SubsetGaussNewtonSolverd>;
+using SubsetGaussNewtonSolverd_w = ::std::weak_ptr<SubsetGaussNewtonSolverd>;
+using SubsetGaussNewtonSolverd_const_p = ::std::shared_ptr<const SubsetGaussNewtonSolverd>;
+using SubsetGaussNewtonSolverd_const_u = ::std::unique_ptr<const SubsetGaussNewtonSolverd>;
+using SubsetGaussNewtonSolverd_const_w = ::std::weak_ptr<const SubsetGaussNewtonSolverd>;
+
+} // namespace momentum

include/momentum/solver/gauss_newton_solver.h

@@ -0,0 +1,136 @@
+/*
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+#pragma once
+
+#include <momentum/solver/fwd.h>
+#include <momentum/solver/solver.h>
+
+namespace momentum {
+
+/// Extended options specific to the Gauss-Newton optimization algorithm
+struct GaussNewtonSolverOptions : SolverOptions {
+  /// Damping parameter added to Hessian diagonal for numerical stability; see
+  /// https://en.wikipedia.org/wiki/Levenberg%E2%80%93Marquardt_algorithm
+  ///
+  /// Higher values improve stability but may slow convergence
+  float regularization = 0.05f;
+
+  /// Enables backtracking line search to ensure error reduction at each step
+  bool doLineSearch = false;
+
+  /// Uses pre-computed JᵀJ and JᵀR from the solver function
+  ///
+  /// Can improve performance for problems with specialized structure
+  bool useBlockJtJ = false;
+
+  /// Directly computes sparse JᵀJ without dense intermediate representation
+  ///
+  /// Only effective when useBlockJtJ is true
+  bool directSparseJtJ = false;
+
+  /// Parameter count threshold for switching to sparse matrix operations
+  ///
+  /// Problems with more parameters than this threshold will use sparse solvers
+  size_t sparseMatrixThreshold = 200;
+
+  /// Default constructor
+  GaussNewtonSolverOptions() = default;
+
+  /// Construct from base solver options while preserving Gauss-Newton defaults
+  /* implicit */ GaussNewtonSolverOptions(const SolverOptions& baseOptions)
+      : SolverOptions(baseOptions) {}
+};
+
+/// Implementation of the Gauss-Newton optimization algorithm
+///
+/// Minimizes non-linear least squares problems by iteratively approximating
+/// the objective function with a quadratic model based on first derivatives.
+/// Supports both dense and sparse matrix operations depending on problem size.
+template <typename T>
+class GaussNewtonSolverT : public SolverT<T> {
+ public:
+  /// Creates a solver with the specified options and function to optimize
+  GaussNewtonSolverT(const SolverOptions& options, SolverFunctionT<T>* solver);
+
+  /// Returns "GaussNewton" as the solver name
+  [[nodiscard]] std::string_view getName() const override;
+
+  /// Updates solver configuration, handling both base and Gauss-Newton specific options
+  void setOptions(const SolverOptions& options) final;
+
+ protected:
+  /// Performs one iteration of the Gauss-Newton algorithm
+  ///
+  /// Delegates to either doIterationDense or doIterationSparse based on problem size
+  void doIteration() final;
+
+  /// Initializes solver state before optimization begins
+  void initializeSolver() final;
+
+ private:
+  /// Performs one iteration using dense matrix operations
+  void doIterationDense();
+
+  /// Performs one iteration using sparse matrix operations
+  void doIterationSparse();
+
+  /// Updates parameters using the computed step direction
+  ///
+  /// Optionally performs line search if enabled
+  void updateParameters(Eigen::VectorX<T>& delta);
+
+  /// Whether to use pre-computed JᵀJ and JᵀR from solver function
+  bool useBlockJtJ_{};
+
+  /// Whether to directly compute sparse JᵀJ without dense intermediate
+  bool directSparseJtJ_{};
+
+  /// Parameter count threshold for switching to sparse operations
+  size_t sparseMatrixThreshold_{200};
+
+  /// Whether the solver has been initialized
+  bool initialized_;
+
+  /// Whether to perform line search during parameter updates
+  bool doLineSearch_;
+
+  /// Sparse Cholesky factorization solver
+  Eigen::SimplicialLLT<Eigen::SparseMatrix<T>, Eigen::Lower> lltSolver_;
+
+  /// Sparse approximation of Hessian matrix (JᵀJ)
+  Eigen::SparseMatrix<T> JtJ_;
+
+  /// Sparse identity matrix for regularization
+  Eigen::SparseMatrix<T> D_;
+
+  /// Jacobian matrix for dense operations
+  Eigen::MatrixX<T> jacobian_;
+
+  /// Dense approximation of Hessian matrix (JᵀJ)
+  Eigen::MatrixX<T> hessianApprox_;
+
+  /// Gradient vector (JᵀR)
+  Eigen::VectorX<T> JtR_;
+
+  /// Residual vector
+  Eigen::VectorX<T> residual_;
+
+  /// Dense Cholesky factorization solver
+  Eigen::LLT<Eigen::MatrixX<T>> llt_;
+
+  /// Base regularization parameter
+  T regularization_;
+
+  /// Current regularization value (may be adjusted during iterations)
+  T alpha_;
+
+  /// Whether the current iteration uses dense operations
+  bool denseIteration_{};
+};
+
+} // namespace momentum

include/momentum/solver/gradient_descent_solver.h

@@ -0,0 +1,65 @@
+/*
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+#pragma once
+
+#include <momentum/solver/fwd.h>
+#include <momentum/solver/solver.h>
+
+namespace momentum {
+
+/// Extended options for the Gradient Descent optimization algorithm
+///
+/// Provides configuration specific to the first-order gradient descent method
+struct GradientDescentSolverOptions : SolverOptions {
+  /// Step size for parameter updates during optimization
+  ///
+  /// Controls how far to move in the direction of the negative gradient
+  float learningRate = 0.01f;
+
+  /// Default constructor
+  GradientDescentSolverOptions() = default;
+
+  /// Construct from base solver options while preserving Gradient Descent defaults
+  /* implicit */ GradientDescentSolverOptions(const SolverOptions& baseOptions)
+      : SolverOptions(baseOptions) {}
+};
+
+/// First-order optimization algorithm that follows the negative gradient
+///
+/// Implements the standard gradient descent method which iteratively
+/// updates parameters by moving in the direction of steepest descent
+template <typename T>
+class GradientDescentSolverT : public SolverT<T> {
+ public:
+  /// Creates a solver with the specified options and function to optimize
+  GradientDescentSolverT(const SolverOptions& options, SolverFunctionT<T>* solver);
+
+  /// Returns "GradientDescent" as the solver name
+  [[nodiscard]] std::string_view getName() const override;
+
+  /// Updates solver configuration, handling both base and Gradient Descent specific options
+  void setOptions(const SolverOptions& options) final;
+
+ protected:
+  /// Performs one iteration of the gradient descent algorithm
+  ///
+  /// Computes the gradient and updates parameters by moving in the negative gradient direction
+  void doIteration() final;
+
+  /// Initializes solver state before optimization begins
+  void initializeSolver() final;
+
+ private:
+  /// Gradient vector at current parameter values
+  Eigen::VectorX<T> gradient_;
+
+  /// Step size for parameter updates
+  float learningRate_;
+};
+
+} // namespace momentum

include/momentum/solver/solver.h

@@ -0,0 +1,155 @@
+/*
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+#pragma once
+
+#include <momentum/math/types.h>
+#include <momentum/solver/fwd.h>
+
+#include <string>
+#include <unordered_map>
+
+namespace momentum {
+
+/// Common options for numerical optimization solvers.
+struct SolverOptions {
+  /// Minimum number of iterations before checking convergence criteria
+  size_t minIterations = 1;
+
+  /// Maximum number of iterations before terminating
+  size_t maxIterations = 2;
+
+  /// Convergence threshold for relative error change
+  float threshold = 1.0f;
+
+  /// Enable detailed logging during optimization
+  bool verbose = false;
+
+  /// Virtual destructor for polymorphic behavior
+  virtual ~SolverOptions() = default;
+};
+
+/// Base class for numerical optimization solvers.
+///
+/// Provides common functionality for iterative optimization algorithms
+/// including parameter management, convergence checking, and history tracking.
+template <typename T>
+class SolverT {
+ public:
+  /// Constructor with solver options and function to optimize
+  SolverT(const SolverOptions& options, SolverFunctionT<T>* solver);
+
+  virtual ~SolverT() = default;
+
+  /// Returns the name of the solver implementation
+  [[nodiscard]] virtual std::string_view getName() const = 0;
+
+  /// Updates solver configuration with new options
+  virtual void setOptions(const SolverOptions& options);
+
+  /// Solves the optimization problem
+  ///
+  /// @param[in,out] params Vector of initial guess, updated with the optimized solution
+  /// @return Final objective function value after optimization
+  double solve(Eigen::VectorX<T>& params);
+
+  /// Specifies which parameters should be optimized
+  ///
+  /// @param parameters Bitset where each bit indicates if the corresponding parameter is enabled
+  virtual void setEnabledParameters(const ParameterSet& parameters);
+
+  /// Returns the current set of enabled parameters
+  [[nodiscard]] const ParameterSet& getActiveParameters() const;
+
+  /// Sets the current parameter values without solving
+  void setParameters(const Eigen::VectorX<T>& params);
+
+  /// Controls whether to store iteration history for debugging and analysis
+  void setStoreHistory(bool b);
+
+  /// Returns the history of the solver's iterations
+  ///
+  /// The history contains matrices for parameters, errors, and other solver-specific data
+  [[nodiscard]] const std::unordered_map<std::string, Eigen::MatrixX<T>>& getHistory() const;
+
+  /// Returns the minimum number of iterations before checking convergence
+  [[nodiscard]] size_t getMinIterations() const;
+
+  /// Returns the maximum number of iterations before terminating
+  [[nodiscard]] size_t getMaxIterations() const;
+
+  [[nodiscard]] size_t getNumParameters() const {
+    return numParameters_;
+  }
+
+  /// Returns the history of objective function values over the iterations of the solve
+  [[nodiscard]] const std::vector<double>& getErrorHistory() const {
+    return errorHistory_;
+  }
+
+ protected:
+  /// Initializes solver state before optimization begins
+  virtual void initializeSolver() = 0;
+
+  /// Performs a single iteration of the optimization algorithm
+  virtual void doIteration() = 0;
+
+ protected:
+  /// Total number of parameters in the optimization problem
+  size_t numParameters_;
+
+  /// Function to be optimized
+  SolverFunctionT<T>* solverFunction_;
+
+  /// Current parameter values
+  Eigen::VectorX<T> parameters_;
+
+  /// Bitset indicating which parameters are enabled for optimization
+  ParameterSet activeParameters_;
+
+  /// Number of parameters currently enabled for optimization
+  int actualParameters_;
+
+  /// Flag indicating parameter structure has changed
+  ///
+  /// Used to trigger reinitialization of solver data structures
+  bool newParameterPattern_;
+
+  /// Current iteration count
+  size_t iteration_{};
+
+  /// Current objective function value
+  double error_{};
+
+  /// Previous iteration's objective function value
+  double lastError_{};
+
+  /// Whether to record optimization progress for analysis
+  bool storeHistory = false;
+
+  /// Recorded data from optimization process
+  ///
+  /// Contains matrices for parameters, errors, and other solver-specific data
+  std::unordered_map<std::string, Eigen::MatrixX<T>> iterationHistory_;
+  /// History of objective function values over the iterations
+  std::vector<double> errorHistory_;
+
+  /// Whether to output detailed progress information
+  bool verbose_ = false;
+
+ private:
+  /// Minimum iterations before checking convergence criteria
+  size_t minIterations_{};
+
+  /// Maximum iterations before terminating optimization
+  size_t maxIterations_{};
+
+  /// Relative error change threshold for convergence
+  float threshold_{};
+};
+
+} // namespace momentum

include/momentum/solver/solver_function.h

@@ -0,0 +1,126 @@
+/*
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+#pragma once
+
+#include <momentum/math/types.h>
+#include <momentum/solver/fwd.h>
+
+#include <unordered_map>
+
+namespace momentum {
+
+/// Abstract base class for optimization objective functions
+///
+/// Provides the interface for computing objective function values, gradients,
+/// and other derivatives needed by numerical optimization algorithms.
+template <typename T>
+class SolverFunctionT {
+ public:
+  virtual ~SolverFunctionT() = default;
+
+  /// Evaluates the objective function at the given parameter values
+  ///
+  /// @param parameters Current parameter values
+  /// @return Objective function value (typically sum of squared errors)
+  virtual double getError(const VectorX<T>& parameters) = 0;
+
+  /// Computes the gradient of the objective function
+  ///
+  /// @param parameters Current parameter values
+  /// @param[out] gradient Computed gradient vector
+  /// @return Objective function value
+  virtual double getGradient(const VectorX<T>& parameters, VectorX<T>& gradient) = 0;
+
+  /// Computes the Jacobian matrix for least squares problems
+  ///
+  /// @param parameters Current parameter values
+  /// @param[out] jacobian Jacobian matrix (m×n for m residuals and n parameters)
+  /// @param[out] residual Vector of residual values
+  /// @param[out] actualRows Number of active residual rows
+  /// @return Objective function value
+  virtual double getJacobian(
+      const VectorX<T>& parameters,
+      MatrixX<T>& jacobian,
+      VectorX<T>& residual,
+      size_t& actualRows) = 0;
+
+  /// Computes the Hessian matrix of second derivatives
+  ///
+  /// Default implementation throws an exception as this is rarely needed
+  /// @param parameters Current parameter values
+  /// @param[out] hessian Computed Hessian matrix
+  virtual void getHessian(const VectorX<T>& parameters, MatrixX<T>& hessian);
+
+  /// Computes JᵀJ and JᵀR for Gauss-Newton optimization
+  ///
+  /// Default implementation computes these from the Jacobian
+  /// @param parameters Current parameter values
+  /// @param[out] jtj Approximated Hessian matrix (JᵀJ)
+  /// @param[out] jtr Gradient vector (JᵀR)
+  /// @return Objective function value
+  virtual double getJtJR(const VectorX<T>& parameters, MatrixX<T>& jtj, VectorX<T>& jtr);
+
+  /// Computes sparse JᵀJ and JᵀR for large-scale problems
+  ///
+  /// Default implementation returns 0.0 and must be overridden for sparse optimization
+  /// @param parameters Current parameter values
+  /// @param[out] jtj Sparse approximated Hessian matrix
+  /// @param[out] jtr Gradient vector
+  /// @return Objective function value
+  virtual double
+  getJtJR_Sparse(const VectorX<T>& parameters, SparseMatrix<T>& jtj, VectorX<T>& jtr);
+
+  /// Computes derivatives needed by the solver
+  ///
+  /// Default implementation calls getJtJR
+  /// @param parameters Current parameter values
+  /// @param[out] hess Hessian matrix or approximation
+  /// @param[out] grad Gradient vector
+  /// @return Objective function value
+  virtual double
+  getSolverDerivatives(const VectorX<T>& parameters, MatrixX<T>& hess, VectorX<T>& grad);
+
+  /// Updates parameters using the computed step direction
+  ///
+  /// @param[in,out] parameters Current parameters, updated in-place
+  /// @param gradient Step direction (typically the negative gradient)
+  virtual void updateParameters(VectorX<T>& parameters, const VectorX<T>& gradient) = 0;
+
+  /// Specifies which parameters should be optimized
+  ///
+  /// Default implementation does nothing
+  /// @param parameterSet Bitset where each bit indicates if the corresponding parameter is enabled
+  virtual void setEnabledParameters(const ParameterSet& parameterSet);
+
+  /// Returns the total number of parameters in the optimization problem
+  [[nodiscard]] size_t getNumParameters() const;
+
+  /// Returns the number of parameters currently enabled for optimization
+  [[nodiscard]] size_t getActualParameters() const;
+
+  /// Records solver state for debugging and analysis
+  ///
+  /// @param[in,out] history Map to store iteration data
+  /// @param iteration Current iteration number
+  /// @param maxIterations Maximum number of iterations
+  virtual void storeHistory(
+      std::unordered_map<std::string, MatrixX<T>>& history,
+      size_t iteration,
+      size_t maxIterations_);
+
+ protected:
+  /// Total number of parameters in the optimization problem
+  size_t numParameters_{};
+
+  /// Number of parameters currently enabled for optimization
+  ///
+  /// Always less than or equal to numParameters_
+  size_t actualParameters_{};
+};
+
+} // namespace momentum