0024927: Getting rid of "Persistent" functionality -- Storable
[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 <float.h>
19 #include <math.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 //    - IsSimilar
29 // ===============================================
30
31 // ==================================
32 // Methods implemeted in Standard_Real.cxx
33 // ==================================
34 __Standard_API Standard_Integer HashCode    (const Standard_Real, const Standard_Integer);  
35
36 __Standard_API Standard_Real    ACos        (const Standard_Real );
37 __Standard_API Standard_Real    ACosApprox  (const Standard_Real );
38 __Standard_API Standard_Real    ASin        (const Standard_Real );
39 __Standard_API Standard_Real    ATan2       (const Standard_Real , const Standard_Real );
40 __Standard_API Standard_Real    NextAfter   (const Standard_Real , const Standard_Real );
41 __Standard_API Standard_Real    Sign        (const Standard_Real , const Standard_Real );
42 __Standard_API Standard_Real    ATanh       (const Standard_Real );
43 __Standard_API Standard_Real    ACosh       (const Standard_Real );
44 __Standard_API Standard_Real    Log         (const Standard_Real );
45 __Standard_API Standard_Real    Sqrt        (const Standard_Real );
46
47 //-------------------------------------------------------------------
48 // RealSmall : Returns the smallest positive real
49 //-------------------------------------------------------------------
50 inline Standard_Real     RealSmall() 
51 { return DBL_MIN; }
52
53 //-------------------------------------------------------------------
54 // Abs : Returns the absolute value of a real
55 //-------------------------------------------------------------------
56 inline Standard_Real     Abs(const Standard_Real Value) 
57 { return fabs(Value); }
58
59
60 //-------------------------------------------------------------------
61 // IsEqual : Returns Standard_True if two reals are equal
62 //-------------------------------------------------------------------
63 inline Standard_Boolean  IsEqual (const Standard_Real Value1, 
64                                   const Standard_Real Value2) 
65 { return Abs((Value1 - Value2)) < RealSmall(); }
66
67 //-------------------------------------------------------------------
68 // IsSimilar : Returns Standard_True if two reals are equal
69 //-------------------------------------------------------------------
70 inline Standard_Boolean  IsSimilar(const Standard_Real One, 
71                                   const Standard_Real Two)
72 { return IsEqual (One,Two); }
73
74
75
76          //  *********************************** //
77          //       Class methods                  //
78          //                                      //
79          //  Machine-dependant values            //
80          //  Should be taken from include file   //
81          //  *********************************** //
82
83
84 //-------------------------------------------------------------------
85 // RealDigit : Returns the number of digits of precision in a real
86 //-------------------------------------------------------------------
87 inline Standard_Integer  RealDigits() 
88 { return DBL_DIG; }
89
90 //-------------------------------------------------------------------
91 // RealEpsilon : Returns the minimum positive real such that 
92 //               1.0 + x is not equal to 1.0
93 //-------------------------------------------------------------------
94 inline Standard_Real     RealEpsilon() 
95 { return DBL_EPSILON; }
96
97 //-------------------------------------------------------------------
98 // RealFirst : Returns the minimum negative value of a real
99 //-------------------------------------------------------------------
100 inline Standard_Real     RealFirst() 
101 { return -DBL_MAX; }
102   
103 //-------------------------------------------------------------------
104 // RealFirst10Exp : Returns the minimum value of exponent(base 10) of
105 //                  a real.
106 //-------------------------------------------------------------------
107 inline Standard_Integer  RealFirst10Exp() 
108 { return DBL_MIN_10_EXP; }
109
110 //-------------------------------------------------------------------
111 // RealLast : Returns the maximum value of a real
112 //-------------------------------------------------------------------
113 inline Standard_Real     RealLast() 
114 { return  DBL_MAX; }
115
116 //-------------------------------------------------------------------
117 // RealLast10Exp : Returns the maximum value of exponent(base 10) of
118 //                 a real.
119 //-------------------------------------------------------------------
120 inline Standard_Integer  RealLast10Exp() 
121 { return  DBL_MAX_10_EXP; }
122
123 //-------------------------------------------------------------------
124 // RealMantissa : Returns the size in bits of the matissa part of a 
125 //                real.
126 //-------------------------------------------------------------------
127 inline Standard_Integer  RealMantissa() 
128 { return  DBL_MANT_DIG; }
129
130 //-------------------------------------------------------------------
131 // RealRadix : Returns the radix of exponent representation
132 //-------------------------------------------------------------------
133 inline Standard_Integer  RealRadix() 
134 { return  FLT_RADIX; }
135
136 //-------------------------------------------------------------------
137 // RealSize : Returns the size in bits of an integer
138 //-------------------------------------------------------------------
139 inline Standard_Integer  RealSize() 
140 { return BITS(Standard_Real); }
141
142
143
144          //=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=//
145          //   End of machine-dependant values   //
146          //=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=//
147
148
149 //-------------------------------------------------------------------
150 // IntToReal : Converts an integer in a real
151 //-------------------------------------------------------------------
152 inline Standard_Real     IntToReal(const Standard_Integer Value) 
153 { return Value; }
154
155 //-------------------------------------------------------------------
156 // ATan : Returns the value of the arc tangent of a real
157 //-------------------------------------------------------------------
158 inline Standard_Real     ATan(const Standard_Real Value) 
159 { return atan(Value); }
160
161
162 //-------------------------------------------------------------------
163 // Ceiling : Returns the smallest integer not less than a real
164 //-------------------------------------------------------------------
165 inline Standard_Real     Ceiling (const Standard_Real Value) 
166 { return ceil(Value); }
167
168 //-------------------------------------------------------------------
169 // Cos : Returns the cosine of a real
170 //-------------------------------------------------------------------
171 inline Standard_Real     Cos (const Standard_Real Value) 
172 { return cos(Value); }
173
174 //-------------------------------------------------------------------
175 // Cosh : Returns the hyperbolic cosine of a real
176 //-------------------------------------------------------------------
177 inline Standard_Real     Cosh (const Standard_Real Value) 
178 { return cosh(Value); }
179
180
181 //-------------------------------------------------------------------
182 // Epsilon : The function returns absolute value of difference
183 //           between 'Value' and other nearest value of
184 //           Standard_Real type.
185 //           Nearest value is choseen in direction of infinity
186 //           the same sign as 'Value'.
187 //           If 'Value' is 0 then returns minimal positive value
188 //           of Standard_Real type.
189 //-------------------------------------------------------------------
190 inline Standard_Real     Epsilon (const Standard_Real Value) 
191 {
192   Standard_Real aEpsilon;
193
194   if (Value>=0.0){
195     aEpsilon = NextAfter(Value, RealLast()) - Value;
196   } else {
197     aEpsilon = Value - NextAfter(Value, RealFirst());
198   }
199   return aEpsilon;
200 }
201
202 //-------------------------------------------------------------------
203 // Exp : Returns the exponential function of a real
204 //-------------------------------------------------------------------
205 inline Standard_Real     Exp (const Standard_Real Value) 
206 { return exp(Value); }
207
208 //-------------------------------------------------------------------
209 // Floor : Return the largest integer not greater than a real
210 //-------------------------------------------------------------------
211 inline Standard_Real     Floor (const Standard_Real Value) 
212 { return floor(Value); }
213
214 //-------------------------------------------------------------------
215 // IntegerPart : Returns the integer part of a real
216 //-------------------------------------------------------------------
217 inline Standard_Real     IntegerPart (const Standard_Real Value) 
218 { return ( (Value>0) ? floor(Value) : ceil(Value) ); }
219
220
221 //-------------------------------------------------------------------
222 // Log10 : Returns the base-10 logarithm of a real 
223 //-------------------------------------------------------------------
224 inline Standard_Real     Log10 (const Standard_Real Value) 
225 { return log10(Value); }
226
227 //-------------------------------------------------------------------
228 // Max : Returns the maximum value of two reals
229 //-------------------------------------------------------------------
230 inline Standard_Real     Max (const Standard_Real Val1, 
231                               const Standard_Real Val2) 
232 {
233   return Val1 >= Val2 ? Val1 : Val2;
234 }
235
236 //-------------------------------------------------------------------
237 // Min : Returns the minimum value of two reals
238 //-------------------------------------------------------------------
239 inline Standard_Real     Min (const Standard_Real Val1, 
240                               const Standard_Real Val2)
241 {
242   return Val1 <= Val2 ? Val1 : Val2;
243 }
244
245 //-------------------------------------------------------------------
246 // Pow : Returns a real to a given power
247 //-------------------------------------------------------------------
248 inline Standard_Real     Pow (const Standard_Real Value, const Standard_Real P)
249 { return pow(Value,P); }
250
251 //-------------------------------------------------------------------
252 // RealPart : Returns the fractional part of a real.
253 //-------------------------------------------------------------------
254 inline  Standard_Real    RealPart (const Standard_Real Value) 
255 { return fabs(IntegerPart(Value) - Value); }
256
257 //-------------------------------------------------------------------
258 // RealToInt : Returns the real converted to nearest valid integer.
259 //             If input value is out of valid range for integers,
260 //             minimal or maximal possible integer is returned.
261 //-------------------------------------------------------------------
262 inline  Standard_Integer RealToInt (const Standard_Real Value) 
263
264   // Note that on WNT under MS VC++ 8.0 conversion of double value less 
265   // than INT_MIN or greater than INT_MAX to integer will cause signal 
266   // "Floating point multiple trap" (OCC17861)
267   return Value < INT_MIN ? INT_MIN
268     : Value > INT_MAX ? INT_MAX
269     : (Standard_Integer)Value;
270 }
271
272 // =======================================================================
273 // function : RealToShortReal
274 // purpose  : Converts Standard_Real value to the nearest valid
275 //            Standard_ShortReal. If input value is out of valid range
276 //            for Standard_ShortReal, minimal or maximal
277 //            Standard_ShortReal is returned.
278 // =======================================================================
279 inline Standard_ShortReal RealToShortReal (const Standard_Real theVal)
280 {
281   return theVal < -FLT_MAX ? -FLT_MAX
282     : theVal > FLT_MAX ? FLT_MAX
283     : (Standard_ShortReal)theVal;
284 }
285
286 //-------------------------------------------------------------------
287 // Round : Returns the nearest integer of a real
288 //-------------------------------------------------------------------
289 inline Standard_Real     Round (const Standard_Real Value) 
290 { return IntegerPart(Value + (Value > 0 ? 0.5 : -0.5)); }
291
292 //-------------------------------------------------------------------
293 // Sin : Returns the sine of a real
294 //-------------------------------------------------------------------
295 inline Standard_Real     Sin (const Standard_Real Value) 
296 { return sin(Value); }
297
298 //-------------------------------------------------------------------
299 // Sinh : Returns the hyperbolic sine of a real
300 //-------------------------------------------------------------------
301 inline Standard_Real     Sinh(const Standard_Real Value) 
302 { return sinh(Value); }
303
304 //-------------------------------------------------------------------
305 // ASinh : Returns the hyperbolic arc sine of a real
306 //-------------------------------------------------------------------
307 inline Standard_Real     ASinh(const Standard_Real Value) 
308 { return asinh(Value); }
309
310 //-------------------------------------------------------------------
311 // Square : Returns a real to the power 2
312 //-------------------------------------------------------------------
313 inline Standard_Real     Square(const Standard_Real Value) 
314 { return Value * Value; }
315
316 //-------------------------------------------------------------------
317 // Tan : Returns the tangent of a real
318 //-------------------------------------------------------------------
319 inline Standard_Real     Tan (const Standard_Real Value) 
320 { return tan(Value); }
321
322 //-------------------------------------------------------------------
323 // Tanh : Returns the hyperbolic tangent of a real
324 //-------------------------------------------------------------------
325 inline Standard_Real     Tanh (const Standard_Real Value) 
326 { return tanh(Value); }
327
328 #endif