[latex3-commits] [git/LaTeX3-latex3-latex3] master: Document that the :nNn comparison functions are faster than :n [ci skip] (7d90c3a)

[Bruno Le Floch]

Repository : https://github.com/latex3/latex3
On branch  : master
Link       : https://github.com/latex3/latex3/commit/7d90c3a0ae0c1656916e0cb33a070d005fb93700

>---------------------------------------------------------------

commit 7d90c3a0ae0c1656916e0cb33a070d005fb93700
Author: Bruno Le Floch <bruno at le-floch.fr>
Date:   Fri Mar 8 07:37:30 2019 +0000

    Document that the :nNn comparison functions are faster than :n [ci skip]


>---------------------------------------------------------------

7d90c3a0ae0c1656916e0cb33a070d005fb93700
 l3kernel/l3fp.dtx   |    7 +++++++
 l3kernel/l3int.dtx  |    4 ++++
 l3kernel/l3skip.dtx |    4 ++++
 3 files changed, 15 insertions(+)

diff --git a/l3kernel/l3fp.dtx b/l3kernel/l3fp.dtx
index aa3b0c8..d6991c8 100644
--- a/l3kernel/l3fp.dtx
+++ b/l3kernel/l3fp.dtx
@@ -407,6 +407,10 @@
 %   compare equal (in particular there must be no~\nan{}).
 %   At present any other comparison with tuples yields |?| (not ordered).
 %   This is experimental.
+%
+%   This function is less flexible than \cs{fp_compare:nTF} but slightly
+%   faster.  It is provided for consistency with \cs{int_compare:nNnTF}
+%   and \cs{dim_compare:nNnTF}.
 % \end{function}
 %
 % \begin{function}[EXP, pTF, updated = 2013-12-14,
@@ -455,6 +459,9 @@
 %   does not appear within the \meta{relation}.  Common choices of
 %   \meta{relation} include |>=|~(greater or equal), |!=|~(not equal),
 %   |!?|~or~|<=>| (comparable).
+%
+%   This function is more flexible than \cs{fp_compare:nTF} and only
+%   slightly slower.
 % \end{function}
 %
 % \section{Floating point expression loops}
diff --git a/l3kernel/l3int.dtx b/l3kernel/l3int.dtx
index 577a66a..13209bd 100644
--- a/l3kernel/l3int.dtx
+++ b/l3kernel/l3int.dtx
@@ -333,6 +333,8 @@
 %       Less than             & |<| \\
 %     \end{tabular}
 %   \end{center}
+%   This function is less flexible than \cs{int_compare:nTF} but around
+%   $5$~times faster.
 % \end{function}
 %
 % \begin{function}[updated = 2013-01-13, EXP, pTF]{\int_compare:n}
@@ -375,6 +377,8 @@
 %       Not equal                & |!=|        \\
 %     \end{tabular}
 %   \end{center}
+%   This function is more flexible than \cs{int_compare:nNnTF} but
+%   around $5$~times slower.
 % \end{function}
 %
 % \begin{function}[added = 2013-07-24, EXP, noTF]{\int_case:nn}
diff --git a/l3kernel/l3skip.dtx b/l3kernel/l3skip.dtx
index 1f23ab6..22a0725 100644
--- a/l3kernel/l3skip.dtx
+++ b/l3kernel/l3skip.dtx
@@ -209,6 +209,8 @@
 %       Less than             & |<| \\
 %     \end{tabular}
 %   \end{center}
+%   This function is less flexible than \cs{dim_compare:nTF} but around
+%   $5$~times faster.
 % \end{function}
 %
 % \begin{function}[updated = 2013-01-13, EXP, pTF]{\dim_compare:n}
@@ -252,6 +254,8 @@
 %       Not equal                & |!=|        \\
 %     \end{tabular}
 %   \end{center}
+%   This function is more flexible than \cs{dim_compare:nNnTF} but
+%   around $5$~times slower.
 % \end{function}
 %
 % \begin{function}[added = 2013-07-24, EXP, noTF]{\dim_case:nn}