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