0022651: Impossible to build OCC as static library due to using Standard_EXPORT inste...
[occt.git] / src / Standard / Standard_Real.hxx
1 // Copyright (c) 1998-1999 Matra Datavision
2 // Copyright (c) 1999-2014 OPEN CASCADE SAS
3 //
4 // This file is part of Open CASCADE Technology software library.
5 //
6 // This library is free software; you can redistribute it and/or modify it under
7 // the terms of the GNU Lesser General Public License version 2.1 as published
8 // by the Free Software Foundation, with special exception defined in the file
9 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
10 // distribution for complete text of the license and disclaimer of any warranty.
11 //
12 // Alternatively, this file may be used under the terms of Open CASCADE
13 // commercial license or contractual agreement.
14
15 #ifndef _Standard_Real_HeaderFile
16 #define _Standard_Real_HeaderFile
17
18 #include <cmath>
19 #include <float.h>
20 #include <Standard_values.h>
21 #include <Standard_math.hxx>
22 #include <Standard_TypeDef.hxx>
23
24 // ===============================================
25 // Methods from Standard_Entity class which are redefined:  
26 //    - Hascode
27 //    - IsEqual
28 // ===============================================
29
30 // ==================================
31 // Methods implemeted in Standard_Real.cxx
32 // ==================================
33 Standard_EXPORT Standard_Integer HashCode    (const Standard_Real, const Standard_Integer);  
34
35 Standard_EXPORT Standard_Real    ACos        (const Standard_Real );
36 Standard_EXPORT Standard_Real    ACosApprox  (const Standard_Real );
37 Standard_EXPORT Standard_Real    ASin        (const Standard_Real );
38 Standard_EXPORT Standard_Real    ATan2       (const Standard_Real , const Standard_Real );
39 Standard_EXPORT Standard_Real    NextAfter   (const Standard_Real , const Standard_Real );
40
41 //! Returns |a| if b >= 0; -|a| if b < 0.
42 Standard_EXPORT Standard_Real    Sign(const Standard_Real a, const Standard_Real b);
43
44 Standard_EXPORT Standard_Real    ATanh       (const Standard_Real );
45 Standard_EXPORT Standard_Real    ACosh       (const Standard_Real );
46 Standard_EXPORT Standard_Real    Sinh       (const Standard_Real );
47 Standard_EXPORT Standard_Real    Cosh       (const Standard_Real );
48 Standard_EXPORT Standard_Real    Log         (const Standard_Real );
49 Standard_EXPORT Standard_Real    Sqrt        (const Standard_Real );
50
51 //-------------------------------------------------------------------
52 // RealSmall : Returns the smallest positive real
53 //-------------------------------------------------------------------
54 inline Standard_Real     RealSmall() 
55 { return DBL_MIN; }
56
57 //-------------------------------------------------------------------
58 // Abs : Returns the absolute value of a real
59 //-------------------------------------------------------------------
60 inline Standard_Real     Abs(const Standard_Real Value) 
61 { return fabs(Value); }
62
63
64 //-------------------------------------------------------------------
65 // IsEqual : Returns Standard_True if two reals are equal
66 //-------------------------------------------------------------------
67 inline Standard_Boolean  IsEqual (const Standard_Real Value1, 
68                                   const Standard_Real Value2) 
69 { return Abs((Value1 - Value2)) < RealSmall(); }
70
71          //  *********************************** //
72          //       Class methods                  //
73          //                                      //
74          //  Machine-dependant values            //
75          //  Should be taken from include file   //
76          //  *********************************** //
77
78
79 //-------------------------------------------------------------------
80 // RealDigit : Returns the number of digits of precision in a real
81 //-------------------------------------------------------------------
82 inline Standard_Integer  RealDigits() 
83 { return DBL_DIG; }
84
85 //-------------------------------------------------------------------
86 // RealEpsilon : Returns the minimum positive real such that 
87 //               1.0 + x is not equal to 1.0
88 //-------------------------------------------------------------------
89 inline Standard_Real     RealEpsilon() 
90 { return DBL_EPSILON; }
91
92 //-------------------------------------------------------------------
93 // RealFirst : Returns the minimum negative value of a real
94 //-------------------------------------------------------------------
95 inline Standard_Real     RealFirst() 
96 { return -DBL_MAX; }
97   
98 //-------------------------------------------------------------------
99 // RealFirst10Exp : Returns the minimum value of exponent(base 10) of
100 //                  a real.
101 //-------------------------------------------------------------------
102 inline Standard_Integer  RealFirst10Exp() 
103 { return DBL_MIN_10_EXP; }
104
105 //-------------------------------------------------------------------
106 // RealLast : Returns the maximum value of a real
107 //-------------------------------------------------------------------
108 inline Standard_Real     RealLast() 
109 { return  DBL_MAX; }
110
111 //-------------------------------------------------------------------
112 // RealLast10Exp : Returns the maximum value of exponent(base 10) of
113 //                 a real.
114 //-------------------------------------------------------------------
115 inline Standard_Integer  RealLast10Exp() 
116 { return  DBL_MAX_10_EXP; }
117
118 //-------------------------------------------------------------------
119 // RealMantissa : Returns the size in bits of the matissa part of a 
120 //                real.
121 //-------------------------------------------------------------------
122 inline Standard_Integer  RealMantissa() 
123 { return  DBL_MANT_DIG; }
124
125 //-------------------------------------------------------------------
126 // RealRadix : Returns the radix of exponent representation
127 //-------------------------------------------------------------------
128 inline Standard_Integer  RealRadix() 
129 { return  FLT_RADIX; }
130
131 //-------------------------------------------------------------------
132 // RealSize : Returns the size in bits of an integer
133 //-------------------------------------------------------------------
134 inline Standard_Integer  RealSize() 
135 { return BITS(Standard_Real); }
136
137
138
139          //=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=//
140          //   End of machine-dependant values   //
141          //=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=//
142
143
144 //-------------------------------------------------------------------
145 // IntToReal : Converts an integer in a real
146 //-------------------------------------------------------------------
147 inline Standard_Real     IntToReal(const Standard_Integer Value) 
148 { return Value; }
149
150 //-------------------------------------------------------------------
151 // ATan : Returns the value of the arc tangent of a real
152 //-------------------------------------------------------------------
153 inline Standard_Real     ATan(const Standard_Real Value) 
154 { return atan(Value); }
155
156
157 //-------------------------------------------------------------------
158 // Ceiling : Returns the smallest integer not less than a real
159 //-------------------------------------------------------------------
160 inline Standard_Real     Ceiling (const Standard_Real Value) 
161 { return ceil(Value); }
162
163 //-------------------------------------------------------------------
164 // Cos : Returns the cosine of a real
165 //-------------------------------------------------------------------
166 inline Standard_Real     Cos (const Standard_Real Value) 
167 { return cos(Value); }
168
169
170 //-------------------------------------------------------------------
171 // Epsilon : The function returns absolute value of difference
172 //           between 'Value' and other nearest value of
173 //           Standard_Real type.
174 //           Nearest value is choseen in direction of infinity
175 //           the same sign as 'Value'.
176 //           If 'Value' is 0 then returns minimal positive value
177 //           of Standard_Real type.
178 //-------------------------------------------------------------------
179 inline Standard_Real     Epsilon (const Standard_Real Value) 
180 {
181   Standard_Real aEpsilon;
182
183   if (Value>=0.0){
184     aEpsilon = NextAfter(Value, RealLast()) - Value;
185   } else {
186     aEpsilon = Value - NextAfter(Value, RealFirst());
187   }
188   return aEpsilon;
189 }
190
191 //-------------------------------------------------------------------
192 // Exp : Returns the exponential function of a real
193 //-------------------------------------------------------------------
194 inline Standard_Real     Exp (const Standard_Real Value) 
195 { return exp(Value); }
196
197 //-------------------------------------------------------------------
198 // Floor : Return the largest integer not greater than a real
199 //-------------------------------------------------------------------
200 inline Standard_Real     Floor (const Standard_Real Value) 
201 { return floor(Value); }
202
203 //-------------------------------------------------------------------
204 // IntegerPart : Returns the integer part of a real
205 //-------------------------------------------------------------------
206 inline Standard_Real     IntegerPart (const Standard_Real Value) 
207 { return ( (Value>0) ? floor(Value) : ceil(Value) ); }
208
209
210 //-------------------------------------------------------------------
211 // Log10 : Returns the base-10 logarithm of a real 
212 //-------------------------------------------------------------------
213 inline Standard_Real     Log10 (const Standard_Real Value) 
214 { return log10(Value); }
215
216 //-------------------------------------------------------------------
217 // Max : Returns the maximum value of two reals
218 //-------------------------------------------------------------------
219 inline Standard_Real     Max (const Standard_Real Val1, 
220                               const Standard_Real Val2) 
221 {
222   return Val1 >= Val2 ? Val1 : Val2;
223 }
224
225 //-------------------------------------------------------------------
226 // Min : Returns the minimum value of two reals
227 //-------------------------------------------------------------------
228 inline Standard_Real     Min (const Standard_Real Val1, 
229                               const Standard_Real Val2)
230 {
231   return Val1 <= Val2 ? Val1 : Val2;
232 }
233
234 //-------------------------------------------------------------------
235 // Pow : Returns a real to a given power
236 //-------------------------------------------------------------------
237 inline Standard_Real     Pow (const Standard_Real Value, const Standard_Real P)
238 { return pow(Value,P); }
239
240 //-------------------------------------------------------------------
241 // RealPart : Returns the fractional part of a real.
242 //-------------------------------------------------------------------
243 inline  Standard_Real    RealPart (const Standard_Real Value) 
244 { return fabs(IntegerPart(Value) - Value); }
245
246 //-------------------------------------------------------------------
247 // RealToInt : Returns the real converted to nearest valid integer.
248 //             If input value is out of valid range for integers,
249 //             minimal or maximal possible integer is returned.
250 //-------------------------------------------------------------------
251 inline  Standard_Integer RealToInt (const Standard_Real Value) 
252
253   // Note that on WNT under MS VC++ 8.0 conversion of double value less 
254   // than INT_MIN or greater than INT_MAX to integer will cause signal 
255   // "Floating point multiple trap" (OCC17861)
256   return Value < INT_MIN ? INT_MIN
257     : Value > INT_MAX ? INT_MAX
258     : (Standard_Integer)Value;
259 }
260
261 // =======================================================================
262 // function : RealToShortReal
263 // purpose  : Converts Standard_Real value to the nearest valid
264 //            Standard_ShortReal. If input value is out of valid range
265 //            for Standard_ShortReal, minimal or maximal
266 //            Standard_ShortReal is returned.
267 // =======================================================================
268 inline Standard_ShortReal RealToShortReal (const Standard_Real theVal)
269 {
270   return theVal < -FLT_MAX ? -FLT_MAX
271     : theVal > FLT_MAX ? FLT_MAX
272     : (Standard_ShortReal)theVal;
273 }
274
275 //-------------------------------------------------------------------
276 // Round : Returns the nearest integer of a real
277 //-------------------------------------------------------------------
278 inline Standard_Real     Round (const Standard_Real Value) 
279 { return IntegerPart(Value + (Value > 0 ? 0.5 : -0.5)); }
280
281 //-------------------------------------------------------------------
282 // Sin : Returns the sine of a real
283 //-------------------------------------------------------------------
284 inline Standard_Real     Sin (const Standard_Real Value) 
285 { return sin(Value); }
286
287
288 //-------------------------------------------------------------------
289 // ASinh : Returns the hyperbolic arc sine of a real
290 //-------------------------------------------------------------------
291 inline Standard_Real     ASinh(const Standard_Real Value)
292 #if __QNX__
293 { return std::asinh(Value); }
294 #else
295 { return asinh(Value); }
296 #endif
297
298 //-------------------------------------------------------------------
299 // Square : Returns a real to the power 2
300 //-------------------------------------------------------------------
301 inline Standard_Real     Square(const Standard_Real Value) 
302 { return Value * Value; }
303
304 //-------------------------------------------------------------------
305 // Tan : Returns the tangent of a real
306 //-------------------------------------------------------------------
307 inline Standard_Real     Tan (const Standard_Real Value) 
308 { return tan(Value); }
309
310 //-------------------------------------------------------------------
311 // Tanh : Returns the hyperbolic tangent of a real
312 //-------------------------------------------------------------------
313 inline Standard_Real     Tanh (const Standard_Real Value) 
314 { return tanh(Value); }
315
316 #endif