src/gdcmopenjpeg/libopenjpeg/int.h

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