include/cln/lfloat.h

   1 // Public long float operations.
   2
   3 #ifndef _CL_LFLOAT_H
   4 #define _CL_LFLOAT_H
   5
   6 #include "cln/number.h"
   7 #include "cln/lfloat_class.h"
   8 #include "cln/integer_class.h"
   9 #include "cln/float.h"
  10
  11 namespace cln {
  12
  13 CL_DEFINE_AS_CONVERSION(cl_LF)
  14
  15
  16 // Liefert zu einem Long-Float x : (- x), ein LF.
  17 extern const cl_LF operator- (const cl_LF& x);
  18
  19 // compare(x,y) vergleicht zwei Long-Floats x und y.
  20 // Ergebnis: 0 falls x=y, +1 falls x>y, -1 falls x<y.
  21 extern cl_signean compare (const cl_LF& x, const cl_LF& y);
  22
  23 // equal_hashcode(x) liefert einen equal-invarianten Hashcode für x.
  24 extern uint32 equal_hashcode (const cl_LF& x);
  25
  26 inline bool operator== (const cl_LF& x, const cl_LF& y)
  27         { return compare(x,y)==0; }
  28 inline bool operator!= (const cl_LF& x, const cl_LF& y)
  29         { return compare(x,y)!=0; }
  30 inline bool operator<= (const cl_LF& x, const cl_LF& y)
  31         { return compare(x,y)<=0; }
  32 inline bool operator< (const cl_LF& x, const cl_LF& y)
  33         { return compare(x,y)<0; }
  34 inline bool operator>= (const cl_LF& x, const cl_LF& y)
  35         { return compare(x,y)>=0; }
  36 inline bool operator> (const cl_LF& x, const cl_LF& y)
  37         { return compare(x,y)>0; }
  38
  39 // minusp(x) == (< x 0)
  40 extern bool minusp (const cl_LF& x);
  41
  42 // zerop(x) stellt fest, ob ein Long-Float x = 0.0 ist.
  43 extern bool zerop (const cl_LF& x);
  44
  45 // plusp(x) == (> x 0)
  46 extern bool plusp (const cl_LF& x);
  47
  48 // Liefert zu zwei Long-Float x und y : (+ x y), ein LF.
  49 extern const cl_LF operator+ (const cl_LF& x, const cl_LF& y);
  50
  51 // Liefert zu zwei Long-Float x und y : (- x y), ein LF.
  52 extern const cl_LF operator- (const cl_LF& x, const cl_LF& y);
  53
  54 // Liefert zu zwei Long-Float x und y : (* x y), ein LF.
  55 extern const cl_LF operator* (const cl_LF& x, const cl_LF& y);
  56 // Spezialfall x oder y Integer oder rationale Zahl.
  57 inline const cl_R operator* (const cl_LF& x, const cl_I& y)
  58 {
  59         extern const cl_R cl_LF_I_mul (const cl_LF&, const cl_I&);
  60         return cl_LF_I_mul(x,y);
  61 }
  62 inline const cl_R operator* (const cl_I& x, const cl_LF& y)
  63 {
  64         extern const cl_R cl_LF_I_mul (const cl_LF&, const cl_I&);
  65         return cl_LF_I_mul(y,x);
  66 }
  67 inline const cl_R operator* (const cl_LF& x, const cl_RA& y)
  68 {
  69         extern const cl_R cl_LF_RA_mul (const cl_LF&, const cl_RA&);
  70         return cl_LF_RA_mul(x,y);
  71 }
  72 inline const cl_R operator* (const cl_RA& x, const cl_LF& y)
  73 {
  74         extern const cl_R cl_LF_RA_mul (const cl_LF&, const cl_RA&);
  75         return cl_LF_RA_mul(y,x);
  76 }
  77 // Dem C++-Compiler muß man auch das Folgende sagen (wg. `int * cl_LF' u.ä.):
  78 inline const cl_R operator* (const int x, const cl_LF& y)
  79         { return cl_I(x) * y; }
  80 inline const cl_R operator* (const unsigned int x, const cl_LF& y)
  81         { return cl_I(x) * y; }
  82 inline const cl_R operator* (const long x, const cl_LF& y)
  83         { return cl_I(x) * y; }
  84 inline const cl_R operator* (const unsigned long x, const cl_LF& y)
  85         { return cl_I(x) * y; }
  86 inline const cl_R operator* (const long long x, const cl_LF& y)
  87         { return cl_I(x) * y; }
  88 inline const cl_R operator* (const unsigned long long x, const cl_LF& y)
  89         { return cl_I(x) * y; }
  90 inline const cl_R operator* (const cl_LF& x, const int y)
  91         { return x * cl_I(y); }
  92 inline const cl_R operator* (const cl_LF& x, const unsigned int y)
  93         { return x * cl_I(y); }
  94 inline const cl_R operator* (const cl_LF& x, const long y)
  95         { return x * cl_I(y); }
  96 inline const cl_R operator* (const cl_LF& x, const unsigned long y)
  97         { return x * cl_I(y); }
  98 inline const cl_R operator* (const cl_LF& x, const long long y)
  99         { return x * cl_I(y); }
 100 inline const cl_R operator* (const cl_LF& x, const unsigned long long y)
 101         { return x * cl_I(y); }
 102 // Spezialfall x = y.
 103 // Liefert zu einem Long-Float x : (* x x), ein LF.
 104 extern const cl_LF square (const cl_LF& x);
 105
 106 // Liefert zu zwei Long-Float x und y : (/ x y), ein LF.
 107 extern const cl_LF operator/ (const cl_LF& x, const cl_LF& y);
 108 // Spezialfall x oder y Integer oder rationale Zahl.
 109 inline const cl_LF operator/ (const cl_LF& x, const cl_I& y)
 110 {
 111         extern const cl_LF cl_LF_I_div (const cl_LF& x, const cl_I& y);
 112         return cl_LF_I_div(x,y);
 113 }
 114 inline const cl_R operator/ (const cl_I& x, const cl_LF& y)
 115 {
 116         extern const cl_R cl_I_LF_div (const cl_I& x, const cl_LF& y);
 117         return cl_I_LF_div(x,y);
 118 }
 119 inline const cl_LF operator/ (const cl_LF& x, const cl_RA& y)
 120 {
 121         extern const cl_LF cl_LF_RA_div (const cl_LF& x, const cl_RA& y);
 122         return cl_LF_RA_div(x,y);
 123 }
 124 inline const cl_R operator/ (const cl_RA& x, const cl_LF& y)
 125 {
 126         extern const cl_R cl_RA_LF_div (const cl_RA& x, const cl_LF& y);
 127         return cl_RA_LF_div(x,y);
 128 }
 129 // Dem C++-Compiler muß man nun auch das Folgende sagen:
 130 inline const cl_LF operator/ (const cl_LF& x, const int y)
 131         { return x / cl_I(y); }
 132 inline const cl_LF operator/ (const cl_LF& x, const unsigned int y)
 133         { return x / cl_I(y); }
 134 inline const cl_LF operator/ (const cl_LF& x, const long y)
 135         { return x / cl_I(y); }
 136 inline const cl_LF operator/ (const cl_LF& x, const unsigned long y)
 137         { return x / cl_I(y); }
 138 inline const cl_LF operator/ (const cl_LF& x, const long long y)
 139         { return x / cl_I(y); }
 140 inline const cl_LF operator/ (const cl_LF& x, const unsigned long long y)
 141         { return x / cl_I(y); }
 142 inline const cl_R operator/ (const int x, const cl_LF& y)
 143         { return cl_I(x) / y; }
 144 inline const cl_R operator/ (const unsigned int x, const cl_LF& y)
 145         { return cl_I(x) / y; }
 146 inline const cl_R operator/ (const long x, const cl_LF& y)
 147         { return cl_I(x) / y; }
 148 inline const cl_R operator/ (const unsigned long x, const cl_LF& y)
 149         { return cl_I(x) / y; }
 150 inline const cl_R operator/ (const long long x, const cl_LF& y)
 151         { return cl_I(x) / y; }
 152 inline const cl_R operator/ (const unsigned long long x, const cl_LF& y)
 153         { return cl_I(x) / y; }
 154
 155 // Liefert zu einem Long-Float x>=0 : (sqrt x), ein LF.
 156 extern const cl_LF sqrt (const cl_LF& x);
 157
 158 // recip(x) liefert (/ x), wo x ein Long-Float ist.
 159 extern const cl_LF recip (const cl_LF& x);
 160
 161 // abs(x) liefert (abs x), wo x ein Long-Float ist.
 162 extern const cl_LF abs (const cl_LF& x);
 163
 164
 165 // (1+ x), wo x ein Long-Float ist.
 166 extern const cl_LF plus1 (const cl_LF& x);
 167
 168 // (1- x), wo x ein Long-Float ist.
 169 extern const cl_LF minus1 (const cl_LF& x);
 170
 171
 172 // ffloor(x) liefert (ffloor x), wo x ein LF ist.
 173 extern const cl_LF ffloor (const cl_LF& x);
 174
 175 // fceiling(x) liefert (fceiling x), wo x ein LF ist.
 176 extern const cl_LF fceiling (const cl_LF& x);
 177
 178 // ftruncate(x) liefert (ftruncate x), wo x ein LF ist.
 179 extern const cl_LF ftruncate (const cl_LF& x);
 180
 181 // fround(x) liefert (fround x), wo x ein LF ist.
 182 extern const cl_LF fround (const cl_LF& x);
 183
 184
 185 // Return type for frounding operators.
 186 // x / y  --> (q,r) with x = y*q+r.
 187 struct cl_LF_fdiv_t {
 188         cl_LF quotient;
 189         cl_LF remainder;
 190 // Constructor.
 191         cl_LF_fdiv_t () {}
 192         cl_LF_fdiv_t (const cl_LF& q, const cl_LF& r) : quotient(q), remainder(r) {}
 193 };
 194
 195 // ffloor2(x) liefert (ffloor x), wo x ein LF ist.
 196 inline const cl_LF_fdiv_t ffloor2 (const cl_LF& x)
 197 {
 198         extern const cl_LF LF_LF_minus_LF (const cl_LF&, const cl_LF&);
 199         cl_LF q = ffloor(x);
 200         return cl_LF_fdiv_t(q,LF_LF_minus_LF(x,q));
 201 }
 202
 203 // fceiling2(x) liefert (fceiling x), wo x ein LF ist.
 204 inline const cl_LF_fdiv_t fceiling2 (const cl_LF& x)
 205 {
 206         extern const cl_LF LF_LF_minus_LF (const cl_LF&, const cl_LF&);
 207         cl_LF q = fceiling(x);
 208         return cl_LF_fdiv_t(q,LF_LF_minus_LF(x,q));
 209 }
 210
 211 // ftruncate2(x) liefert (ftruncate x), wo x ein LF ist.
 212 inline const cl_LF_fdiv_t ftruncate2 (const cl_LF& x)
 213 {
 214         extern const cl_LF LF_LF_minus_LF (const cl_LF&, const cl_LF&);
 215         cl_LF q = ftruncate(x);
 216         return cl_LF_fdiv_t(q,LF_LF_minus_LF(x,q));
 217 }
 218
 219 // fround2(x) liefert (fround x), wo x ein LF ist.
 220 inline const cl_LF_fdiv_t fround2 (const cl_LF& x)
 221 {
 222         extern const cl_LF LF_LF_minus_LF (const cl_LF&, const cl_LF&);
 223         cl_LF q = fround(x);
 224         return cl_LF_fdiv_t(q,LF_LF_minus_LF(x,q));
 225 }
 226
 227
 228 // Return type for rounding operators.
 229 // x / y  --> (q,r) with x = y*q+r.
 230 struct cl_LF_div_t {
 231         cl_I quotient;
 232         cl_LF remainder;
 233 // Constructor.
 234         cl_LF_div_t () {}
 235         cl_LF_div_t (const cl_I& q, const cl_LF& r) : quotient(q), remainder(r) {}
 236 };
 237
 238 // floor2(x) liefert (floor x), wo x ein LF ist.
 239 inline const cl_LF_div_t floor2 (const cl_LF& x)
 240 {
 241         extern const cl_LF LF_LF_minus_LF (const cl_LF&, const cl_LF&);
 242         extern const cl_I cl_LF_to_I (const cl_LF& x);
 243         cl_LF q = ffloor(x);
 244         return cl_LF_div_t(cl_LF_to_I(q),LF_LF_minus_LF(x,q));
 245 }
 246 inline const cl_I floor1 (const cl_LF& x)
 247 {
 248         extern const cl_I cl_LF_to_I (const cl_LF& x);
 249         return cl_LF_to_I(ffloor(x));
 250 }
 251
 252 // ceiling2(x) liefert (ceiling x), wo x ein LF ist.
 253 inline const cl_LF_div_t ceiling2 (const cl_LF& x)
 254 {
 255         extern const cl_LF LF_LF_minus_LF (const cl_LF&, const cl_LF&);
 256         extern const cl_I cl_LF_to_I (const cl_LF& x);
 257         cl_LF q = fceiling(x);
 258         return cl_LF_div_t(cl_LF_to_I(q),LF_LF_minus_LF(x,q));
 259 }
 260 inline const cl_I ceiling1 (const cl_LF& x)
 261 {
 262         extern const cl_I cl_LF_to_I (const cl_LF& x);
 263         return cl_LF_to_I(fceiling(x));
 264 }
 265
 266 // truncate2(x) liefert (truncate x), wo x ein LF ist.
 267 inline const cl_LF_div_t truncate2 (const cl_LF& x)
 268 {
 269         extern const cl_LF LF_LF_minus_LF (const cl_LF&, const cl_LF&);
 270         extern const cl_I cl_LF_to_I (const cl_LF& x);
 271         cl_LF q = ftruncate(x);
 272         return cl_LF_div_t(cl_LF_to_I(q),LF_LF_minus_LF(x,q));
 273 }
 274 inline const cl_I truncate1 (const cl_LF& x)
 275 {
 276         extern const cl_I cl_LF_to_I (const cl_LF& x);
 277         return cl_LF_to_I(ftruncate(x));
 278 }
 279
 280 // round2(x) liefert (round x), wo x ein LF ist.
 281 inline const cl_LF_div_t round2 (const cl_LF& x)
 282 {
 283         extern const cl_LF LF_LF_minus_LF (const cl_LF&, const cl_LF&);
 284         extern const cl_I cl_LF_to_I (const cl_LF& x);
 285         cl_LF q = fround(x);
 286         return cl_LF_div_t(cl_LF_to_I(q),LF_LF_minus_LF(x,q));
 287 }
 288 inline const cl_I round1 (const cl_LF& x)
 289 {
 290         extern const cl_I cl_LF_to_I (const cl_LF& x);
 291         return cl_LF_to_I(fround(x));
 292 }
 293
 294 // floor2(x,y) liefert (floor x y).
 295 extern const cl_LF_div_t floor2 (const cl_LF& x, const cl_LF& y);
 296 inline const cl_I floor1 (const cl_LF& x, const cl_LF& y) { return floor1(x/y); }
 297
 298 // ceiling2(x,y) liefert (ceiling x y).
 299 extern const cl_LF_div_t ceiling2 (const cl_LF& x, const cl_LF& y);
 300 inline const cl_I ceiling1 (const cl_LF& x, const cl_LF& y) { return ceiling1(x/y); }
 301
 302 // truncate2(x,y) liefert (truncate x y).
 303 extern const cl_LF_div_t truncate2 (const cl_LF& x, const cl_LF& y);
 304 inline const cl_I truncate1 (const cl_LF& x, const cl_LF& y) { return truncate1(x/y); }
 305
 306 // round2(x,y) liefert (round x y).
 307 extern const cl_LF_div_t round2 (const cl_LF& x, const cl_LF& y);
 308 inline const cl_I round1 (const cl_LF& x, const cl_LF& y) { return round1(x/y); }
 309
 310
 311 // cl_float(x,y) returns a long float if y is a long float.
 312 inline const cl_LF cl_float (const cl_F& x, const cl_LF& y)
 313 {
 314         extern const cl_F cl_float (const cl_F& x, const cl_F& y);
 315         return The(cl_LF)(cl_float(x,(const cl_F&)y));
 316 }
 317 inline const cl_LF cl_float (const cl_I& x, const cl_LF& y)
 318 {
 319         extern const cl_F cl_float (const cl_I& x, const cl_F& y);
 320         return The(cl_LF)(cl_float(x,(const cl_F&)y));
 321 }
 322 inline const cl_LF cl_float (const cl_RA& x, const cl_LF& y)
 323 {
 324         extern const cl_F cl_float (const cl_RA& x, const cl_F& y);
 325         return The(cl_LF)(cl_float(x,(const cl_F&)y));
 326 }
 327 inline const cl_LF cl_float (int x, const cl_LF& y)
 328         { return cl_float(cl_I(x),y); }
 329 inline const cl_LF cl_float (unsigned int x, const cl_LF& y)
 330         { return cl_float(cl_I(x),y); }
 331
 332
 333 // Return type for decode_float:
 334 struct decoded_lfloat {
 335         cl_LF mantissa;
 336         cl_I exponent;
 337         cl_LF sign;
 338 // Constructor.
 339         decoded_lfloat () {}
 340         decoded_lfloat (const cl_LF& m, const cl_I& e, const cl_LF& s) : mantissa(m), exponent(e), sign(s) {}
 341 };
 342
 343 // decode_float(x) liefert zu einem Float x: (decode-float x).
 344 // x = 0.0 liefert (0.0, 0, 1.0).
 345 // x = (-1)^s * 2^e * m liefert ((-1)^0 * 2^0 * m, e als Integer, (-1)^s).
 346 extern const decoded_lfloat decode_float (const cl_LF& x);
 347
 348 // float_exponent(x) liefert zu einem Float x:
 349 // den Exponenten von (decode-float x).
 350 // x = 0.0 liefert 0.
 351 // x = (-1)^s * 2^e * m liefert e.
 352 extern sintE float_exponent (const cl_LF& x);
 353
 354 // float_radix(x) liefert (float-radix x), wo x ein Float ist.
 355 inline sintL float_radix (const cl_LF& x)
 356 {
 357         (void)x; // unused x
 358         return 2;
 359 }
 360
 361 // float_sign(x) liefert (float-sign x), wo x ein Float ist.
 362 extern const cl_LF float_sign (const cl_LF& x);
 363
 364 // float_digits(x) liefert (float-digits x), wo x ein Float ist.
 365 // < ergebnis: ein uintC >0
 366 extern uintC float_digits (const cl_LF& x);
 367
 368 // float_precision(x) liefert (float-precision x), wo x ein Float ist.
 369 // < ergebnis: ein uintC >=0
 370 extern uintC float_precision (const cl_LF& x);
 371
 372
 373 // integer_decode_float(x) liefert zu einem Float x: (integer-decode-float x).
 374 // x = 0.0 liefert (0, 0, 1).
 375 // x = (-1)^s * 2^e * m bei Float-Precision p liefert
 376 //   (Mantisse 2^p * m als Integer, e-p als Integer, (-1)^s als Fixnum).
 377 extern const cl_idecoded_float integer_decode_float (const cl_LF& x);
 378
 379
 380 // scale_float(x,delta) liefert x*2^delta, wo x ein LF ist.
 381 extern const cl_LF scale_float (const cl_LF& x, sintC delta);
 382 extern const cl_LF scale_float (const cl_LF& x, const cl_I& delta);
 383
 384
 385 // max(x,y) liefert (max x y), wo x und y Floats sind.
 386 extern const cl_LF max (const cl_LF& x, const cl_LF& y);
 387
 388 // min(x,y) liefert (min x y), wo x und y Floats sind.
 389 extern const cl_LF min (const cl_LF& x, const cl_LF& y);
 390
 391 // signum(x) liefert (signum x), wo x ein Float ist.
 392 extern const cl_LF signum (const cl_LF& x);
 393
 394
 395 // Konversion zu einem C "float".
 396 extern float float_approx (const cl_LF& x);
 397
 398 // Konversion zu einem C "double".
 399 extern double double_approx (const cl_LF& x);
 400
 401
 402 // This could be optimized to use in-place operations.
 403 inline cl_LF& operator+= (cl_LF& x, const cl_LF& y) { return x = x + y; }
 404 inline cl_LF& operator++ /* prefix */ (cl_LF& x) { return x = plus1(x); }
 405 inline void operator++ /* postfix */ (cl_LF& x, int dummy) { (void)dummy; x = plus1(x); }
 406 inline cl_LF& operator-= (cl_LF& x, const cl_LF& y) { return x = x - y; }
 407 inline cl_LF& operator-- /* prefix */ (cl_LF& x) { return x = minus1(x); }
 408 inline void operator-- /* postfix */ (cl_LF& x, int dummy) { (void)dummy; x = minus1(x); }
 409 inline cl_LF& operator*= (cl_LF& x, const cl_LF& y) { return x = x * y; }
 410 inline cl_LF& operator/= (cl_LF& x, const cl_LF& y) { return x = x / y; }
 411
 412
 413 // Runtime typing support.
 414 extern cl_class cl_class_lfloat;
 415
 416
 417 // Debugging support.
 418 #ifdef CL_DEBUG
 419 extern int cl_LF_debug_module;
 420 CL_FORCE_LINK(cl_LF_debug_dummy, cl_LF_debug_module)
 421 #endif
 422
 423 }  // namespace cln
 424
 425 #endif /* _CL_LFLOAT_H */