libdpf/include/grotto/gadgets/elementary/zero.hpp

/// @file grotto/gadgets/elementary/zero.hpp
/// @author Ryan Henry <ryan.henry@ucalgary.ca>
/// @brief Cleartext reference for `zero`.
/// @copyright Copyright (c) 2019-2023 Ryan Henry and others
/// @license Released under a GNU General Public v2.0 (GPLv2) license;
///          see [LICENSE.md](@ref license) for details.

#ifndef LIBDPF_INCLUDE_GROTTO_GADGETS_ELEMENTARY_ZERO_HPP__
#define LIBDPF_INCLUDE_GROTTO_GADGETS_ELEMENTARY_ZERO_HPP__

#include "eq.hpp"

namespace grotto
{

namespace gadgets
{

static constexpr double eq_target_zero = 0;
/// @brief Alias of another cleartext functor, under the name `zero`.
/// @see grotto::exact_constant
/// \complexity Same as the functor it aliases: one straight-line `operator()`. `Θ(1)`.
using zero HEDLEY_DEPRECATED_FOR(2026, grotto::exact_constant) = eq<eq_target_zero>;

}  // namespace gadgets

}  // namespace grotto

#endif  // LIBDPF_INCLUDE_GROTTO_GADGETS_ELEMENTARY_ZERO_HPP__