ah-concepts.H

Go to the documentation of this file.

 
/*
                          Aleph_w
 
  Data structures & Algorithms
  version 2.0.0b
  https://github.com/lrleon/Aleph-w
 
  This file is part of Aleph-w library
 
  Copyright (c) 2002-2026 Leandro Rabindranath Leon
 
  Permission is hereby granted, free of charge, to any person obtaining a copy
  of this software and associated documentation files (the "Software"), to deal
  in the Software without restriction, including without limitation the rights
  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  copies of the Software, and to permit persons to whom the Software is
  furnished to do so, subject to the following conditions:
 
  The above copyright notice and this permission notice shall be included in all
  copies or substantial portions of the Software.
 
  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  SOFTWARE.
*/
 
 
# ifndef AH_CONCEPTS_H
# define AH_CONCEPTS_H
 
# include <concepts>
# include <type_traits>
# include <cstddef>
# include <functional>
# include <utility>
 
namespace Aleph
{
  template <typename F, typename T>
  concept BinaryPredicate =
      requires(const F & f, const T & a, const T & b)
        {
          { f(a, b) } -> std::convertible_to<bool>;
        };
 
  template <typename F, typename T>
  concept StrictWeakOrder =
      std::strict_weak_order<F, T, T> and
      std::strict_weak_order<const F &, const T &, const T &>;
 
  template <typename F, typename T>
  concept EqualityComparator =
      std::equivalence_relation<F, T, T> and
      std::equivalence_relation<const F &, const T &, const T &>;
 
  template <typename T, typename Key>
  concept BSTPolicy =
      requires { typename T::Node; } and
      requires(T & t, T & t2, const T & ct,
               typename T::Node * p, const Key & key)
        {
          { t.getRoot() } -> std::convertible_to<typename T::Node *>;
          { t.search(key) } -> std::convertible_to<typename T::Node *>;
          { t.search_or_insert(p) } -> std::convertible_to<typename T::Node *>;
          { t.insert_dup(p) } -> std::convertible_to<typename T::Node *>;
          { t.remove(key) } -> std::convertible_to<typename T::Node *>;
          { ct.verify() } -> std::convertible_to<bool>;
          { t.swap(t2) };
          { t.get_compare() };
          requires not requires { ct.getRoot(); } or requires {
            { ct.getRoot() } -> std::convertible_to<const typename T::Node *>;
          };
          requires (not requires { ct.search(key); } or
                    requires
                    {
                      { ct.search(key) } -> std::convertible_to<const typename T::Node *>;
                    });
        };
 
  template <typename T>
  concept AlephArrayConvertible = requires(T c)
    {
      typename T::Item_Type;
      { c.get_it() };
    };
 
  template <typename C>
  concept AlephSequentialContainer =
      requires { typename C::Item_Type; } and
      requires(C & c, const C & cc, const typename C::Item_Type & val)
        {
          { cc.size()     } -> std::convertible_to<std::size_t>;
          { cc.is_empty() } -> std::convertible_to<bool>;
          c.append(val);
        } and
      // mutable_for_each must accept a void(Item_Type&) callable
      requires(C & c)
        {
          c.mutable_for_each([](typename C::Item_Type &) {});
        };
 
  template <typename C>
  concept AlephSequentialIterableContainer =
      AlephSequentialContainer<C> and
      requires(const C & cc)
        {
          cc.get_it();
        };
 
  template <typename It>
  concept AlephIterator =
      requires(It & it)
        {
          static_cast<bool>(it.has_curr());
          it.get_curr();
          it.next_ne();
        };
 
  template <typename C>
  concept AlephIterable =
      requires
        {
          typename C::Item_Type;
          typename C::Iterator;
        } and
      AlephIterator<typename C::Iterator> and
      std::constructible_from<typename C::Iterator, const C &>;
 
  template <typename C>
  concept AlephTraversable =
      requires { typename C::Item_Type; } and
      requires(C & c, bool (&op)(const typename C::Item_Type &))
        {
          { c.traverse(op) } -> std::convertible_to<bool>;
        };
 
  template <typename C>
  concept AlephIterableContainer =
      AlephTraversable<C> and
      AlephIterable<C> and
      requires(const C & cc)
        {
          { cc.size() } -> std::convertible_to<std::size_t>;
          { cc.is_empty() } -> std::convertible_to<bool>;
        };
 
  template <typename C>
  concept AlephSequence =
      AlephIterableContainer<C> and
      requires(C & c, const typename C::Item_Type & v)
        {
          c.append(v);
        };
 
  template <typename C>
  concept StlIterableContainer =
      requires(const C & c)
        {
          c.begin();
          c.end();
          typename C::value_type;
        };
 
  template <typename T>
  concept IntegerSortableValue =
      std::is_integral_v<std::remove_cv_t<T>> and
      not std::is_same_v<std::remove_cv_t<T>, bool>;
 
  template <typename T>
  concept ArrayStorable = std::default_initializable<T> and std::movable<T>;
 
  template <typename F, typename T>
  concept ClosedBinaryOp =
      requires(const F & f, const T & a, const T & b)
        {
          { f(a, b) } -> std::convertible_to<T>;
        };
 
  template <typename M, typename T>
  concept StaticMonoid =
      requires(const T & a, const T & b)
        {
          { M::identity() } -> std::convertible_to<T>;
          { M::combine(a, b) } -> std::convertible_to<T>;
        };
 
  template <typename F, typename... Args>
  concept CallableWith =
      requires(F && f, Args &&... args)
        {
          std::forward<F>(f)(std::forward<Args>(args)...);
        };
 
  template <typename F, typename... Args>
  concept PredicateWith =
      CallableWith<F, Args...> and
      requires(F && f, Args &&... args)
        {
          static_cast<bool>(std::forward<F>(f)(std::forward<Args>(args)...));
        };
 
  namespace concepts_detail
  {
    template <class N>
    concept BinNodeLikeImpl =
        requires
          {
            typename N::key_type;
            { N::NullPtr } -> std::convertible_to<N *>;
          } and
        requires(N * p)
          {
            { p->getL() } -> std::same_as<N *&>;
            { p->getR() } -> std::same_as<N *&>;
            { p->get_key() } -> std::convertible_to<typename N::key_type &>;
          };
  } // namespace concepts_detail
 
  template <class Node>
  concept BinNodeLike = concepts_detail::BinNodeLikeImpl<std::remove_cv_t<Node>>;
 
  template <class Node>
  concept RankedBinNodeLike =
      BinNodeLike<Node> and
      requires(std::remove_cv_t<Node> * p)
        {
          { p->getCount() } -> std::convertible_to<std::size_t>;
        };
 
  namespace concepts_detail
  {
    template <class T, class Deferred>
    struct defer
    {
      using type = T;
    };
 
    template <class Container, class Deferred>
    struct traverse_arg
    {
      using type = decltype(std::declval<typename defer<Container, Deferred>::type::Iterator &>().get_curr());
    };
 
    template <class Sig>
    struct invoke_as;
 
    template <class R, class... A>
    struct invoke_as<R(A...)>
    {
      template <class F>
      static R call(F & f, A... a)
      {
        if constexpr (std::is_void_v<R>)
          std::invoke(f, std::forward<A>(a)...);
        else
          return std::invoke(f, std::forward<A>(a)...);
      }
    };
  } // namespace concepts_detail
 
} // namespace Aleph
 
# endif // AH_CONCEPTS_H