File: //usr/share/doc/openjpeg-devel-1.5.1/html/int_8h_source.html
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>OpenJPEG: int.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">OpenJPEG
 <span id="projectnumber">1.5.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_99d2dc560f84dde124e930de108007a7.html">builddir</a></li><li class="navelem"><a class="el" href="dir_f6883469d6f26503444921bb15d930e9.html">build</a></li><li class="navelem"><a class="el" href="dir_37d5b7668ae03bfa373b2267d602ea0e.html">BUILD</a></li><li class="navelem"><a class="el" href="dir_9904e09c490f202282706830189faba0.html">openjpeg-1.5.1</a></li><li class="navelem"><a class="el" href="dir_10074df973a1c5851187da2011751b4d.html">libopenjpeg</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">int.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="int_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Copyright (c) 2002-2007, Communications and Remote Sensing Laboratory, Universite catholique de Louvain (UCL), Belgium</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * Copyright (c) 2002-2007, Professor Benoit Macq</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * Copyright (c) 2001-2003, David Janssens</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * Copyright (c) 2002-2003, Yannick Verschueren</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * Copyright (c) 2003-2007, Francois-Olivier Devaux and Antonin Descampe</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * Copyright (c) 2005, Herve Drolon, FreeImage Team</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * All rights reserved.</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * Redistribution and use in source and binary forms, with or without</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * modification, are permitted provided that the following conditions</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * are met:</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * 1. Redistributions of source code must retain the above copyright</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * notice, this list of conditions and the following disclaimer.</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * 2. Redistributions in binary form must reproduce the above copyright</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * notice, this list of conditions and the following disclaimer in the</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * documentation and/or other materials provided with the distribution.</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> * POSSIBILITY OF SUCH DAMAGE.</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#ifndef __INT_H</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor"></span><span class="preprocessor">#define __INT_H</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment">/* ----------------------------------------------------------------------- */</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="group___i_n_t.html#ga3ed3a7cfc7dc93500e592d24af8c8e71"> 50</a></span> <span class="keyword">static</span> <a class="code" href="opj__includes_8h.html#a2eb6f9e0395b47b8d5e3eeae4fe0c116">INLINE</a> <span class="keywordtype">int</span> <a class="code" href="group___i_n_t.html#ga3ed3a7cfc7dc93500e592d24af8c8e71">int_min</a>(<span class="keywordtype">int</span> a, <span class="keywordtype">int</span> b) {</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="keywordflow">return</span> a < b ? a : b;</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> }</div>
<div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="group___i_n_t.html#gafc3ca7454e4cf3201810167c645ce99f"> 57</a></span> <span class="keyword">static</span> <a class="code" href="opj__includes_8h.html#a2eb6f9e0395b47b8d5e3eeae4fe0c116">INLINE</a> <span class="keywordtype">int</span> <a class="code" href="group___i_n_t.html#gafc3ca7454e4cf3201810167c645ce99f">int_max</a>(<span class="keywordtype">int</span> a, <span class="keywordtype">int</span> b) {</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keywordflow">return</span> (a > b) ? a : b;</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> }</div>
<div class="line"><a name="l00069"></a><span class="lineno"><a class="line" href="group___i_n_t.html#gab900976eb2a33a61c596189145fad7fc"> 69</a></span> <span class="keyword">static</span> <a class="code" href="opj__includes_8h.html#a2eb6f9e0395b47b8d5e3eeae4fe0c116">INLINE</a> <span class="keywordtype">int</span> <a class="code" href="group___i_n_t.html#gab900976eb2a33a61c596189145fad7fc">int_clamp</a>(<span class="keywordtype">int</span> a, <span class="keywordtype">int</span> <a class="code" href="rs_8h.html#ac6afabdc09a49a433ee19d8a9486056d">min</a>, <span class="keywordtype">int</span> max) {</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keywordflow">if</span> (a < min)</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keywordflow">return</span> <a class="code" href="rs_8h.html#ac6afabdc09a49a433ee19d8a9486056d">min</a>;</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keywordflow">if</span> (a > max)</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="keywordflow">return</span> max;</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keywordflow">return</span> a;</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> }</div>
<div class="line"><a name="l00079"></a><span class="lineno"><a class="line" href="group___i_n_t.html#ga087ddb3fbb11f4aff8e5834ac122f118"> 79</a></span> <span class="keyword">static</span> <a class="code" href="opj__includes_8h.html#a2eb6f9e0395b47b8d5e3eeae4fe0c116">INLINE</a> <span class="keywordtype">int</span> <a class="code" href="group___i_n_t.html#ga087ddb3fbb11f4aff8e5834ac122f118">int_abs</a>(<span class="keywordtype">int</span> a) {</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="keywordflow">return</span> a < 0 ? -a : a;</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> }</div>
<div class="line"><a name="l00086"></a><span class="lineno"><a class="line" href="group___i_n_t.html#ga456bddc8ffb018a41a8e7575966b6f21"> 86</a></span> <span class="keyword">static</span> <a class="code" href="opj__includes_8h.html#a2eb6f9e0395b47b8d5e3eeae4fe0c116">INLINE</a> <span class="keywordtype">int</span> <a class="code" href="group___i_n_t.html#ga456bddc8ffb018a41a8e7575966b6f21">int_ceildiv</a>(<span class="keywordtype">int</span> a, <span class="keywordtype">int</span> b) {</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="keywordflow">return</span> (a + b - 1) / b;</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> }</div>
<div class="line"><a name="l00093"></a><span class="lineno"><a class="line" href="group___i_n_t.html#ga19bff6574a5cc59894103464a0d78599"> 93</a></span> <span class="keyword">static</span> <a class="code" href="opj__includes_8h.html#a2eb6f9e0395b47b8d5e3eeae4fe0c116">INLINE</a> <span class="keywordtype">int</span> <a class="code" href="group___i_n_t.html#ga19bff6574a5cc59894103464a0d78599">int_ceildivpow2</a>(<span class="keywordtype">int</span> a, <span class="keywordtype">int</span> b) {</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="keywordflow">return</span> (a + (1 << b) - 1) >> b;</div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> }</div>
<div class="line"><a name="l00100"></a><span class="lineno"><a class="line" href="group___i_n_t.html#gae82cb38abedf9d1910e7059054134e6d"> 100</a></span> <span class="keyword">static</span> <a class="code" href="opj__includes_8h.html#a2eb6f9e0395b47b8d5e3eeae4fe0c116">INLINE</a> <span class="keywordtype">int</span> <a class="code" href="group___i_n_t.html#gae82cb38abedf9d1910e7059054134e6d">int_floordivpow2</a>(<span class="keywordtype">int</span> a, <span class="keywordtype">int</span> b) {</div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <span class="keywordflow">return</span> a >> b;</div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span> }</div>
<div class="line"><a name="l00107"></a><span class="lineno"><a class="line" href="group___i_n_t.html#ga6496e29a8a8e36c41be21145f73415b9"> 107</a></span> <span class="keyword">static</span> <a class="code" href="opj__includes_8h.html#a2eb6f9e0395b47b8d5e3eeae4fe0c116">INLINE</a> <span class="keywordtype">int</span> <a class="code" href="group___i_n_t.html#ga6496e29a8a8e36c41be21145f73415b9">int_floorlog2</a>(<span class="keywordtype">int</span> a) {</div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  <span class="keywordtype">int</span> l;</div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  <span class="keywordflow">for</span> (l = 0; a > 1; l++) {</div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  a >>= 1;</div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  }</div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  <span class="keywordflow">return</span> l;</div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span> }</div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="comment">/* ----------------------------------------------------------------------- */</span></div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span> </div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="preprocessor">#endif</span></div>
<div class="ttc" id="group___i_n_t_html_ga087ddb3fbb11f4aff8e5834ac122f118"><div class="ttname"><a href="group___i_n_t.html#ga087ddb3fbb11f4aff8e5834ac122f118">int_abs</a></div><div class="ttdeci">static INLINE int int_abs(int a)</div><div class="ttdef"><b>Definition:</b> int.h:79</div></div>
<div class="ttc" id="group___i_n_t_html_ga19bff6574a5cc59894103464a0d78599"><div class="ttname"><a href="group___i_n_t.html#ga19bff6574a5cc59894103464a0d78599">int_ceildivpow2</a></div><div class="ttdeci">static INLINE int int_ceildivpow2(int a, int b)</div><div class="ttdoc">Divide an integer by a power of 2 and round upwards. </div><div class="ttdef"><b>Definition:</b> int.h:93</div></div>
<div class="ttc" id="rs_8h_html_ac6afabdc09a49a433ee19d8a9486056d"><div class="ttname"><a href="rs_8h.html#ac6afabdc09a49a433ee19d8a9486056d">min</a></div><div class="ttdeci">#define min(a, b)</div><div class="ttdoc">Computes the minimum between two integers. </div><div class="ttdef"><b>Definition:</b> rs.h:102</div></div>
<div class="ttc" id="group___i_n_t_html_gab900976eb2a33a61c596189145fad7fc"><div class="ttname"><a href="group___i_n_t.html#gab900976eb2a33a61c596189145fad7fc">int_clamp</a></div><div class="ttdeci">static INLINE int int_clamp(int a, int min, int max)</div><div class="ttdoc">Clamp an integer inside an interval. </div><div class="ttdef"><b>Definition:</b> int.h:69</div></div>
<div class="ttc" id="group___i_n_t_html_ga456bddc8ffb018a41a8e7575966b6f21"><div class="ttname"><a href="group___i_n_t.html#ga456bddc8ffb018a41a8e7575966b6f21">int_ceildiv</a></div><div class="ttdeci">static INLINE int int_ceildiv(int a, int b)</div><div class="ttdoc">Divide an integer and round upwards. </div><div class="ttdef"><b>Definition:</b> int.h:86</div></div>
<div class="ttc" id="group___i_n_t_html_gafc3ca7454e4cf3201810167c645ce99f"><div class="ttname"><a href="group___i_n_t.html#gafc3ca7454e4cf3201810167c645ce99f">int_max</a></div><div class="ttdeci">static INLINE int int_max(int a, int b)</div><div class="ttdoc">Get the maximum of two integers. </div><div class="ttdef"><b>Definition:</b> int.h:57</div></div>
<div class="ttc" id="opj__includes_8h_html_a2eb6f9e0395b47b8d5e3eeae4fe0c116"><div class="ttname"><a href="opj__includes_8h.html#a2eb6f9e0395b47b8d5e3eeae4fe0c116">INLINE</a></div><div class="ttdeci">#define INLINE</div><div class="ttdef"><b>Definition:</b> opj_includes.h:75</div></div>
<div class="ttc" id="group___i_n_t_html_gae82cb38abedf9d1910e7059054134e6d"><div class="ttname"><a href="group___i_n_t.html#gae82cb38abedf9d1910e7059054134e6d">int_floordivpow2</a></div><div class="ttdeci">static INLINE int int_floordivpow2(int a, int b)</div><div class="ttdoc">Divide an integer by a power of 2 and round downwards. </div><div class="ttdef"><b>Definition:</b> int.h:100</div></div>
<div class="ttc" id="group___i_n_t_html_ga6496e29a8a8e36c41be21145f73415b9"><div class="ttname"><a href="group___i_n_t.html#ga6496e29a8a8e36c41be21145f73415b9">int_floorlog2</a></div><div class="ttdeci">static INLINE int int_floorlog2(int a)</div><div class="ttdoc">Get logarithm of an integer and round downwards. </div><div class="ttdef"><b>Definition:</b> int.h:107</div></div>
<div class="ttc" id="group___i_n_t_html_ga3ed3a7cfc7dc93500e592d24af8c8e71"><div class="ttname"><a href="group___i_n_t.html#ga3ed3a7cfc7dc93500e592d24af8c8e71">int_min</a></div><div class="ttdeci">static INLINE int int_min(int a, int b)</div><div class="ttdoc">Get the minimum of two integers. </div><div class="ttdef"><b>Definition:</b> int.h:50</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>