cds/algo/int_algo.h

   1 /*
   2     This file is a part of libcds - Concurrent Data Structures library
   3
   4     (C) Copyright Maxim Khizhinsky (libcds.dev@gmail.com) 2006-2017
   5
   6     Source code repo: http://github.com/khizmax/libcds/
   7     Download: http://sourceforge.net/projects/libcds/files/
   8
   9     Redistribution and use in source and binary forms, with or without
  10     modification, are permitted provided that the following conditions are met:
  11
  12     * Redistributions of source code must retain the above copyright notice, this
  13       list of conditions and the following disclaimer.
  14
  15     * Redistributions in binary form must reproduce the above copyright notice,
  16       this list of conditions and the following disclaimer in the documentation
  17       and/or other materials provided with the distribution.
  18
  19     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  20     AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21     IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  22     DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
  23     FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24     DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  25     SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  26     CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  27     OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28     OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29 */
  30
  31 #ifndef CDSLIB_INT_ALGO_H
  32 #define CDSLIB_INT_ALGO_H
  33
  34 #include <cds/algo/bitop.h>
  35
  36 namespace cds { namespace beans {
  37     /// Returns largest previous integer for <tt>log2( n )</tt>
  38     static inline size_t log2floor( size_t n )
  39     {
  40         return n ? cds::bitop::MSBnz( n ) : 0;
  41     }
  42
  43     /// Returns smallest following integer for <tt>log2( n )</tt>
  44     static inline size_t log2ceil( size_t n )
  45     {
  46         size_t i = log2floor( n );
  47         return ( size_t( 1 ) << i ) < n ? i + 1 : i;
  48     }
  49
  50     /// Returns largest previous power of 2 for \p n
  51     /**
  52         Examples:
  53         \code
  54         floor2(0) == 1   // !!!
  55         floor2(1) == 1
  56         floor2(2) == 2
  57         floor2(3) == 2
  58         floor2(4) == 4
  59         floor2(15) == 8
  60         floor2(16) == 16
  61         floor2(17) == 16
  62         \endcode
  63     */
  64     static inline size_t floor2( size_t n )
  65     {
  66         return size_t(1) << log2floor( n );
  67     }
  68
  69     /// Returns smallest following power of 2 for \p n
  70     /**
  71         Examples:
  72         \code
  73         ceil2(0) == 1   // !!!
  74         ceil2(1) == 1
  75         ceil2(2) == 2
  76         ceil2(3) == 4
  77         ceil2(4) == 4
  78         ceil2(15) == 16
  79         ceil2(16) == 16
  80         ceil2(17) == 32
  81         \endcode
  82     */
  83     static inline size_t ceil2( size_t n )
  84     {
  85         return size_t(1) << log2ceil( n );
  86     }
  87
  88     /// Checks if \p n is power of 2
  89     CDS_CONSTEXPR static inline bool is_power2( size_t n ) CDS_NOEXCEPT
  90     {
  91         return (n & (n - 1)) == 0 && n;
  92     }
  93
  94     /// Returns binary logarithm of \p n if \p n is power of two, otherwise returns 0
  95     static inline size_t log2( size_t n )
  96     {
  97         return is_power2(n) ? log2floor(n) : 0;
  98     }
  99
 100 #if CDS_BUILD_BITS == 32
 101     //@cond
 102     // 64bit specializations
 103
 104 /// Returns largest previous integer for <tt>log2( n )</tt>
 105     static inline uint64_t log2floor( uint64_t n )
 106     {
 107         return n ? cds::bitop::MSBnz( n ) : 0;
 108     }
 109
 110 /// Returns smallest following integer for <tt>log2( n )</tt>
 111     static inline uint64_t log2ceil( uint64_t n )
 112     {
 113         uint64_t i = log2floor( n );
 114         return (uint64_t( 1 ) << i) < n ? i + 1 : i;
 115     }
 116
 117 /// Returns largest previous power of 2 for \p n
 118     /**
 119         Examples:
 120         \code
 121         floor2(0) == 1   // !!!
 122         floor2(1) == 1
 123         floor2(2) == 2
 124         floor2(3) == 2
 125         floor2(4) == 4
 126         floor2(15) == 8
 127         floor2(16) == 16
 128         floor2(17) == 16
 129         \endcode
 130     */
 131     static inline uint64_t floor2( uint64_t n )
 132     {
 133         return uint64_t( 1 ) << log2floor( n );
 134     }
 135
 136 /// Returns smallest following power of 2 for \p n
 137     /**
 138         Examples:
 139         \code
 140         ceil2(0) == 1   // !!!
 141         ceil2(1) == 1
 142         ceil2(2) == 2
 143         ceil2(3) == 4
 144         ceil2(4) == 4
 145         ceil2(15) == 16
 146         ceil2(16) == 16
 147         ceil2(17) == 32
 148         \endcode
 149     */
 150     static inline uint64_t ceil2( uint64_t n )
 151     {
 152         return uint64_t( 1 ) << log2ceil( n );
 153     }
 154
 155 /// Checks if \p n is power of 2
 156     CDS_CONSTEXPR static inline bool is_power2( uint64_t n ) CDS_NOEXCEPT
 157     {
 158         return (n & (n - 1)) == 0 && n;
 159     }
 160
 161 /// Returns binary logarithm of \p n if \p n is power of two, otherwise returns 0
 162     static inline uint64_t log2( uint64_t n )
 163     {
 164         return is_power2( n ) ? log2floor( n ) : 0;
 165     }
 166
 167     //@endcond
 168 #endif //#if CDS_BUILD_BITS == 32
 169
 170 }}   // namespace cds::beans
 171
 172 #endif  // #ifndef CDSLIB_INT_ALGO_H