boost/boost/preprocessor/min.hpp

   1 #ifndef BOOST_PREPROCESSOR_MIN_HPP
   2 #define BOOST_PREPROCESSOR_MIN_HPP
   3
   4 /* Copyright (C) 2001
   5  * Housemarque Oy
   6  * http://www.housemarque.com
   7  *
   8  * Permission to copy, use, modify, sell and distribute this software is
   9  * granted provided this copyright notice appears in all copies. This
  10  * software is provided "as is" without express or implied warranty, and
  11  * with no claim as to its suitability for any purpose.
  12  *
  13  * See http://www.boost.org for most recent version.
  14  */
  15
  16 #include <boost/preprocessor/comparison/less_equal.hpp>
  17 #include <boost/preprocessor/if.hpp>
  18
  19 /** <p>Expands to the minimum of <code>X</code> and <code>Y</code>.</p>
  20
  21 <p>Both <code>X</code> and <code>Y</code> must expand to integer literals
  22 in the range [0, BOOST_PP_LIMIT_MAG].</p>
  23
  24 <p>For example, <code>BOOST_PP_MIN(5,7)</code> expands to <code>5</code> (a
  25 single token).</p>
  26
  27 <h3>Uses</h3>
  28 <ul>
  29   <li>BOOST_PP_WHILE()</li>
  30 </ul>
  31
  32 <h3>Test</h3>
  33 <ul>
  34   <li><a href="../../test/arithmetic_test.cpp">arithmetic_test.cpp</a></li>
  35 </ul>
  36 */
  37 #define BOOST_PP_MIN(X,Y) BOOST_PP_MIN_D(0,X,Y)
  38
  39 /** <p>Can be used inside BOOST_PP_WHILE().</p> */
  40 #define BOOST_PP_MIN_D(D,X,Y) BOOST_PP_IF(BOOST_PP_LESS_EQUAL_D(D,Y,X),Y,X)
  41
  42 /* <p>Obsolete. Use BOOST_PP_MIN().</p> */
  43 #define BOOST_PREPROCESSOR_MIN(X,Y) BOOST_PP_MIN(X,Y)
  44 #endif