percentage.hpp

Go to the documentation of this file.

/* SPDX-FileCopyrightText: Copyright (c) 2022-2026 Oğuz Toraman <oguz.toraman@tutanota.com> */
/* SPDX-License-Identifier: LGPL-3.0-only */

 
#ifndef PERCENTAGE_HPP
#define PERCENTAGE_HPP
 
#include <algorithm>
#include <cstdint>
#include <string>
 
namespace Recognition {
namespace Utility {

class Percentage {
public:
    explicit Percentage(int percentage = 0) noexcept
      : m_percentage{std::clamp(percentage, 0, 100)}
    { }

    Percentage(
        std::uint64_t completed_steps,
        std::uint64_t total_steps
    ) noexcept
      : m_percentage{std::clamp(
            static_cast<int>(
                (completed_steps * 100)
                / std::max<std::uint64_t>(total_steps, 1u)
            ),
            0,
            100
        )}
    { }

    [[nodiscard]] int Get() const noexcept
    {
        return m_percentage;
    }

    void Set(int percentage) noexcept
    {
        m_percentage = std::clamp(percentage, 0, 100);
    }

    [[nodiscard]] std::string ToString() const noexcept
    {
        return std::to_string(m_percentage) + "%";
    }
 
private:
    int m_percentage; 
};

} /* namespace Utility */
} /* namespace Recognition */
 
#endif /* PERCENTAGE_HPP */