assert_close.hpp

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2026 Klaus Reimer <k@ailis.de>
// SPDX-License-Identifier: MIT
 
#pragma once
 
#include <format>
#include <optional>
#include <source_location>
#include <string_view>
#include <utility>
 
#include <kaycxx/test/assertion_error.hpp>
#include <kaycxx/test/detail/close.hpp>
#include <kaycxx/test/detail/to_string.hpp>
 
namespace kaycxx::test {
 
template <typename Actual, typename Expected>
requires detail::close_supported<Actual, Expected>
void assert_close(
    Actual const& actual,
    Expected const& expected,
    int precision = 2,
    std::string_view reason = {},
    std::optional<std::source_location> location = std::source_location::current()
) {
    if (!detail::close(actual, expected, precision)) {
        auto actual_string = detail::to_string(actual);
        auto expected_string = detail::to_string(expected);
        auto message = std::format(
            "Expected <{}> to be close to <{}> (precision: {} decimals)",
            actual_string,
            expected_string,
            precision
        );
        throw assertion_error(
            message,
            reason,
            std::move(actual_string),
            std::move(expected_string),
            location
        );
    }
}
 
} // namespace kaycxx::test