doxygen: add newline after \file
[blender.git] / source / blender / blenlib / BLI_math_bits.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * */
17
18 #ifndef __BLI_MATH_BITS_H__
19 #define __BLI_MATH_BITS_H__
20
21 /** \file
22  * \ingroup bli
23  */
24
25 #ifdef __cplusplus
26 extern "C" {
27 #endif
28
29 #include "BLI_math_inline.h"
30
31 /* Search the value from LSB to MSB for a set bit. Returns index of this bit. */
32 MINLINE int bitscan_forward_i(int a);
33 MINLINE unsigned int bitscan_forward_uint(unsigned int a);
34
35 /* Similar to above, but also clears the bit. */
36 MINLINE int bitscan_forward_clear_i(int *a);
37 MINLINE unsigned int bitscan_forward_clear_uint(unsigned int *a);
38
39 /* Search the value from MSB to LSB for a set bit. Returns index of this bit. */
40 MINLINE int bitscan_reverse_i(int a);
41 MINLINE unsigned int bitscan_reverse_uint(unsigned int a);
42
43 /* Similar to above, but also clears the bit. */
44 MINLINE int bitscan_reverse_clear_i(int *a);
45 MINLINE unsigned int bitscan_reverse_clear_uint(unsigned int *a);
46
47 /* NOTE: Those functions returns 2 to the power of index of highest order bit. */
48 MINLINE unsigned int highest_order_bit_uint(unsigned int n);
49 MINLINE unsigned short highest_order_bit_s(unsigned short n);
50
51 #ifdef __GNUC__
52 #  define count_bits_i(i) __builtin_popcount(i)
53 #else
54 MINLINE int count_bits_i(unsigned int n);
55 #endif
56
57 MINLINE int float_as_int(float f);
58 MINLINE unsigned int float_as_uint(float f);
59 MINLINE float int_as_float(int i);
60 MINLINE float uint_as_float(unsigned int i);
61 MINLINE float xor_fl(float x, int y);
62
63 #if BLI_MATH_DO_INLINE
64 #include "intern/math_bits_inline.c"
65 #endif
66
67 #ifdef __cplusplus
68 }
69 #endif
70
71 #endif /* __BLI_MATH_BITS_H__ */