minor change for readability
[openjpeg.git] / jpwl / decoder / libopenjpeg / int.h
1 /*
2  * Copyright (c) 2001-2002, David Janssens
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
15  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
18  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
19  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
20  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
21  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
22  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
23  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
24  * POSSIBILITY OF SUCH DAMAGE.
25  */
26
27 #ifndef __INT_H
28 #define __INT_H
29
30 /*
31  * Get the minimum of two integers.
32  *
33  * returns a if a < b else b
34  */
35 int int_min(int a, int b);
36
37 /*
38  * Get the maximum of two integers.
39  *
40  * returns a if a > b else b
41  */
42 int int_max(int a, int b);
43
44 /*
45  * Clamp an integer inside an interval.
46  *
47  * return a if (min < a < max)
48  * return max if (a > max)
49  * return min if (a < min) 
50  */
51 int int_clamp(int a, int min, int max);
52
53 /*
54  * Get absolute value of integer.
55  */
56 int int_abs(int a);
57
58 /*
59  * Divide an integer and round upwards.
60  *
61  * a divided by b
62  */
63 int int_ceildiv(int a, int b);
64
65 /*
66  * Divide an integer by a power of 2 and round upwards.
67  *
68  * a divided by 2^b
69  */
70 int int_ceildivpow2(int a, int b);
71
72 /*
73  * Divide an integer by a power of 2 and round downwards.
74  *
75  * a divided by 2^b
76  */
77 int int_floordivpow2(int a, int b);
78
79 /*
80  * Get logarithm of an integer and round downwards.
81  *
82  * log2(a)
83  */
84 int int_floorlog2(int a);
85
86 #endif