named_functions.hpp

Go to the documentation of this file.

// SPDX-License-Identifier: BSL-1.0
// SPDX-FileCopyrightText: Copyright (C) 2021 Tobias Hienzsch
 
#ifndef TETL_COMPARE_NAMED_FUNCTIONS_HPP
#define TETL_COMPARE_NAMED_FUNCTIONS_HPP
 
#include <etl/_compare/partial_ordering.hpp>
 
namespace etl {
 
/// \ingroup compare
[[nodiscard]] constexpr auto is_eq(partial_ordering cmp) noexcept -> bool
{
    return cmp == nullptr;
}
 
/// \ingroup compare
[[nodiscard]] constexpr auto is_neq(partial_ordering cmp) noexcept -> bool
{
    return cmp != nullptr;
}
 
/// \ingroup compare
[[nodiscard]] constexpr auto is_lt(partial_ordering cmp) noexcept -> bool
{
    return cmp < nullptr;
}
 
/// \ingroup compare
[[nodiscard]] constexpr auto is_lteq(partial_ordering cmp) noexcept -> bool
{
    return cmp <= nullptr;
}
 
/// \ingroup compare
[[nodiscard]] constexpr auto is_gt(partial_ordering cmp) noexcept -> bool
{
    return cmp > nullptr;
}
 
/// \ingroup compare
[[nodiscard]] constexpr auto is_gteq(partial_ordering cmp) noexcept -> bool
{
    return cmp >= nullptr;
}
 
} // namespace etl
 
#endif // TETL_COMPARE_NAMED_FUNCTIONS_HPP