set_of_chars.h.xml 4.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114
  1. <chapter xml:id="set_of_chars.h">
  2. <title><tt>__vic/set_of_chars.h</tt></title>
  3. <chapter xml:id="set_of_chars">
  4. <title><tt>set_of_chars</tt></title>
  5. <code-block lang="C++"><![CDATA[
  6. class set_of_chars
  7. {
  8. public:
  9. constexpr set_of_chars();
  10. template<class Iter> constexpr set_of_chars(Iter begin, Iter end);
  11. constexpr set_of_chars(std::initializer_list<char> set); // C++11
  12. constexpr set_of_chars(const char *c_str);
  13. constexpr bool contains(char ch) const;
  14. constexpr void add(char ch);
  15. constexpr void remove(char ch);
  16. template<class Iter> constexpr void add(Iter begin, Iter end);
  17. constexpr void add(const char *c_str);
  18. constexpr void add(std::initializer_list<char> set); // C++11
  19. template<class Iter> void assign(Iter begin, Iter end);
  20. void assign(const char *c_str)
  21. void assign(std::initializer_list<char> set); // C++11
  22. void clear();
  23. };
  24. ]]></code-block>
  25. <p>Компактная (всего 32 байта) и очень быстрая реализация множества символов.
  26. Операция <tt>contains()</tt> всегда выполняется за константное время, независимо
  27. от аргумента и количества элементов во множестве.</p>
  28. <section><title>Члены класса</title>
  29. <synopsis>
  30. <prototype>constexpr set_of_chars()</prototype>
  31. <p>Создаёт пустое множество.</p>
  32. <postcondition><tt>contains(char(ch)) == false</tt> для любого символа
  33. </postcondition>
  34. </synopsis>
  35. <synopsis>
  36. <prototype>template&lt;class Iter> constexpr set_of_chars(Iter begin, Iter end)</prototype>
  37. <prototype>constexpr set_of_chars(std::initializer_list&lt;char> set) <sign>C++11</sign></prototype>
  38. <p>Создаёт множество, заполненное символами из указанного диапазона значений.
  39. </p>
  40. <note><tt>constexpr</tt> только начиная с C++14!</note>
  41. </synopsis>
  42. <synopsis>
  43. <prototype>constexpr set_of_chars(const char *c_str)</prototype>
  44. <p>Создаёт множество, заполненное символами указанной C-строки, исключая
  45. нулевой терминатор.</p>
  46. <note><tt>constexpr</tt> только начиная с C++14!</note>
  47. </synopsis>
  48. <synopsis>
  49. <prototype>bool contains(char ch) const</prototype>
  50. <p>Проверяет, содержит ли множество <tt>ch</tt>.</p>
  51. </synopsis>
  52. <synopsis>
  53. <prototype>constexpr void add(char ch)</prototype>
  54. <p>Добавляет <tt>ch</tt> во множество.</p>
  55. <postcondition><tt>contains(ch) == true</tt></postcondition>
  56. <note><tt>constexpr</tt> только начиная с C++14!</note>
  57. </synopsis>
  58. <synopsis>
  59. <prototype>constexpr void remove(char ch)</prototype>
  60. <p>Удаляет <tt>ch</tt> из множества.</p>
  61. <postcondition><tt>contains(ch) == false</tt></postcondition>
  62. <note><tt>constexpr</tt> только начиная с C++14!</note>
  63. </synopsis>
  64. <synopsis>
  65. <prototype>template&lt;class Iter> constexpr void add(Iter begin, Iter end)</prototype>
  66. <prototype>constexpr void add(std::initializer_list&lt;char> set) <sign>C++11</sign></prototype>
  67. <p>Вызывает <tt>add(ch)</tt> для каждого значения из диапазона.</p>
  68. <note><tt>constexpr</tt> только начиная с C++14!</note>
  69. </synopsis>
  70. <synopsis>
  71. <prototype>constexpr void add(const char *c_str)</prototype>
  72. <p>Вызывает <tt>add(ch)</tt> для каждого символа C-строки, исключая нулевой
  73. терминатор.</p>
  74. <note><tt>constexpr</tt> только начиная с C++14!</note>
  75. </synopsis>
  76. <synopsis>
  77. <prototype>template&lt;class Iter> void assign(Iter begin, Iter end)</prototype>
  78. <prototype>void assign(const char *c_str)</prototype>
  79. <prototype>void assign(std::initializer_list&lt;char> set) <sign>C++11</sign></prototype>
  80. <p>Вызывает <tt>clear()</tt>, затем <tt>add()</tt> с указанными параметрами.
  81. </p>
  82. </synopsis>
  83. <synopsis>
  84. <prototype>void clear()</prototype>
  85. <p>Удаляет все элементы из множества.</p>
  86. <postcondition><tt>contains(char(ch)) == false</tt> для любого символа
  87. </postcondition>
  88. </synopsis>
  89. </section>
  90. </chapter>
  91. </chapter>