1berry/qtbase
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

QPartialOrdering: update docs and change parameter names

Browse Source 
Let's be more explicit with QPartialOrdering's showcase of its
functionality in the docs and define a possible function-declaration.
Also change all parameter names to lhs and rhs, respectively.

Pick-to: 6.5 6.2 5.15
Change-Id: Ibc5c0b418bff3278e10e415c7f5bfa86227fc066
Reviewed-by: Marc Mutz <marc.mutz@qt.io>
This commit is contained in:
Dennis Oberst 2023-05-10 12:05:56 +02:00
parent 4dd9a27640
commit 15eca98214
2 changed files with 84 additions and 56 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

81
src/corelib/global/qcompare.h
View File

@ -41,36 +41,61 @@ public:
static const QPartialOrdering Greater; static const QPartialOrdering Greater;
static const QPartialOrdering Unordered; static const QPartialOrdering Unordered;
friend constexpr bool operator==(QPartialOrdering p, QtPrivate::CompareAgainstLiteralZero) noexcept friend constexpr bool operator==(QPartialOrdering lhs,
{ return p.isOrdered() && p.m_order == 0; } QtPrivate::CompareAgainstLiteralZero) noexcept
friend constexpr bool operator!=(QPartialOrdering p, QtPrivate::CompareAgainstLiteralZero) noexcept { return lhs.isOrdered() && lhs.m_order == 0; }
{ return p.isOrdered() && p.m_order != 0; }
friend constexpr bool operator< (QPartialOrdering p, QtPrivate::CompareAgainstLiteralZero) noexcept
{ return p.isOrdered() && p.m_order < 0; }
friend constexpr bool operator<=(QPartialOrdering p, QtPrivate::CompareAgainstLiteralZero) noexcept
{ return p.isOrdered() && p.m_order <= 0; }
friend constexpr bool operator> (QPartialOrdering p, QtPrivate::CompareAgainstLiteralZero) noexcept
{ return p.isOrdered() && p.m_order > 0; }
friend constexpr bool operator>=(QPartialOrdering p, QtPrivate::CompareAgainstLiteralZero) noexcept
{ return p.isOrdered() && p.m_order >= 0; }
friend constexpr bool operator==(QtPrivate::CompareAgainstLiteralZero, QPartialOrdering p) noexcept friend constexpr bool operator!=(QPartialOrdering lhs,
{ return p.isOrdered() && 0 == p.m_order; } QtPrivate::CompareAgainstLiteralZero) noexcept
friend constexpr bool operator!=(QtPrivate::CompareAgainstLiteralZero, QPartialOrdering p) noexcept { return lhs.isOrdered() && lhs.m_order != 0; }
{ return p.isOrdered() && 0 != p.m_order; }
friend constexpr bool operator< (QtPrivate::CompareAgainstLiteralZero, QPartialOrdering p) noexcept
{ return p.isOrdered() && 0 < p.m_order; }
friend constexpr bool operator<=(QtPrivate::CompareAgainstLiteralZero, QPartialOrdering p) noexcept
{ return p.isOrdered() && 0 <= p.m_order; }
friend constexpr bool operator> (QtPrivate::CompareAgainstLiteralZero, QPartialOrdering p) noexcept
{ return p.isOrdered() && 0 > p.m_order; }
friend constexpr bool operator>=(QtPrivate::CompareAgainstLiteralZero, QPartialOrdering p) noexcept
{ return p.isOrdered() && 0 >= p.m_order; }
friend constexpr bool operator==(QPartialOrdering p1, QPartialOrdering p2) noexcept friend constexpr bool operator< (QPartialOrdering lhs,
{ return p1.m_order == p2.m_order; } QtPrivate::CompareAgainstLiteralZero) noexcept
friend constexpr bool operator!=(QPartialOrdering p1, QPartialOrdering p2) noexcept { return lhs.isOrdered() && lhs.m_order < 0; }
{ return p1.m_order != p2.m_order; }
friend constexpr bool operator<=(QPartialOrdering lhs,
QtPrivate::CompareAgainstLiteralZero) noexcept
{ return lhs.isOrdered() && lhs.m_order <= 0; }
friend constexpr bool operator> (QPartialOrdering lhs,
QtPrivate::CompareAgainstLiteralZero) noexcept
{ return lhs.isOrdered() && lhs.m_order > 0; }
friend constexpr bool operator>=(QPartialOrdering lhs,
QtPrivate::CompareAgainstLiteralZero) noexcept
{ return lhs.isOrdered() && lhs.m_order >= 0; }
friend constexpr bool operator==(QtPrivate::CompareAgainstLiteralZero,
QPartialOrdering rhs) noexcept
{ return rhs.isOrdered() && 0 == rhs.m_order; }
friend constexpr bool operator!=(QtPrivate::CompareAgainstLiteralZero,
QPartialOrdering rhs) noexcept
{ return rhs.isOrdered() && 0 != rhs.m_order; }
friend constexpr bool operator< (QtPrivate::CompareAgainstLiteralZero,
QPartialOrdering rhs) noexcept
{ return rhs.isOrdered() && 0 < rhs.m_order; }
friend constexpr bool operator<=(QtPrivate::CompareAgainstLiteralZero,
QPartialOrdering rhs) noexcept
{ return rhs.isOrdered() && 0 <= rhs.m_order; }
friend constexpr bool operator> (QtPrivate::CompareAgainstLiteralZero,
QPartialOrdering rhs) noexcept
{ return rhs.isOrdered() && 0 > rhs.m_order; }
friend constexpr bool operator>=(QtPrivate::CompareAgainstLiteralZero,
QPartialOrdering rhs) noexcept
{ return rhs.isOrdered() && 0 >= rhs.m_order; }
friend constexpr bool operator==(QPartialOrdering lhs, QPartialOrdering rhs) noexcept
{ return lhs.m_order == rhs.m_order; }
friend constexpr bool operator!=(QPartialOrdering lhs, QPartialOrdering rhs) noexcept
{ return lhs.m_order != rhs.m_order; }
private: private:
constexpr explicit QPartialOrdering(QtPrivate::Ordering order) noexcept constexpr explicit QPartialOrdering(QtPrivate::Ordering order) noexcept

59
src/corelib/global/qcompare.qdoc
View File

@ -18,19 +18,14 @@
represented by the following four static values: represented by the following four static values:
\list \list
\li \c QPartialOrdering::Less represents that the first object is \li \c QPartialOrdering::Less represents that the first object is
less than the second; less than the second;
\li \c QPartialOrdering::Equivalent represents that the first \li \c QPartialOrdering::Equivalent represents that the first
object is equivalent to the second; object is equivalent to the second;
\li \c QPartialOrdering::Greater represents that the first object \li \c QPartialOrdering::Greater represents that the first object
is greater than the second; is greater than the second;
\li \c QPartialOrdering::Unordered represents that the first object \li \c QPartialOrdering::Unordered represents that the first object
is \e{not ordered} with respect to the second. is \e{not ordered} with respect to the second.
\endlist \endlist
QPartialOrdering is idiomatically used by comparing an instance QPartialOrdering is idiomatically used by comparing an instance
@ -38,14 +33,18 @@
\code \code
// given a, b, c, d as objects of some type that allows for a 3-way compare // given a, b, c, d as objects of some type that allows for a 3-way compare,
// and a compare function declared as follows:
QPartialOrdering result = a.compare(b); QPartialOrdering compare(T lhs, T rhs); // defined out-of-line
~~~
QPartialOrdering result = compare(a, b);
if (result < 0) { if (result < 0) {
// a is less than b // a is less than b
} }
if (c.compare(d) >= 0) { if (compare(c, d) >= 0) {
// c is greater than or equal to d // c is greater than or equal to d
} }
@ -56,58 +55,62 @@
*/ */
/*! /*!
\fn bool QPartialOrdering::operator==(QPartialOrdering p1, QPartialOrdering p2) noexcept \fn bool QPartialOrdering::operator==(QPartialOrdering lhs, QPartialOrdering rhs)
Return true if \a p1 and \a p2 represent the same result; Return true if \a lhs and \a rhs represent the same result;
otherwise, returns false. otherwise, returns false.
*/ */
/*! /*!
\fn bool QPartialOrdering::operator!=(QPartialOrdering p1, QPartialOrdering p2) noexcept \fn bool QPartialOrdering::operator!=(QPartialOrdering lhs, QPartialOrdering rhs)
Return true if \a p1 and \a p2 represent different results; Return true if \a lhs and \a rhs represent different results;
otherwise, returns true. otherwise, returns true.
*/ */
/*! /*!
\fn bool operator==(QPartialOrdering p, QtPrivate::CompareAgainstLiteralZero) noexcept \fn bool operator==(QPartialOrdering lhs, QtPrivate::CompareAgainstLiteralZero)
\fn bool operator!=(QPartialOrdering p, QtPrivate::CompareAgainstLiteralZero) noexcept \fn bool operator!=(QPartialOrdering lhs, QtPrivate::CompareAgainstLiteralZero)
\fn bool operator< (QPartialOrdering p, QtPrivate::CompareAgainstLiteralZero) noexcept \fn bool operator< (QPartialOrdering lhs, QtPrivate::CompareAgainstLiteralZero)
\fn bool operator<=(QPartialOrdering p, QtPrivate::CompareAgainstLiteralZero) noexcept \fn bool operator<=(QPartialOrdering lhs, QtPrivate::CompareAgainstLiteralZero)
\fn bool operator> (QPartialOrdering p, QtPrivate::CompareAgainstLiteralZero) noexcept \fn bool operator> (QPartialOrdering lhs, QtPrivate::CompareAgainstLiteralZero)
\fn bool operator>=(QPartialOrdering p, QtPrivate::CompareAgainstLiteralZero) noexcept \fn bool operator>=(QPartialOrdering lhs, QtPrivate::CompareAgainstLiteralZero)
\fn bool operator==(QtPrivate::CompareAgainstLiteralZero, QPartialOrdering p) noexcept \fn bool operator==(QtPrivate::CompareAgainstLiteralZero, QPartialOrdering rhs)
\fn bool operator!=(QtPrivate::CompareAgainstLiteralZero, QPartialOrdering p) noexcept \fn bool operator!=(QtPrivate::CompareAgainstLiteralZero, QPartialOrdering rhs)
\fn bool operator< (QtPrivate::CompareAgainstLiteralZero, QPartialOrdering p) noexcept \fn bool operator< (QtPrivate::CompareAgainstLiteralZero, QPartialOrdering rhs)
\fn bool operator<=(QtPrivate::CompareAgainstLiteralZero, QPartialOrdering p) noexcept \fn bool operator<=(QtPrivate::CompareAgainstLiteralZero, QPartialOrdering rhs)
\fn bool operator> (QtPrivate::CompareAgainstLiteralZero, QPartialOrdering p) noexcept \fn bool operator> (QtPrivate::CompareAgainstLiteralZero, QPartialOrdering rhs)
\fn bool operator>=(QtPrivate::CompareAgainstLiteralZero, QPartialOrdering p) noexcept \fn bool operator>=(QtPrivate::CompareAgainstLiteralZero, QPartialOrdering rhs)
\relates QPartialOrdering \relates QPartialOrdering
\internal \internal
*/ */
/*! /*!
\variable QPartialOrdering::Less \variable QPartialOrdering::Less
Represents the result of a comparison where the value on the left Represents the result of a comparison where the value on the left
hand side is less than the value on right hand side. hand side is less than the value on the right hand side.
*/ */
/*! /*!
\variable QPartialOrdering::Equivalent \variable QPartialOrdering::Equivalent
Represents the result of a comparison where the value on the left Represents the result of a comparison where the value on the left
hand side is equivalent to the value on right hand side. hand side is equivalent to the value on the right hand side.
*/ */
/*! /*!
\variable QPartialOrdering::Greater \variable QPartialOrdering::Greater
Represents the result of a comparison where the value on the left Represents the result of a comparison where the value on the left
hand side is greater than the value on right hand side. hand side is greater than the value on the right hand side.
*/ */
/*! /*!
\variable QPartialOrdering::Unordered \variable QPartialOrdering::Unordered
Represents the result of a comparison where the value on the left Represents the result of a comparison where the value on the left
hand side is not ordered with respect to the value on right hand hand side is not ordered with respect to the value on the right hand
side. side.
*/ */