From 0ef068c92b9c513b70ce57e4796aedf1810e26cb Mon Sep 17 00:00:00 2001 From: Bolero-MURAKAMI Date: Thu, 5 Sep 2013 15:31:02 +0900 Subject: [PATCH] add doc: char_traits integer type operations --- docs/_sources/libs/string/char_traits/eof.txt | 39 ++++ .../libs/string/char_traits/eq_int_type.txt | 40 ++++ .../libs/string/char_traits/index.txt | 7 +- .../libs/string/char_traits/not_eof.txt | 39 ++++ .../libs/string/char_traits/to_char_type.txt | 40 ++++ .../libs/string/char_traits/to_int_type.txt | 40 ++++ .../libs/string/basic_string/swap-global.html | 10 +- .../string/char_traits/assign-string.html | 10 +- docs/libs/string/char_traits/assign.html | 10 +- docs/libs/string/char_traits/eof.html | 179 +++++++++++++++++ docs/libs/string/char_traits/eq.html | 33 +++- docs/libs/string/char_traits/eq_int_type.html | 180 ++++++++++++++++++ docs/libs/string/char_traits/index.html | 10 +- docs/libs/string/char_traits/lt.html | 10 +- docs/libs/string/char_traits/not_eof.html | 179 +++++++++++++++++ .../libs/string/char_traits/to_char_type.html | 180 ++++++++++++++++++ docs/libs/string/char_traits/to_int_type.html | 180 ++++++++++++++++++ docs/searchindex.js | 2 +- source/libs/string/char_traits/eof.rst | 39 ++++ .../libs/string/char_traits/eq_int_type.rst | 40 ++++ source/libs/string/char_traits/index.rst | 7 +- source/libs/string/char_traits/not_eof.rst | 39 ++++ .../libs/string/char_traits/to_char_type.rst | 40 ++++ .../libs/string/char_traits/to_int_type.rst | 40 ++++ 24 files changed, 1362 insertions(+), 31 deletions(-) create mode 100644 docs/_sources/libs/string/char_traits/eof.txt create mode 100644 docs/_sources/libs/string/char_traits/eq_int_type.txt create mode 100644 docs/_sources/libs/string/char_traits/not_eof.txt create mode 100644 docs/_sources/libs/string/char_traits/to_char_type.txt create mode 100644 docs/_sources/libs/string/char_traits/to_int_type.txt create mode 100644 docs/libs/string/char_traits/eof.html create mode 100644 docs/libs/string/char_traits/eq_int_type.html create mode 100644 docs/libs/string/char_traits/not_eof.html create mode 100644 docs/libs/string/char_traits/to_char_type.html create mode 100644 docs/libs/string/char_traits/to_int_type.html create mode 100644 source/libs/string/char_traits/eof.rst create mode 100644 source/libs/string/char_traits/eq_int_type.rst create mode 100644 source/libs/string/char_traits/not_eof.rst create mode 100644 source/libs/string/char_traits/to_char_type.rst create mode 100644 source/libs/string/char_traits/to_int_type.rst diff --git a/docs/_sources/libs/string/char_traits/eof.txt b/docs/_sources/libs/string/char_traits/eof.txt new file mode 100644 index 00000000..477eecb0 --- /dev/null +++ b/docs/_sources/libs/string/char_traits/eof.txt @@ -0,0 +1,39 @@ +.. _sprout-string-char_traits-eof: +############################################################################### +eof +############################################################################### + +Interface +======================================== +.. sourcecode:: c++ + + static SPROUT_CONSTEXPR int_type eof() SPROUT_NOEXCEPT; + +Effects +======================================== + +| Equivalent to ``std::char_traits::eof()``. + +Examples +======================================== +.. sourcecode:: c++ + + #include + #include + using namespace sprout; + + SPROUT_STATIC_CONSTEXPR char x = char_traits::eof(); + static_assert(x == EOF, "x is equivalent to EOF."); + +Complexity +======================================== + +| constant. +| Recursive function invocations in *O(1)* (constant) depth. + +Header +======================================== + +| ``sprout/string/char_traits.hpp`` +| Convenience header: ``sprout/string.hpp`` + diff --git a/docs/_sources/libs/string/char_traits/eq_int_type.txt b/docs/_sources/libs/string/char_traits/eq_int_type.txt new file mode 100644 index 00000000..db4295cb --- /dev/null +++ b/docs/_sources/libs/string/char_traits/eq_int_type.txt @@ -0,0 +1,40 @@ +.. _sprout-string-char_traits-eq_int_type: +############################################################################### +eq_int_type +############################################################################### + +Interface +======================================== +.. sourcecode:: c++ + + static SPROUT_CONSTEXPR bool eq_int_type(int_type c1, int_type c2) SPROUT_NOEXCEPT; + +Effects +======================================== + +| Equivalent to ``std::char_traits::eq_int_type(c1, c2)``. + +Examples +======================================== +.. sourcecode:: c++ + + #include + using namespace sprout; + + SPROUT_STATIC_CONSTEXPR int x = 'H'; + SPROUT_STATIC_CONSTEXPR int y = 'H'; + SPROUT_STATIC_CONSTEXPR auto result = char_traits::eq_int_type(x, y); + static_assert(result, "x is equal to y."); + +Complexity +======================================== + +| constant. +| Recursive function invocations in *O(1)* (constant) depth. + +Header +======================================== + +| ``sprout/string/char_traits.hpp`` +| Convenience header: ``sprout/string.hpp`` + diff --git a/docs/_sources/libs/string/char_traits/index.txt b/docs/_sources/libs/string/char_traits/index.txt index 7067128c..ccfbf3ec 100644 --- a/docs/_sources/libs/string/char_traits/index.txt +++ b/docs/_sources/libs/string/char_traits/index.txt @@ -7,7 +7,7 @@ char_traits :hidden: assign - rq + eq lt compare length @@ -15,6 +15,11 @@ char_traits move copy assign-string + not_eof + to_char_type + to_int_type + eq_int_type + eof Interface ======================================== diff --git a/docs/_sources/libs/string/char_traits/not_eof.txt b/docs/_sources/libs/string/char_traits/not_eof.txt new file mode 100644 index 00000000..b0ff2979 --- /dev/null +++ b/docs/_sources/libs/string/char_traits/not_eof.txt @@ -0,0 +1,39 @@ +.. _sprout-string-char_traits-not_eof: +############################################################################### +not_eof +############################################################################### + +Interface +======================================== +.. sourcecode:: c++ + + static SPROUT_CONSTEXPR int_type not_eof(int_type c) SPROUT_NOEXCEPT; + +Effects +======================================== + +| Equivalent to ``std::char_traits::not_eof(c)``. + +Examples +======================================== +.. sourcecode:: c++ + + #include + using namespace sprout; + + SPROUT_STATIC_CONSTEXPR char x = 'H'; + SPROUT_STATIC_CONSTEXPR auto result = char_traits::not_eof(x); + static_assert(result, "x is not EOF."); + +Complexity +======================================== + +| constant. +| Recursive function invocations in *O(1)* (constant) depth. + +Header +======================================== + +| ``sprout/string/char_traits.hpp`` +| Convenience header: ``sprout/string.hpp`` + diff --git a/docs/_sources/libs/string/char_traits/to_char_type.txt b/docs/_sources/libs/string/char_traits/to_char_type.txt new file mode 100644 index 00000000..fbd07a16 --- /dev/null +++ b/docs/_sources/libs/string/char_traits/to_char_type.txt @@ -0,0 +1,40 @@ +.. _sprout-string-char_traits-to_char_type: +############################################################################### +to_char_type +############################################################################### + +Interface +======================================== +.. sourcecode:: c++ + + static SPROUT_CONSTEXPR char_type to_char_type(int_type c) SPROUT_NOEXCEPT; + +Effects +======================================== + +| Equivalent to ``std::char_traits::to_char_type(c)``. + +Examples +======================================== +.. sourcecode:: c++ + + #include + using namespace sprout; + + SPROUT_STATIC_CONSTEXPR int x = 'H'; + SPROUT_STATIC_CONSTEXPR auto y = char_traits::to_char_type(x); + SPROUT_STATIC_CONSTEXPR auto result = char_traits::to_int_type(y); + static_assert(char_traits::eq_int_type(result, x), "a value that converted from x to char type and re-converted to int type is equal to the original x."); + +Complexity +======================================== + +| constant. +| Recursive function invocations in *O(1)* (constant) depth. + +Header +======================================== + +| ``sprout/string/char_traits.hpp`` +| Convenience header: ``sprout/string.hpp`` + diff --git a/docs/_sources/libs/string/char_traits/to_int_type.txt b/docs/_sources/libs/string/char_traits/to_int_type.txt new file mode 100644 index 00000000..4fdb0a36 --- /dev/null +++ b/docs/_sources/libs/string/char_traits/to_int_type.txt @@ -0,0 +1,40 @@ +.. _sprout-string-char_traits-to_int_type: +############################################################################### +to_int_type +############################################################################### + +Interface +======================================== +.. sourcecode:: c++ + + static SPROUT_CONSTEXPR int_type to_int_type(char_type c) SPROUT_NOEXCEPT; + +Effects +======================================== + +| Equivalent to ``std::char_traits::to_int_type(c)``. + +Examples +======================================== +.. sourcecode:: c++ + + #include + using namespace sprout; + + SPROUT_STATIC_CONSTEXPR int x = 'H'; + SPROUT_STATIC_CONSTEXPR auto y = char_traits::to_char_type(x); + SPROUT_STATIC_CONSTEXPR auto result = char_traits::to_int_type(y); + static_assert(char_traits::eq_int_type(result, x), "a value that converted from x to char type and re-converted to int type is equal to the original x."); + +Complexity +======================================== + +| constant. +| Recursive function invocations in *O(1)* (constant) depth. + +Header +======================================== + +| ``sprout/string/char_traits.hpp`` +| Convenience header: ``sprout/string.hpp`` + diff --git a/docs/libs/string/basic_string/swap-global.html b/docs/libs/string/basic_string/swap-global.html index 9eaed588..b21063c6 100644 --- a/docs/libs/string/basic_string/swap-global.html +++ b/docs/libs/string/basic_string/swap-global.html @@ -39,7 +39,7 @@ - +
@@ -62,6 +74,12 @@ +

Previous topic

+

assign

+

Next topic

+

lt

This Page