[libcxx-commits] [libcxx] 497705f - [libc++] Reorganize the documentation of extensions for integral types

Louis Dionne via libcxx-commits libcxx-commits at lists.llvm.org
Wed Aug 10 14:35:14 PDT 2022


Author: Louis Dionne
Date: 2022-08-10T17:35:08-04:00
New Revision: 497705ff27b0216d08722671bc1c37df83b45aa5

URL: https://github.com/llvm/llvm-project/commit/497705ff27b0216d08722671bc1c37df83b45aa5
DIFF: https://github.com/llvm/llvm-project/commit/497705ff27b0216d08722671bc1c37df83b45aa5.diff

LOG: [libc++] Reorganize the documentation of extensions for integral types

Added: 
    

Modified: 
    libcxx/docs/UsingLibcxx.rst

Removed: 
    


################################################################################
diff  --git a/libcxx/docs/UsingLibcxx.rst b/libcxx/docs/UsingLibcxx.rst
index 41d17378a2c3..626f3883883e 100644
--- a/libcxx/docs/UsingLibcxx.rst
+++ b/libcxx/docs/UsingLibcxx.rst
@@ -424,32 +424,30 @@ which no dialect declares as such (See the second form described above).
 * ``to_integer``
 * ``to_underlying``
 
-Additional types supported in random distributions
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-The `C++ Standard <http://eel.is/c++draft/rand#req.genl-1.5>`_ mentions that instantiating several random number
-distributions with types other than ``short``, ``int``, ``long``, ``long long``, and their unsigned versions is
-undefined. As an extension, libc++ supports instantiating ``binomial_distribution``, ``discrete_distribution``,
-``geometric_distribution``, ``negative_binomial_distribution``, ``poisson_distribution``, and ``uniform_int_distribution``
-with ``int8_t``, ``__int128_t`` and their unsigned versions.
-
 Extended integral type support
 ------------------------------
 
-Several platforms support the 128-bit integral types ``__int128_t`` and
-``__uint128_t``. When these types are present they can be used in the headers
-as required by the Standard:
+Several platforms support types that are not specified in the Standard, such as
+the 128-bit integral types ``__int128_t`` and ``__uint128_t``. As an extension,
+libc++ does a best-effort attempt to support these types like other integral
+types, by supporting them notably in:
 
 * ``<bits>``
 * ``<charconv>``
 * ``<functional>``
 * ``<type_traits>``
-
-As an extension these types can be used in the following headers:
-
 * ``<format>``
 * ``<random>``
 
+Additional types supported in random distributions
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The `C++ Standard <http://eel.is/c++draft/rand#req.genl-1.5>`_ mentions that instantiating several random number
+distributions with types other than ``short``, ``int``, ``long``, ``long long``, and their unsigned versions is
+undefined. As an extension, libc++ supports instantiating ``binomial_distribution``, ``discrete_distribution``,
+``geometric_distribution``, ``negative_binomial_distribution``, ``poisson_distribution``, and ``uniform_int_distribution``
+with ``int8_t``, ``__int128_t`` and their unsigned versions.
+
 Extensions to ``<format>``
 --------------------------
 


        


More information about the libcxx-commits mailing list