2 * Copyright (c) 2001-2003, David Janssens
3 * Copyright (c) 2002-2003, Yannick Verschueren
4 * Copyright (c) 2003-2005, Francois Devaux and Antonin Descampe
5 * Copyright (c) 2005, Herv� Drolon, FreeImage Team
6 * Copyright (c) 2002-2005, Communications and remote sensing Laboratory, Universite catholique de Louvain, Belgium
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
19 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
22 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28 * POSSIBILITY OF SUCH DAMAGE.
35 @brief Implementation of operations on integers (INT)
37 The functions in INT.C have for goal to realize operations on integers.
40 /** @defgroup INT INT - Implementation of operations on integers */
43 /** @name Exported functions (see also openjpeg.h) */
45 /* ----------------------------------------------------------------------- */
47 Get the minimum of two integers
48 @return Returns a if a < b else b
50 int int_min(int a, int b);
52 Get the maximum of two integers
53 @return Returns a if a > b else b
55 int int_max(int a, int b);
57 Clamp an integer inside an interval
60 <li>Returns a if (min < a < max)
61 <li>Returns max if (a > max)
62 <li>Returns min if (a < min)
65 int int_clamp(int a, int min, int max);
67 @return Get absolute value of integer
71 Divide an integer and round upwards
72 @return Returns a divided by b
74 int int_ceildiv(int a, int b);
76 Divide an integer by a power of 2 and round upwards
77 @return Returns a divided by 2^b
79 int int_ceildivpow2(int a, int b);
81 Divide an integer by a power of 2 and round downwards
82 @return Returns a divided by 2^b
84 int int_floordivpow2(int a, int b);
86 Get logarithm of an integer and round downwards
87 @return Returns log2(a)
89 int int_floorlog2(int a);
91 /* ----------------------------------------------------------------------- */