itkEigenLevenbergMarquardtEngine.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *         https://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *=========================================================================*/
#ifndef itkEigenLevenbergMarquardtEngine_h
#define itkEigenLevenbergMarquardtEngine_h
 
#include "ITKOptimizersExport.h"
#include "vnl/vnl_vector.h"
#include <functional>
 
namespace itk::detail
{
struct EigenLevenbergMarquardtOptions
{
  unsigned long maxFunctionEvaluations{ 2000 };
  double        xTolerance{ 1e-8 };
  double        gradientTolerance{ 1e-5 };
  double        functionTolerance{ 1e-8 };
  double        epsilonFunction{ 1e-11 };
};

struct EigenLevenbergMarquardtResult
{
  vnl_vector<double> solution;
  int                status{ 0 };
  bool               converged{ false };
  unsigned int       numberOfEvaluations{ 0 };
  double             residualNorm{ 0.0 };
};

ITKOptimizers_EXPORT EigenLevenbergMarquardtResult
EigenLevenbergMarquardtSolve(unsigned int                                          numberOfParameters,
                             unsigned int                                          numberOfResiduals,
                             const std::function<void(const double *, double *)> & residual,
                             const std::function<void(const double *, double *)> & jacobian,
                             const vnl_vector<double> &                            initialPosition,
                             const EigenLevenbergMarquardtOptions &                options);
} // namespace itk::detail
 
#endif