bump version to 12.2.2-pve1

[ceph.git] / ceph / src / boost / libs / metaparse / doc / is_letter.qbk

[#is_letter]
[section is_letter]

[h1 Synopsis]

  namespace util
  {
    template <class C>
    struct is_letter;
  }

This is a [link lazy_metafunction lazy template metafunction] that supports
[link currying currying].

[table Arguments
  [[Name] [Type]]
  [[`C`]  [[link boxed_value boxed] character value]]
]

[h1 Description]

Checks if `C` is a letter. Returns a boxed boolean value.

[h1 Header]

  #include <boost/metaparse/util/is_letter.hpp>

[h1 Expression semantics]

The following expressions are equivalent:

  is_letter<>::apply<boost::mpl::char_<'a'>>::type
  boost::mpl::true_

  is_letter<>::apply<boost::mpl::char_<'z'>>::type
  boost::mpl::true_

  is_letter<>::apply<boost::mpl::char_<'A'>>::type
  boost::mpl::true_

  is_letter<>::apply<boost::mpl::char_<'Z'>>::type
  boost::mpl::true_

  is_letter<>::apply<c>::type
  boost::mpl::false_

[h1 Example]

  #include <boost/metaparse/util/is_letter.hpp>
  
  #include <type_traits>
  
  using namespace boost::metaparse;
  
  struct returns_char
  {
    using type = std::integral_constant<char, 'A'>;
  };
  
  static_assert(
    util::is_letter<std::integral_constant<char, 'A'>>::type::value,
    "A should be a letter"
  );
  
  static_assert(
    !util::is_letter<std::integral_constant<char, '0'>>::type::value,
    "a number should not be a letter"
  );
  
  static_assert(
    util::is_letter<>::type
      ::apply<std::integral_constant<char, 'A'>>::type::value,
    "it should support currying"
  );
  
  static_assert(
    util::is_letter<returns_char>::type::value,
    "it should support lazy evaluation"
  );

[endsect]