gimpmath.h 3.64 KB
Newer Older
1
/* LIBGIMP - The GIMP Library
2 3 4
 * Copyright (C) 1995-1997 Peter Mattis and Spencer Kimball
 *
 * gimpmath.h
Tor Lillqvist's avatar
Tor Lillqvist committed
5
 *
6
 * This library is free software: you can redistribute it and/or
Marc Lehmann's avatar
Marc Lehmann committed
7
 * modify it under the terms of the GNU Lesser General Public
Tor Lillqvist's avatar
Tor Lillqvist committed
8
 * License as published by the Free Software Foundation; either
9
 * version 3 of the License, or (at your option) any later version.
Tor Lillqvist's avatar
Tor Lillqvist committed
10 11 12 13
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14
 * Lesser General Public License for more details.
Tor Lillqvist's avatar
Tor Lillqvist committed
15
 *
Marc Lehmann's avatar
Marc Lehmann committed
16
 * You should have received a copy of the GNU Lesser General Public
17
 * License along with this library.  If not, see
18
 * <https://www.gnu.org/licenses/>.
Tor Lillqvist's avatar
Tor Lillqvist committed
19
 */
20

21 22
#ifndef __GIMP_MATH_H__
#define __GIMP_MATH_H__
Tor Lillqvist's avatar
Tor Lillqvist committed
23

24

Tor Lillqvist's avatar
Tor Lillqvist committed
25
#include <math.h>
David Neary's avatar
David Neary committed
26 27 28 29

#ifdef HAVE_IEEEFP_H
#include <ieeefp.h>
#endif
Tor Lillqvist's avatar
Tor Lillqvist committed
30

31 32 33 34
#ifdef G_OS_WIN32
#include <float.h>
#endif

35 36
#define __GIMP_MATH_H_INSIDE__

37 38 39 40 41
#include <libgimpmath/gimpmathtypes.h>

#include <libgimpmath/gimpmatrix.h>
#include <libgimpmath/gimpvector.h>

42 43 44
#undef __GIMP_MATH_H_INSIDE__


45
G_BEGIN_DECLS
46

47 48 49 50 51

/**
 * SECTION: gimpmath
 * @title: GimpMath
 * @short_description: Mathematical definitions and macros.
Tor Lillqvist's avatar
Tor Lillqvist committed
52
 *
53 54
 * Mathematical definitions and macros for use both by the GIMP
 * application and plug-ins. These macros should be used rather than
55
 * the ones from &lt;math.h&gt; for enhanced portability.
56 57
 **/

Tor Lillqvist's avatar
Tor Lillqvist committed
58

59 60 61 62 63 64 65
/**
 * RINT:
 * @x: the value to be rounded
 *
 * This macro rounds its argument @x to an integer value in floating
 * point format. Use RINT() instead of rint().
 **/
66 67 68 69 70 71 72
#if defined (HAVE_RINT) && 0
/* note:  rint() depends on the current floating-point rounding mode.  when the
 * rounding mode is FE_TONEAREST, it, in parctice, breaks ties to even.  this
 * is different from 'floor (x + 0.5)', which breaks ties up.  in other words
 * 'rint (2.5) == 2.0', while 'floor (2.5 + 0.5) == 3.0'.  this is asking for
 * trouble, so let's just use the latter.
 */
Tor Lillqvist's avatar
Tor Lillqvist committed
73 74 75 76 77
#define RINT(x) rint(x)
#else
#define RINT(x) floor ((x) + 0.5)
#endif

78 79 80 81
/**
 * ROUND:
 * @x: the value to be rounded.
 *
82
 * This macro rounds its positive argument @x to the nearest integer.
83
 **/
Tor Lillqvist's avatar
Tor Lillqvist committed
84 85
#define ROUND(x) ((int) ((x) + 0.5))

86 87 88 89 90 91
/**
 * SIGNED_ROUND:
 * @x: the value to be rounded.
 *
 * This macro rounds its argument @x to the nearest integer.
 **/
92
#define SIGNED_ROUND(x) ((int) RINT (x))
93

94 95 96 97 98 99
/**
 * SQR:
 * @x: the value to be squared.
 *
 * This macro squares its argument @x.
 **/
Tor Lillqvist's avatar
Tor Lillqvist committed
100 101
#define SQR(x) ((x) * (x))

102 103 104 105 106 107
/**
 * MAX255:
 * @a: the value to be limited.
 *
 * This macro limits it argument @a, an (0-511) int, to 255.
 **/
Tor Lillqvist's avatar
Tor Lillqvist committed
108 109
#define MAX255(a)  ((a) | (((a) & 256) - (((a) & 256) >> 8)))

110 111 112 113 114 115 116
/**
 * CLAMP0255:
 * @a: the value to be clamped.
 *
 * This macro clamps its argument @a, an int32-range int, between 0
 * and 255 inclusive.
 **/
Tor Lillqvist's avatar
Tor Lillqvist committed
117 118
#define CLAMP0255(a)  CLAMP(a,0,255)

119 120 121 122 123 124 125 126 127 128 129 130 131 132
/**
 * SAFE_CLAMP:
 * @x:    the value to be limited.
 * @low:  the lower limit.
 * @high: the upper limit.
 *
 * Ensures that @x is between the limits set by @low and @high,
 * even if @x is NaN. If @low is greater than @high, or if either
 * of them is NaN, the result is undefined.
 *
 * Since: 2.10
 **/
#define SAFE_CLAMP(x, low, high)  ((x) > (low) ? (x) < (high) ? (x) : (high) : (low))

133 134 135 136 137 138
/**
 * gimp_deg_to_rad:
 * @angle: the angle to be converted.
 *
 * This macro converts its argument @angle from degree to radian.
 **/
139
#define gimp_deg_to_rad(angle) ((angle) * (2.0 * G_PI) / 360.0)
140 141 142 143 144 145 146

/**
 * gimp_rad_to_deg:
 * @angle: the angle to be converted.
 *
 * This macro converts its argument @angle from radian to degree.
 **/
147 148
#define gimp_rad_to_deg(angle) ((angle) * 360.0 / (2.0 * G_PI))

149 150

G_END_DECLS
Tor Lillqvist's avatar
Tor Lillqvist committed
151

152
#endif /* __GIMP_MATH_H__ */