src/lib/openmj2/int.h

   1 /*
   2  * The copyright in this software is being made available under the 2-clauses
   3  * BSD License, included below. This software may be subject to other third
   4  * party and contributor rights, including patent rights, and no such rights
   5  * are granted under this license.
   6  *
   7  * Copyright (c) 2002-2014, Universite catholique de Louvain (UCL), Belgium
   8  * Copyright (c) 2002-2014, Professor Benoit Macq
   9  * Copyright (c) 2001-2003, David Janssens
  10  * Copyright (c) 2002-2003, Yannick Verschueren
  11  * Copyright (c) 2003-2007, Francois-Olivier Devaux
  12  * Copyright (c) 2003-2014, Antonin Descampe
  13  * Copyright (c) 2005, Herve Drolon, FreeImage Team
  14  * All rights reserved.
  15  *
  16  * Redistribution and use in source and binary forms, with or without
  17  * modification, are permitted provided that the following conditions
  18  * are met:
  19  * 1. Redistributions of source code must retain the above copyright
  20  *    notice, this list of conditions and the following disclaimer.
  21  * 2. Redistributions in binary form must reproduce the above copyright
  22  *    notice, this list of conditions and the following disclaimer in the
  23  *    documentation and/or other materials provided with the distribution.
  24  *
  25  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
  26  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  27  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  28  * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  29  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  30  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  31  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  32  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  33  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  34  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  35  * POSSIBILITY OF SUCH DAMAGE.
  36  */
  37 #ifndef __INT_H
  38 #define __INT_H
  39 /**
  40 @file int.h
  41 @brief Implementation of operations on integers (INT)
  42
  43 The functions in INT.H have for goal to realize operations on integers.
  44 */
  45
  46 /** @defgroup INT INT - Implementation of operations on integers */
  47 /*@{*/
  48
  49 /** @name Exported functions (see also openjpeg.h) */
  50 /*@{*/
  51 /* ----------------------------------------------------------------------- */
  52 /**
  53 Get the minimum of two integers
  54 @return Returns a if a < b else b
  55 */
  56 static INLINE int int_min(int a, int b) {
  57         return a < b ? a : b;
  58 }
  59 /**
  60 Get the maximum of two integers
  61 @return Returns a if a > b else b
  62 */
  63 static INLINE int int_max(int a, int b) {
  64         return (a > b) ? a : b;
  65 }
  66 /**
  67 Clamp an integer inside an interval
  68 @return
  69 <ul>
  70 <li>Returns a if (min < a < max)
  71 <li>Returns max if (a > max)
  72 <li>Returns min if (a < min)
  73 </ul>
  74 */
  75 static INLINE int int_clamp(int a, int min, int max) {
  76         if (a < min)
  77                 return min;
  78         if (a > max)
  79                 return max;
  80         return a;
  81 }
  82 /**
  83 @return Get absolute value of integer
  84 */
  85 static INLINE int int_abs(int a) {
  86         return a < 0 ? -a : a;
  87 }
  88 /**
  89 Divide an integer and round upwards
  90 @return Returns a divided by b
  91 */
  92 static INLINE int int_ceildiv(int a, int b) {
  93         return (a + b - 1) / b;
  94 }
  95 /**
  96 Divide an integer by a power of 2 and round upwards
  97 @return Returns a divided by 2^b
  98 */
  99 static INLINE int int_ceildivpow2(int a, int b) {
 100         return (a + (1 << b) - 1) >> b;
 101 }
 102 /**
 103 Divide an integer by a power of 2 and round downwards
 104 @return Returns a divided by 2^b
 105 */
 106 static INLINE int int_floordivpow2(int a, int b) {
 107         return a >> b;
 108 }
 109 /**
 110 Get logarithm of an integer and round downwards
 111 @return Returns log2(a)
 112 */
 113 static INLINE int int_floorlog2(int a) {
 114         int l;
 115         for (l = 0; a > 1; l++) {
 116                 a >>= 1;
 117         }
 118         return l;
 119 }
 120 /* ----------------------------------------------------------------------- */
 121 /*@}*/
 122
 123 /*@}*/
 124
 125 #endif