src/float/dfloat/elem/cl_DF_plus.cc

   1 // binary operator +
   2
   3 // General includes.
   4 #include "base/cl_sysdep.h"
   5
   6 // Specification.
   7 #include "cln/dfloat.h"
   8
   9
  10 // Implementation.
  11
  12 #include "float/dfloat/cl_DF.h"
  13 #include "float/cl_F.h"
  14 #include "base/cl_xmacros.h"
  15
  16 namespace cln {
  17
  18
  19 const cl_DF operator+ (const cl_DF& x1, const cl_DF& x2)
  20 {
  21 // Methode (nach [Knuth, II, Seminumerical Algorithms, Abschnitt 4.2.1., S.200]):
  22 // x1=0.0 -> Ergebnis x2.
  23 // x2=0.0 -> Ergebnis x1.
  24 // Falls e1<e2, vertausche x1 und x2.
  25 // Also e1 >= e2.
  26 // Falls e1 - e2 >= 52 + 3, Ergebnis x1.
  27 // Schiebe beide Mantissen um 3 Bits nach links (Vorbereitung der Rundung:
  28 //   Bei e1-e2=0,1 ist keine Rundung nötig, bei e1-e2>1 ist der Exponent des
  29 //   Ergebnisses =e1-1, =e1 oder =e1+1. Brauche daher 1 Schutzbit und zwei
  30 //   Rundungsbits: 00 exakt, 01 1.Hälfte, 10 exakte Mitte, 11 2.Hälfte.)
  31 // Schiebe die Mantisse von x2 um e0-e1 Bits nach rechts. (Dabei die Rundung
  32 // ausführen: Bit 0 ist das logische Oder der Bits 0,-1,-2,...)
  33 // Falls x1,x2 selbes Vorzeichen haben: Addiere dieses zur Mantisse von x1.
  34 // Falls x1,x2 verschiedenes Vorzeichen haben: Subtrahiere dieses von der
  35 //   Mantisse von x1. <0 -> (Es war e1=e2) Vertausche die Vorzeichen, negiere.
  36 //                    =0 -> Ergebnis 0.0
  37 // Exponent ist e1.
  38 // Normalisiere, fertig.
  39 #ifdef FAST_DOUBLE
  40       double_to_DF(DF_to_double(x1) + DF_to_double(x2), return ,
  41                    TRUE, TRUE, // Overflow und subnormale Zahl abfangen
  42                    FALSE, // kein Underflow mit Ergebnis +/- 0.0 möglich
  43                           // (nach Definition der subnormalen Zahlen)
  44                    FALSE, FALSE // keine Singularität, kein NaN als Ergebnis möglich
  45                   );
  46 #else
  47 #if (cl_word_size==64)
  48       // x1,x2 entpacken:
  49       var cl_signean sign1;
  50       var sintL exp1;
  51       var uint64 mant1;
  52       var cl_signean sign2;
  53       var sintL exp2;
  54       var uint64 mant2;
  55       DF_decode(x1, { return x2; }, sign1=,exp1=,mant1=);
  56       DF_decode(x2, { return x1; }, sign2=,exp2=,mant2=);
  57       var cl_DF max_x1_x2 = x1;
  58       if (exp1 < exp2)
  59         { max_x1_x2 = x2;
  60           swap(cl_signean, sign1,sign2);
  61           swap(sintL,      exp1 ,exp2 );
  62           swap(uint64,     mant1,mant2);
  63         }
  64       // Nun ist exp1>=exp2.
  65       var uintL expdiff = exp1 - exp2; // Exponentendifferenz
  66       if (expdiff >= DF_mant_len+3) // >= 52+3 ?
  67         { return max_x1_x2; }
  68       mant1 = mant1 << 3; mant2 = mant2 << 3;
  69       // Nun 2^(DF_mant_len+3) <= mant1,mant2 < 2^(DF_mant_len+4).
  70       {var uint64 mant2_last = mant2 & (bit(expdiff)-1); // letzte expdiff Bits von mant2
  71        mant2 = mant2 >> expdiff; if (!(mant2_last==0)) { mant2 |= bit(0); }
  72       }
  73       // mant2 = um expdiff Bits nach rechts geschobene und gerundete Mantisse
  74       // von x2.
  75       if (!(sign1==sign2))
  76         // verschiedene Vorzeichen -> Mantissen subtrahieren
  77         { if (mant1 > mant2) { mant1 = mant1 - mant2; goto norm_2; }
  78           if (mant1 == mant2) // Ergebnis 0 ?
  79             { return cl_DF_0; }
  80           // negatives Subtraktionsergebnis
  81           mant1 = mant2 - mant1; sign1 = sign2; goto norm_2;
  82         }
  83         else
  84         // gleiche Vorzeichen -> Mantissen addieren
  85         { mant1 = mant1 + mant2; }
  86       // mant1 = Ergebnis-Mantisse >0, sign1 = Ergebnis-Vorzeichen,
  87       // exp1 = Ergebnis-Exponent.
  88       // Außerdem: Bei expdiff=0,1 sind die zwei letzten Bits von mant1 Null,
  89       // bei expdiff>=2 ist mant1 >= 2^(DF_mant_len+2).
  90       // Stets ist mant1 < 2^(DF_mant_len+5). (Daher werden die 2 Rundungsbits
  91       // nachher um höchstens eine Position nach links geschoben werden.)
  92       // [Knuth, S.201, leicht modifiziert:
  93       //   N1. m>=1 -> goto N4.
  94       //   N2. [Hier m<1] m>=1/2 -> goto N5.
  95       //       N3. m:=2*m, e:=e-1, goto N2.
  96       //   N4. [Hier 1<=m<2] m:=m/2, e:=e+1.
  97       //   N5. [Hier 1/2<=m<1] Runde m auf 53 Bits hinterm Komma.
  98       //       Falls hierdurch m=1 geworden, setze m:=m/2, e:=e+1.
  99       // ]
 100       // Bei uns ist m=mant1/2^(DF_mant_len+4),
 101       // ab Schritt N5 ist m=mant1/2^(DF_mant_len+1).
 102       norm_1: // [Knuth, S.201, Schritt N1]
 103       if (mant1 >= bit(DF_mant_len+4)) goto norm_4;
 104       norm_2: // [Knuth, S.201, Schritt N2]
 105               // Hier ist mant1 < 2^(DF_mant_len+4)
 106       if (mant1 >= bit(DF_mant_len+3)) goto norm_5;
 107       // [Knuth, S.201, Schritt N3]
 108       mant1 = mant1 << 1; exp1 = exp1-1; // Mantisse links schieben
 109       goto norm_2;
 110       norm_4: // [Knuth, S.201, Schritt N4]
 111               // Hier ist 2^(DF_mant_len+4) <= mant1 < 2^(DF_mant_len+5)
 112       exp1 = exp1+1;
 113       mant1 = (mant1>>1) | (mant1 & bit(0)); // Mantisse rechts schieben
 114       norm_5: // [Knuth, S.201, Schritt N5]
 115               // Hier ist 2^(DF_mant_len+3) <= mant1 < 2^(DF_mant_len+4)
 116       // Auf DF_mant_len echte Mantissenbits runden, d.h. rechte 3 Bits
 117       // wegrunden, und dabei mant1 um 3 Bits nach rechts schieben:
 118       {var uint64 rounding_bits = mant1 & (bit(3)-1);
 119        mant1 = mant1 >> 3;
 120        if ( (rounding_bits < bit(2)) // 000,001,010,011 werden abgerundet
 121             || ( (rounding_bits == bit(2)) // 100 (genau halbzahlig)
 122                  && ((mant1 & bit(0)) ==0) // -> round-to-even
 123           )    )
 124          // abrunden
 125          {}
 126          else
 127          // aufrunden
 128          { mant1 = mant1+1;
 129            if (mant1 >= bit(DF_mant_len+1))
 130              // Bei Überlauf während der Rundung nochmals rechts schieben
 131              // (Runden ist hier überflüssig):
 132              { mant1 = mant1>>1; exp1 = exp1+1; } // Mantisse rechts schieben
 133          }
 134       }// Runden fertig
 135       return encode_DF(sign1,exp1,mant1);
 136 #else
 137       // x1,x2 entpacken:
 138       var cl_signean sign1;
 139       var sintL exp1;
 140       var uintL manthi1;
 141       var uintL mantlo1;
 142       var cl_signean sign2;
 143       var sintL exp2;
 144       var uintL manthi2;
 145       var uintL mantlo2;
 146       DF_decode2(x1, { return x2; }, sign1=,exp1=,manthi1=,mantlo1=);
 147       DF_decode2(x2, { return x1; }, sign2=,exp2=,manthi2=,mantlo2=);
 148       var cl_DF max_x1_x2 = x1;
 149       if (exp1 < exp2)
 150         { max_x1_x2 = x2;
 151           swap(cl_signean, sign1,sign2);
 152           swap(sintL,      exp1 ,exp2 );
 153           swap(uintL,      manthi1,manthi2);
 154           swap(uintL,      mantlo1,mantlo2);
 155         }
 156       // Nun ist exp1>=exp2.
 157       var uintL expdiff = exp1 - exp2; // Exponentendifferenz
 158       if (expdiff >= DF_mant_len+3) // >= 52+3 ?
 159         { return max_x1_x2; }
 160       manthi1 = (manthi1 << 3) | (mantlo1 >> (32-3)); mantlo1 = mantlo1 << 3;
 161       manthi2 = (manthi2 << 3) | (mantlo2 >> (32-3)); mantlo2 = mantlo2 << 3;
 162       // Nun 2^(DF_mant_len+3) <= mant1,mant2 < 2^(DF_mant_len+4).
 163       if (expdiff<32)
 164         {if (!(expdiff==0))
 165            {var uintL mant2_last = mantlo2 & (bit(expdiff)-1); // letzte expdiff Bits von mant2
 166             mantlo2 = (mantlo2 >> expdiff) | (manthi2 << (32-expdiff));
 167             manthi2 = manthi2 >> expdiff;
 168             if (!(mant2_last==0)) { mantlo2 |= bit(0); }
 169         }  }
 170         else
 171         {var uintL mant2_last = (manthi2 & (bit(expdiff-32)-1)) | mantlo2; // letzte expdiff Bits von mant2
 172          mantlo2 = manthi2 >> (expdiff-32); manthi2 = 0;
 173          if (!(mant2_last==0)) { mantlo2 |= bit(0); }
 174         }
 175       // mant2 = um expdiff Bits nach rechts geschobene und gerundete Mantisse
 176       // von x2.
 177       if (!(sign1==sign2))
 178         // verschiedene Vorzeichen -> Mantissen subtrahieren
 179         { if (manthi1 > manthi2)
 180             { manthi1 = manthi1 - manthi2;
 181               if (mantlo1 < mantlo2) { manthi1 -= 1; }
 182               mantlo1 = mantlo1 - mantlo2;
 183               goto norm_2;
 184             }
 185           if (manthi1 == manthi2)
 186             { if (mantlo1 > mantlo2)
 187                 { manthi1 = 0; mantlo1 = mantlo1 - mantlo2; goto norm_2; }
 188               if (mantlo1 == mantlo2) // Ergebnis 0 ?
 189                 { return cl_DF_0; }
 190             }
 191           // Hier ((manthi1 < manthi2) || ((manthi1 == manthi2) && (mantlo1 < mantlo2))).
 192           // negatives Subtraktionsergebnis
 193           manthi1 = manthi2 - manthi1;
 194           if (mantlo2 < mantlo1) { manthi1 -= 1; }
 195           mantlo1 = mantlo2 - mantlo1;
 196           sign1 = sign2;
 197           goto norm_2;
 198         }
 199         else
 200         // gleiche Vorzeichen -> Mantissen addieren
 201         { manthi1 = manthi1 + manthi2;
 202           if ((mantlo1 = mantlo1 + mantlo2) < mantlo2) { manthi1 += 1; }
 203         }
 204       // mant1 = Ergebnis-Mantisse >0, sign1 = Ergebnis-Vorzeichen,
 205       // exp1 = Ergebnis-Exponent.
 206       // Außerdem: Bei expdiff=0,1 sind die zwei letzten Bits von mant1 Null,
 207       // bei expdiff>=2 ist mant1 >= 2^(DF_mant_len+2).
 208       // Stets ist mant1 < 2^(DF_mant_len+5). (Daher werden die 2 Rundungsbits
 209       // nachher um höchstens eine Position nach links geschoben werden.)
 210       // [Knuth, S.201, leicht modifiziert:
 211       //   N1. m>=1 -> goto N4.
 212       //   N2. [Hier m<1] m>=1/2 -> goto N5.
 213       //       N3. m:=2*m, e:=e-1, goto N2.
 214       //   N4. [Hier 1<=m<2] m:=m/2, e:=e+1.
 215       //   N5. [Hier 1/2<=m<1] Runde m auf 53 Bits hinterm Komma.
 216       //       Falls hierdurch m=1 geworden, setze m:=m/2, e:=e+1.
 217       // ]
 218       // Bei uns ist m=mant1/2^(DF_mant_len+4),
 219       // ab Schritt N5 ist m=mant1/2^(DF_mant_len+1).
 220       norm_1: // [Knuth, S.201, Schritt N1]
 221       if (manthi1 >= bit(DF_mant_len-32+4)) goto norm_4;
 222       norm_2: // [Knuth, S.201, Schritt N2]
 223               // Hier ist mant1 < 2^(DF_mant_len+4)
 224       if (manthi1 >= bit(DF_mant_len-32+3)) goto norm_5;
 225       // [Knuth, S.201, Schritt N3]
 226       manthi1 = (manthi1 << 1) | (mantlo1 >> 31); // Mantisse links schieben
 227       mantlo1 = mantlo1 << 1;
 228       exp1 = exp1-1;
 229       goto norm_2;
 230       norm_4: // [Knuth, S.201, Schritt N4]
 231               // Hier ist 2^(DF_mant_len+4) <= mant1 < 2^(DF_mant_len+5)
 232       exp1 = exp1+1;
 233       mantlo1 = (mantlo1 >> 1) | (manthi1 << 31) | (mantlo1 & bit(0)); // Mantisse rechts schieben
 234       manthi1 = (manthi1 >> 1);
 235       norm_5: // [Knuth, S.201, Schritt N5]
 236               // Hier ist 2^(DF_mant_len+3) <= mant1 < 2^(DF_mant_len+4)
 237       // Auf DF_mant_len echte Mantissenbits runden, d.h. rechte 3 Bits
 238       // wegrunden, und dabei mant1 um 3 Bits nach rechts schieben:
 239       {var uintL rounding_bits = mantlo1 & (bit(3)-1);
 240        mantlo1 = (mantlo1 >> 3) | (manthi1 << (32-3)); manthi1 = manthi1 >> 3;
 241        if ( (rounding_bits < bit(2)) // 000,001,010,011 werden abgerundet
 242             || ( (rounding_bits == bit(2)) // 100 (genau halbzahlig)
 243                  && ((mantlo1 & bit(0)) ==0) // -> round-to-even
 244           )    )
 245          // abrunden
 246          {}
 247          else
 248          // aufrunden
 249          { mantlo1 = mantlo1+1;
 250            if (mantlo1==0)
 251              { manthi1 = manthi1+1;
 252                if (manthi1 >= bit(DF_mant_len-32+1))
 253                  // Bei Überlauf während der Rundung nochmals rechts schieben
 254                  // (Runden ist hier überflüssig):
 255                  { manthi1 = manthi1>>1; exp1 = exp1+1; } // Mantisse rechts schieben
 256          }   }
 257       }// Runden fertig
 258       return encode_DF(sign1,exp1,manthi1,mantlo1);
 259 #endif
 260 #endif
 261 }
 262
 263 }  // namespace cln