Function contract specifiers (since C++26)

Спецификаторы контракта функции (предусловия, обозначаемые с помощью pre и постусловия, обозначаемые с помощью post ) — это спецификаторы, которые могут применяться к декларатору функции или лямбда-выражения для введения утверждения контракта функции соответствующего типа в связанную функцию.

Они гарантируют, что указанное условие выполняется во время исполнения, вызывая нарушение (например, завершение программы) в отладочных сборках, если условие вычисляется в false или вычисление завершается через исключение, и могут игнорироваться в релизных сборках для повышения производительности.

Предусловие

Условие ( pre ) — это предикат, который вызывающая сторона должна гарантировать выполнение до вызова функции или лямбды, проверяемый в отладочных сборках для валидации входных данных или состояния.

Постусловие

Постусловие ( post ) — это предикат, который вызываемый объект должен гарантировать выполнение после завершения функции или лямбды, проверяемый в отладочных сборках для подтверждения вывода или состояния.

Синтаксис

Ключевые слова

pre , post

Примечания

Пример

• Преусловие функции normalize требует от вызывающей стороны передачи нормализуемого вектора.
• Постусловие гарантирует, что функция normalize возвращает нормализованный вектор.

#include <array>
#include <cmath>
#include <concepts>
#include <contracts>
#include <limits>
#include <print>
template <std::floating_point T>
constexpr auto is_normalizable(const std::array<T, 3>& vector) noexcept
{
    const auto& [x, y, z]{vector};
    const auto norm{std::hypot(x, y, z)};
    return std::isfinite(norm) && norm > T {0};
}
template <std::floating_point T>
constexpr auto is_normalized(const std::array<T, 3>& vector) noexcept
{
    const auto& [x, y, z]{vector};
    const auto norm{std::hypot(x, y, z)};
    constexpr auto tolerance{010 * std::numeric_limits<T>::epsilon()};
    if (!is_normalizable(norm)) [[unlikely]]
        return false;
    return std::abs(norm - T{1}) <= tolerance;
}
template <std::floating_point T>
constexpr auto normalize(std::array<T, 3> vector) noexcept -> std::array<T, 3>
    pre(is_normalizable(vector))
    post(vector: is_normalized(vector))
{
    auto& [x, y, z]{vector};
    const auto norm{std::hypot(x, y, z)};
    x /= norm, y /= norm, z /= norm;
    return vector;
}
int main()
{
    const auto v = normalize<float>({0.3, 0.4, 0.5});
    std::println("{}", v);
    const auto w = normalize<float>({0, 0, 0}); // нарушает пред- и пост- условия
    std::println("{}", w);
}

[0.4242641, 0.56568545, 0.70710677]
[-nan, -nan, -nan]

Ссылки

Смотрите также