libstdc++-v3/include/bits/stl_relops.h

   1 // std::rel_ops implementation -*- C++ -*-
   2
   3 // Copyright (C) 2001, 2002, 2004, 2005, 2008 Free Software Foundation, Inc.
   4 //
   5 // This file is part of the GNU ISO C++ Library.  This library is free
   6 // software; you can redistribute it and/or modify it under the
   7 // terms of the GNU General Public License as published by the
   8 // Free Software Foundation; either version 2, or (at your option)
   9 // any later version.
  10
  11 // This library is distributed in the hope that it will be useful,
  12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 // GNU General Public License for more details.
  15
  16 // You should have received a copy of the GNU General Public License along
  17 // with this library; see the file COPYING.  If not, write to the Free
  18 // Software Foundation, 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
  19 // USA.
  20
  21 // As a special exception, you may use this file as part of a free software
  22 // library without restriction.  Specifically, if other files instantiate
  23 // templates or use macros or inline functions from this file, or you compile
  24 // this file and link it with other files to produce an executable, this
  25 // file does not by itself cause the resulting executable to be covered by
  26 // the GNU General Public License.  This exception does not however
  27 // invalidate any other reasons why the executable file might be covered by
  28 // the GNU General Public License.
  29
  30 /*
  31  *
  32  * Copyright (c) 1994
  33  * Hewlett-Packard Company
  34  *
  35  * Permission to use, copy, modify, distribute and sell this software
  36  * and its documentation for any purpose is hereby granted without fee,
  37  * provided that the above copyright notice appear in all copies and
  38  * that both that copyright notice and this permission notice appear
  39  * in supporting documentation.  Hewlett-Packard Company makes no
  40  * representations about the suitability of this software for any
  41  * purpose.  It is provided "as is" without express or implied warranty.
  42  *
  43  * Copyright (c) 1996,1997
  44  * Silicon Graphics
  45  *
  46  * Permission to use, copy, modify, distribute and sell this software
  47  * and its documentation for any purpose is hereby granted without fee,
  48  * provided that the above copyright notice appear in all copies and
  49  * that both that copyright notice and this permission notice appear
  50  * in supporting documentation.  Silicon Graphics makes no
  51  * representations about the suitability of this software for any
  52  * purpose.  It is provided "as is" without express or implied warranty.
  53  *
  54  */
  55
  56 /** @file stl_relops.h
  57  *  This is an internal header file, included by other library headers.
  58  *  You should not attempt to use it directly.
  59  *
  60  *  Inclusion of this file has been removed from
  61  *  all of the other STL headers for safety reasons, except std_utility.h.
  62  *  For more information, see the thread of about twenty messages starting
  63  *  with http://gcc.gnu.org/ml/libstdc++/2001-01/msg00223.html , or the
  64  *  FAQ at http://gcc.gnu.org/onlinedocs/libstdc++/faq/index.html#4_4 .
  65  *
  66  *  Short summary:  the rel_ops operators should be avoided for the present.
  67  */
  68
  69 #ifndef _STL_RELOPS_H
  70 #define _STL_RELOPS_H 1
  71
  72 _GLIBCXX_BEGIN_NAMESPACE(std)
  73
  74   namespace rel_ops
  75   {
  76     /** @namespace std::rel_ops
  77      *  @brief  The generated relational operators are sequestered here.
  78      */
  79
  80     /**
  81      *  @brief Defines @c != for arbitrary types, in terms of @c ==.
  82      *  @param  x  A thing.
  83      *  @param  y  Another thing.
  84      *  @return   x != y
  85      *
  86      *  This function uses @c == to determine its result.
  87      */
  88     template <class _Tp>
  89       inline bool
  90       operator!=(const _Tp& __x, const _Tp& __y)
  91       { return !(__x == __y); }
  92
  93     /**
  94      *  @brief Defines @c > for arbitrary types, in terms of @c <.
  95      *  @param  x  A thing.
  96      *  @param  y  Another thing.
  97      *  @return   x > y
  98      *
  99      *  This function uses @c < to determine its result.
 100      */
 101     template <class _Tp>
 102       inline bool
 103       operator>(const _Tp& __x, const _Tp& __y)
 104       { return __y < __x; }
 105
 106     /**
 107      *  @brief Defines @c <= for arbitrary types, in terms of @c <.
 108      *  @param  x  A thing.
 109      *  @param  y  Another thing.
 110      *  @return   x <= y
 111      *
 112      *  This function uses @c < to determine its result.
 113      */
 114     template <class _Tp>
 115       inline bool
 116       operator<=(const _Tp& __x, const _Tp& __y)
 117       { return !(__y < __x); }
 118
 119     /**
 120      *  @brief Defines @c >= for arbitrary types, in terms of @c <.
 121      *  @param  x  A thing.
 122      *  @param  y  Another thing.
 123      *  @return   x >= y
 124      *
 125      *  This function uses @c < to determine its result.
 126      */
 127     template <class _Tp>
 128       inline bool
 129       operator>=(const _Tp& __x, const _Tp& __y)
 130       { return !(__x < __y); }
 131
 132   } // namespace rel_ops
 133
 134 _GLIBCXX_END_NAMESPACE
 135
 136 #endif /* _STL_RELOPS_H */