Iteration.hpp

Go to the documentation of this file.

 
#pragma once
 
#include <functional>
 
#include "NumCpp/Core/Internal/Error.hpp"
#include "NumCpp/Core/Types.hpp"
 
namespace nc::roots
{
    //================================================================================
    // Class Description:
    class Iteration
    {
    public:
        //============================================================================
        // Method Description:
        explicit Iteration(double epsilon) noexcept :
            epsilon_(epsilon)
        {
        }
 
        //============================================================================
        // Method Description:
        Iteration(double epsilon, uint32 maxNumIterations) noexcept :
            epsilon_(epsilon),
            maxNumIterations_(maxNumIterations)
        {
        }
 
        //============================================================================
        // Method Description:
        virtual ~Iteration() noexcept = default;
 
        //============================================================================
        // Method Description:
        [[nodiscard]] uint32 numIterations() const noexcept
        {
            return numIterations_;
        }
 
    protected:
        //============================================================================
        // Method Description:
        void resetNumberOfIterations() noexcept
        {
            numIterations_ = 0;
        }
 
        //============================================================================
        // Method Description:
        void incrementNumberOfIterations()
        {
            ++numIterations_;
            if (numIterations_ > maxNumIterations_)
            {
                THROW_RUNTIME_ERROR(
                    "Maximum number of iterations has been reached; no root has been found within epsilon.");
            }
        }
 
        //====================================Attributes==============================
        const double epsilon_;
        uint32       maxNumIterations_{ 1000 };
        uint32       numIterations_{ 0 };
    };
} // namespace nc::roots