+// std::rel_ops implementation -*- C++ -*-
+
+// Copyright (C) 2001-2015 Free Software Foundation, Inc.
+//
+// This file is part of the GNU ISO C++ Library. This library is free
+// software; you can redistribute it and/or modify it under the
+// terms of the GNU General Public License as published by the
+// Free Software Foundation; either version 3, or (at your option)
+// any later version.
+
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+
+// Under Section 7 of GPL version 3, you are granted additional
+// permissions described in the GCC Runtime Library Exception, version
+// 3.1, as published by the, 2009 Free Software Foundation.
+
+// You should have received a copy of the GNU General Public License and
+// a copy of the GCC Runtime Library Exception along with this program;
+// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
+// <http://www.gnu.org/licenses/>.
+
/*
*
* Copyright (c) 1994
*
*/
-/* NOTE: This is an internal header file, included by other STL headers.
- * You should not attempt to use it directly.
- */
-
-/**** libstdc++-v3 note: Inclusion of this file has been removed from
- * all of the other STL headers for safety reasons, except std_utility.h.
- * For more information, see the thread of about twenty messages starting
- * with <URL:http://gcc.gnu.org/ml/libstdc++/2001-01/msg00223.html>, or the
- * FAQ at <URL:http://gcc.gnu.org/onlinedocs/libstdc++/faq/index.html#4_4>.
+/** @file bits/stl_relops.h
+ * This is an internal header file, included by other library headers.
+ * Do not attempt to use it directly. @headername{utility}
+ *
+ * Inclusion of this file has been removed from
+ * all of the other STL headers for safety reasons, except std_utility.h.
+ * For more information, see the thread of about twenty messages starting
+ * with http://gcc.gnu.org/ml/libstdc++/2001-01/msg00223.html, or
+ * http://gcc.gnu.org/onlinedocs/libstdc++/faq.html#faq.ambiguous_overloads
*
- * Short summary: the rel_ops operators cannot be made to play nice.
- * Don't use them.
-*/
+ * Short summary: the rel_ops operators should be avoided for the present.
+ */
-#ifndef _CPP_BITS_STL_RELOPS_H
-#define _CPP_BITS_STL_RELOPS_H 1
+#ifndef _STL_RELOPS_H
+#define _STL_RELOPS_H 1
-namespace std
+namespace std _GLIBCXX_VISIBILITY(default)
{
namespace rel_ops
{
+ _GLIBCXX_BEGIN_NAMESPACE_VERSION
-template <class _Tp>
-inline bool operator!=(const _Tp& __x, const _Tp& __y) {
- return !(__x == __y);
-}
+ /** @namespace std::rel_ops
+ * @brief The generated relational operators are sequestered here.
+ */
-template <class _Tp>
-inline bool operator>(const _Tp& __x, const _Tp& __y) {
- return __y < __x;
-}
+ /**
+ * @brief Defines @c != for arbitrary types, in terms of @c ==.
+ * @param __x A thing.
+ * @param __y Another thing.
+ * @return __x != __y
+ *
+ * This function uses @c == to determine its result.
+ */
+ template <class _Tp>
+ inline bool
+ operator!=(const _Tp& __x, const _Tp& __y)
+ { return !(__x == __y); }
-template <class _Tp>
-inline bool operator<=(const _Tp& __x, const _Tp& __y) {
- return !(__y < __x);
-}
+ /**
+ * @brief Defines @c > for arbitrary types, in terms of @c <.
+ * @param __x A thing.
+ * @param __y Another thing.
+ * @return __x > __y
+ *
+ * This function uses @c < to determine its result.
+ */
+ template <class _Tp>
+ inline bool
+ operator>(const _Tp& __x, const _Tp& __y)
+ { return __y < __x; }
-template <class _Tp>
-inline bool operator>=(const _Tp& __x, const _Tp& __y) {
- return !(__x < __y);
-}
+ /**
+ * @brief Defines @c <= for arbitrary types, in terms of @c <.
+ * @param __x A thing.
+ * @param __y Another thing.
+ * @return __x <= __y
+ *
+ * This function uses @c < to determine its result.
+ */
+ template <class _Tp>
+ inline bool
+ operator<=(const _Tp& __x, const _Tp& __y)
+ { return !(__y < __x); }
+ /**
+ * @brief Defines @c >= for arbitrary types, in terms of @c <.
+ * @param __x A thing.
+ * @param __y Another thing.
+ * @return __x >= __y
+ *
+ * This function uses @c < to determine its result.
+ */
+ template <class _Tp>
+ inline bool
+ operator>=(const _Tp& __x, const _Tp& __y)
+ { return !(__x < __y); }
+
+ _GLIBCXX_END_NAMESPACE_VERSION
} // namespace rel_ops
-} // namespace std
-#endif /* _CPP_BITS_STL_RELOPS_H */
+} // namespace std
-// Local Variables:
-// mode:C++
-// End:
+#endif /* _STL_RELOPS_H */