Cleanup: remove redundant doxygen \file argument
[blender.git] / source / blender / blenlib / BLI_utildefines_iter.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 #ifndef __BLI_UTILDEFINES_ITER_H__
18 #define __BLI_UTILDEFINES_ITER_H__
19
20 /** \file \ingroup bli
21  *
22  * General looping helpers, use `BLI_FOREACH` prefix.
23  */
24
25 /**
26  * Even value distribution.
27  *
28  * \a src must be larger than \a dst,
29  * \a dst defines the number of iterations, their values are evenly spaced.
30  *
31  * The following pairs represent (src, dst) arguments and the values they loop over.
32  * <pre>
33  * (19, 4) ->    [2, 7, 11. 16]
34  * (100, 5) ->   [9, 29, 49, 69, 89]
35  * (100, 3) ->   [16, 49, 83]
36  * (100, 100) -> [0..99]
37  * </pre>
38  * \note this is mainly useful for numbers that might not divide evenly into eachother.
39  */
40 #define BLI_FOREACH_SPARSE_RANGE(src, dst, i) \
41 for (int _src = (src), _src2 = _src * 2, _dst2 = (dst) * 2, _error = _dst2 - _src, i = 0, _delta; \
42      ((void)(_delta = divide_floor_i(_error, _dst2)), \
43       (void)(i -= _delta), \
44       (i < _src)); \
45      _error -= (_delta * _dst2) + _src2)
46
47 #endif  /* __BLI_UTILDEFINES_ITER_H__ */