ScalarRootFinder.hh

Go to the documentation of this file.

/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *\
 * Copyright (c) 2025, Davide Stocco, Mattia Piazza and Enrico Bertolazzi.                       *
 *                                                                                               *
 * The Optimist project is distributed under the BSD 2-Clause License.                           *
 *                                                                                               *
 * Davide Stocco                          Mattia Piazza                        Enrico Bertolazzi *
 * University of Trento               University of Trento                  University of Trento *
 * davide.stocco@unitn.it            mattia.piazza@unitn.it           enrico.bertolazzi@unitn.it *
\* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
 
#pragma once
 
#ifndef OPTIMIST_SCALAR_ROOT_FINDER_HH
#define OPTIMIST_SCALAR_ROOT_FINDER_HH
 
#include "Solver.hh"
 
namespace Optimist
{

  namespace ScalarRootFinder
  {
 
    /*\
     |   ____            _            ____             _   _____ _           _
     |  / ___|  ___ __ _| | __ _ _ __|  _ \ ___   ___ | |_|  ___(_)_ __   __| | ___ _ __
     |  \___ \ / __/ _` | |/ _` | '__| |_) / _ \ / _ \| __| |_  | | '_ \ / _` |/ _ \ '__|
     |   ___) | (_| (_| | | (_| | |  |  _ < (_) | (_) | |_|  _| | | | | | (_| |  __/ |
     |  |____/ \___\__,_|_|\__,_|_|  |_| \_\___/ \___/ \__|_|   |_|_| |_|\__,_|\___|_|
     |
    \*/

    template <typename Real, typename DerivedSolver>
    class ScalarRootFinder : public Solver<Real, 1, 1, DerivedSolver>
    {
    public:
      friend Solver<Real, 1, 1, ScalarRootFinder<Real, DerivedSolver>>;
 
      static constexpr bool is_rootfinder{true};
      static constexpr bool is_optimizer{false};
 
      static constexpr bool requires_function{DerivedSolver::requires_function};
      static constexpr bool requires_first_derivative{DerivedSolver::requires_first_derivative};
      static constexpr bool requires_second_derivative{DerivedSolver::requires_second_derivative};
 
      OPTIMIST_BASIC_CONSTANTS(Real) 
 
      using FunctionWrapper         = typename Solver<Real, 1, 1, DerivedSolver>::FunctionWrapper;
      using FirstDerivativeWrapper  = typename Solver<Real, 1, 1, DerivedSolver>::FirstDerivativeWrapper;
      using SecondDerivativeWrapper = typename Solver<Real, 1, 1, DerivedSolver>::SecondDerivativeWrapper;

      ScalarRootFinder() {}

      std::string name() const {return static_cast<const DerivedSolver *>(this)->name_impl();}

      bool solve(FunctionWrapper function, Real x_ini, Real & x_sol)
      {
        return static_cast<DerivedSolver *>(this)->solve_impl(function, x_ini, x_sol);
      }

      bool solve(FunctionWrapper function, FirstDerivativeWrapper first_derivative, Real x_ini,
        Real & x_sol)
      {
        return static_cast<DerivedSolver *>(this)->solve_impl(function, first_derivative, x_ini, x_sol);
      }

      bool solve(FunctionWrapper function, FirstDerivativeWrapper first_derivative, SecondDerivativeWrapper
        second_derivate, Real x_ini, Real & x_sol)
      {
        return static_cast<DerivedSolver *>(this)->solve_impl(function, first_derivative,
          second_derivate, x_ini, x_sol);
      }
 
    }; // class ScalarRootFinder
 
  } // namespace ScalarRootFinder
 
} // namespace Optimist
 
#endif // OPTIMIST_SCALAR_ROOT_FINDER_HH