// OpenSTA, Static Timing Analyzer
// Copyright (c) 2026, Parallax Software, Inc.
// 
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
// 
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
// 
// You should have received a copy of the GNU General Public License
// along with this program. If not, see <https://www.gnu.org/licenses/>.
// 
// The origin of this software must not be misrepresented; you must not
// claim that you wrote the original software.
// 
// Altered source versions must be plainly marked as such, and must not be
// misrepresented as being the original software.
// 
// This notice may not be removed or altered from any source distribution.

#pragma once

#include <functional>
#include <utility>

namespace sta {

using FindRootFunc = const std::function<void (double x,
                                                 // Return values.
                                                 double &y,
                                                 double &dy)>;

// first: root estimate; second: true if the search failed.
std::pair<double, bool>
findRoot(const FindRootFunc &func,
         double x1,
         double x2,
         double x_tol,
         int max_iter);

// first: root estimate; second: true if the search failed.
std::pair<double, bool>
findRoot(const FindRootFunc &func,
         double x1,
         double y1,
         double x2,
         double y2,
         double x_tol,
         int max_iter);

} // namespace sta
