1 // Copyright (c) 2009-2010 Satoshi Nakamoto
2 // Copyright (c) 2011 The Bitcoin developers
3 // Distributed under the MIT/X11 software license, see the accompanying
4 // file license.txt or http://www.opensource.org/licenses/mit-license.php.
5 #ifndef BITCOIN_UINT256_H
6 #define BITCOIN_UINT256_H
14 #if defined(_MSC_VER) || defined(__BORLANDC__)
15 typedef __int64 int64;
16 typedef unsigned __int64 uint64;
18 typedef long long int64;
19 typedef unsigned long long uint64;
21 #if defined(_MSC_VER) && _MSC_VER < 1300
22 #define for if (false) ; else for
26 inline int Testuint256AdHoc(std::vector<std::string> vArg);
30 // We have to keep a separate base class without constructors
31 // so the compiler will let us use it in a union
32 template<unsigned int BITS>
36 enum { WIDTH=BITS/32 };
37 unsigned int pn[WIDTH];
40 bool operator!() const
42 for (int i = 0; i < WIDTH; i++)
48 const base_uint operator~() const
51 for (int i = 0; i < WIDTH; i++)
56 const base_uint operator-() const
59 for (int i = 0; i < WIDTH; i++)
66 base_uint& operator=(uint64 b)
68 pn[0] = (unsigned int)b;
69 pn[1] = (unsigned int)(b >> 32);
70 for (int i = 2; i < WIDTH; i++)
75 base_uint& operator^=(const base_uint& b)
77 for (int i = 0; i < WIDTH; i++)
82 base_uint& operator&=(const base_uint& b)
84 for (int i = 0; i < WIDTH; i++)
89 base_uint& operator|=(const base_uint& b)
91 for (int i = 0; i < WIDTH; i++)
96 base_uint& operator^=(uint64 b)
98 pn[0] ^= (unsigned int)b;
99 pn[1] ^= (unsigned int)(b >> 32);
103 base_uint& operator&=(uint64 b)
105 pn[0] &= (unsigned int)b;
106 pn[1] &= (unsigned int)(b >> 32);
110 base_uint& operator|=(uint64 b)
112 pn[0] |= (unsigned int)b;
113 pn[1] |= (unsigned int)(b >> 32);
117 base_uint& operator<<=(unsigned int shift)
120 for (int i = 0; i < WIDTH; i++)
124 for (int i = 0; i < WIDTH; i++)
126 if (i+k+1 < WIDTH && shift != 0)
127 pn[i+k+1] |= (a.pn[i] >> (32-shift));
129 pn[i+k] |= (a.pn[i] << shift);
134 base_uint& operator>>=(unsigned int shift)
137 for (int i = 0; i < WIDTH; i++)
141 for (int i = 0; i < WIDTH; i++)
143 if (i-k-1 >= 0 && shift != 0)
144 pn[i-k-1] |= (a.pn[i] << (32-shift));
146 pn[i-k] |= (a.pn[i] >> shift);
151 base_uint& operator+=(const base_uint& b)
154 for (int i = 0; i < WIDTH; i++)
156 uint64 n = carry + pn[i] + b.pn[i];
157 pn[i] = n & 0xffffffff;
163 base_uint& operator-=(const base_uint& b)
169 base_uint& operator+=(uint64 b64)
177 base_uint& operator-=(uint64 b64)
186 base_uint& operator++()
190 while (++pn[i] == 0 && i < WIDTH-1)
195 const base_uint operator++(int)
198 const base_uint ret = *this;
203 base_uint& operator--()
207 while (--pn[i] == -1 && i < WIDTH-1)
212 const base_uint operator--(int)
215 const base_uint ret = *this;
221 friend inline bool operator<(const base_uint& a, const base_uint& b)
223 for (int i = base_uint::WIDTH-1; i >= 0; i--)
225 if (a.pn[i] < b.pn[i])
227 else if (a.pn[i] > b.pn[i])
233 friend inline bool operator<=(const base_uint& a, const base_uint& b)
235 for (int i = base_uint::WIDTH-1; i >= 0; i--)
237 if (a.pn[i] < b.pn[i])
239 else if (a.pn[i] > b.pn[i])
245 friend inline bool operator>(const base_uint& a, const base_uint& b)
247 for (int i = base_uint::WIDTH-1; i >= 0; i--)
249 if (a.pn[i] > b.pn[i])
251 else if (a.pn[i] < b.pn[i])
257 friend inline bool operator>=(const base_uint& a, const base_uint& b)
259 for (int i = base_uint::WIDTH-1; i >= 0; i--)
261 if (a.pn[i] > b.pn[i])
263 else if (a.pn[i] < b.pn[i])
269 friend inline bool operator==(const base_uint& a, const base_uint& b)
271 for (int i = 0; i < base_uint::WIDTH; i++)
272 if (a.pn[i] != b.pn[i])
277 friend inline bool operator==(const base_uint& a, uint64 b)
279 if (a.pn[0] != (unsigned int)b)
281 if (a.pn[1] != (unsigned int)(b >> 32))
283 for (int i = 2; i < base_uint::WIDTH; i++)
289 friend inline bool operator!=(const base_uint& a, const base_uint& b)
294 friend inline bool operator!=(const base_uint& a, uint64 b)
301 std::string GetHex() const
303 char psz[sizeof(pn)*2 + 1];
304 for (int i = 0; i < sizeof(pn); i++)
305 sprintf(psz + i*2, "%02x", ((unsigned char*)pn)[sizeof(pn) - i - 1]);
306 return std::string(psz, psz + sizeof(pn)*2);
309 void SetHex(const char* psz)
311 for (int i = 0; i < WIDTH; i++)
314 // skip leading spaces
315 while (isspace(*psz))
319 if (psz[0] == '0' && tolower(psz[1]) == 'x')
322 // hex string to uint
323 static char phexdigit[256] = { 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, 0,1,2,3,4,5,6,7,8,9,0,0,0,0,0,0, 0,0xa,0xb,0xc,0xd,0xe,0xf,0,0,0,0,0,0,0,0,0, 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, 0,0xa,0xb,0xc,0xd,0xe,0xf,0,0,0,0,0,0,0,0,0 };
324 const char* pbegin = psz;
325 while (phexdigit[*psz] || *psz == '0')
328 unsigned char* p1 = (unsigned char*)pn;
329 unsigned char* pend = p1 + WIDTH * 4;
330 while (psz >= pbegin && p1 < pend)
332 *p1 = phexdigit[(unsigned char)*psz--];
335 *p1 |= (phexdigit[(unsigned char)*psz--] << 4);
341 void SetHex(const std::string& str)
346 std::string ToString() const
351 unsigned char* begin()
353 return (unsigned char*)&pn[0];
358 return (unsigned char*)&pn[WIDTH];
367 unsigned int GetSerializeSize(int nType=0, int nVersion=VERSION) const
372 template<typename Stream>
373 void Serialize(Stream& s, int nType=0, int nVersion=VERSION) const
375 s.write((char*)pn, sizeof(pn));
378 template<typename Stream>
379 void Unserialize(Stream& s, int nType=0, int nVersion=VERSION)
381 s.read((char*)pn, sizeof(pn));
385 friend class uint160;
386 friend class uint256;
387 friend inline int Testuint256AdHoc(std::vector<std::string> vArg);
390 typedef base_uint<160> base_uint160;
391 typedef base_uint<256> base_uint256;
396 // uint160 and uint256 could be implemented as templates, but to keep
397 // compile errors and debugging cleaner, they're copy and pasted.
402 //////////////////////////////////////////////////////////////////////////////
407 class uint160 : public base_uint160
410 typedef base_uint160 basetype;
414 for (int i = 0; i < WIDTH; i++)
418 uint160(const basetype& b)
420 for (int i = 0; i < WIDTH; i++)
424 uint160& operator=(const basetype& b)
426 for (int i = 0; i < WIDTH; i++)
433 pn[0] = (unsigned int)b;
434 pn[1] = (unsigned int)(b >> 32);
435 for (int i = 2; i < WIDTH; i++)
439 uint160& operator=(uint64 b)
441 pn[0] = (unsigned int)b;
442 pn[1] = (unsigned int)(b >> 32);
443 for (int i = 2; i < WIDTH; i++)
448 explicit uint160(const std::string& str)
453 explicit uint160(const std::vector<unsigned char>& vch)
455 if (vch.size() == sizeof(pn))
456 memcpy(pn, &vch[0], sizeof(pn));
462 inline bool operator==(const uint160& a, uint64 b) { return (base_uint160)a == b; }
463 inline bool operator!=(const uint160& a, uint64 b) { return (base_uint160)a != b; }
464 inline const uint160 operator<<(const base_uint160& a, unsigned int shift) { return uint160(a) <<= shift; }
465 inline const uint160 operator>>(const base_uint160& a, unsigned int shift) { return uint160(a) >>= shift; }
466 inline const uint160 operator<<(const uint160& a, unsigned int shift) { return uint160(a) <<= shift; }
467 inline const uint160 operator>>(const uint160& a, unsigned int shift) { return uint160(a) >>= shift; }
469 inline const uint160 operator^(const base_uint160& a, const base_uint160& b) { return uint160(a) ^= b; }
470 inline const uint160 operator&(const base_uint160& a, const base_uint160& b) { return uint160(a) &= b; }
471 inline const uint160 operator|(const base_uint160& a, const base_uint160& b) { return uint160(a) |= b; }
472 inline const uint160 operator+(const base_uint160& a, const base_uint160& b) { return uint160(a) += b; }
473 inline const uint160 operator-(const base_uint160& a, const base_uint160& b) { return uint160(a) -= b; }
475 inline bool operator<(const base_uint160& a, const uint160& b) { return (base_uint160)a < (base_uint160)b; }
476 inline bool operator<=(const base_uint160& a, const uint160& b) { return (base_uint160)a <= (base_uint160)b; }
477 inline bool operator>(const base_uint160& a, const uint160& b) { return (base_uint160)a > (base_uint160)b; }
478 inline bool operator>=(const base_uint160& a, const uint160& b) { return (base_uint160)a >= (base_uint160)b; }
479 inline bool operator==(const base_uint160& a, const uint160& b) { return (base_uint160)a == (base_uint160)b; }
480 inline bool operator!=(const base_uint160& a, const uint160& b) { return (base_uint160)a != (base_uint160)b; }
481 inline const uint160 operator^(const base_uint160& a, const uint160& b) { return (base_uint160)a ^ (base_uint160)b; }
482 inline const uint160 operator&(const base_uint160& a, const uint160& b) { return (base_uint160)a & (base_uint160)b; }
483 inline const uint160 operator|(const base_uint160& a, const uint160& b) { return (base_uint160)a | (base_uint160)b; }
484 inline const uint160 operator+(const base_uint160& a, const uint160& b) { return (base_uint160)a + (base_uint160)b; }
485 inline const uint160 operator-(const base_uint160& a, const uint160& b) { return (base_uint160)a - (base_uint160)b; }
487 inline bool operator<(const uint160& a, const base_uint160& b) { return (base_uint160)a < (base_uint160)b; }
488 inline bool operator<=(const uint160& a, const base_uint160& b) { return (base_uint160)a <= (base_uint160)b; }
489 inline bool operator>(const uint160& a, const base_uint160& b) { return (base_uint160)a > (base_uint160)b; }
490 inline bool operator>=(const uint160& a, const base_uint160& b) { return (base_uint160)a >= (base_uint160)b; }
491 inline bool operator==(const uint160& a, const base_uint160& b) { return (base_uint160)a == (base_uint160)b; }
492 inline bool operator!=(const uint160& a, const base_uint160& b) { return (base_uint160)a != (base_uint160)b; }
493 inline const uint160 operator^(const uint160& a, const base_uint160& b) { return (base_uint160)a ^ (base_uint160)b; }
494 inline const uint160 operator&(const uint160& a, const base_uint160& b) { return (base_uint160)a & (base_uint160)b; }
495 inline const uint160 operator|(const uint160& a, const base_uint160& b) { return (base_uint160)a | (base_uint160)b; }
496 inline const uint160 operator+(const uint160& a, const base_uint160& b) { return (base_uint160)a + (base_uint160)b; }
497 inline const uint160 operator-(const uint160& a, const base_uint160& b) { return (base_uint160)a - (base_uint160)b; }
499 inline bool operator<(const uint160& a, const uint160& b) { return (base_uint160)a < (base_uint160)b; }
500 inline bool operator<=(const uint160& a, const uint160& b) { return (base_uint160)a <= (base_uint160)b; }
501 inline bool operator>(const uint160& a, const uint160& b) { return (base_uint160)a > (base_uint160)b; }
502 inline bool operator>=(const uint160& a, const uint160& b) { return (base_uint160)a >= (base_uint160)b; }
503 inline bool operator==(const uint160& a, const uint160& b) { return (base_uint160)a == (base_uint160)b; }
504 inline bool operator!=(const uint160& a, const uint160& b) { return (base_uint160)a != (base_uint160)b; }
505 inline const uint160 operator^(const uint160& a, const uint160& b) { return (base_uint160)a ^ (base_uint160)b; }
506 inline const uint160 operator&(const uint160& a, const uint160& b) { return (base_uint160)a & (base_uint160)b; }
507 inline const uint160 operator|(const uint160& a, const uint160& b) { return (base_uint160)a | (base_uint160)b; }
508 inline const uint160 operator+(const uint160& a, const uint160& b) { return (base_uint160)a + (base_uint160)b; }
509 inline const uint160 operator-(const uint160& a, const uint160& b) { return (base_uint160)a - (base_uint160)b; }
516 //////////////////////////////////////////////////////////////////////////////
521 class uint256 : public base_uint256
524 typedef base_uint256 basetype;
528 for (int i = 0; i < WIDTH; i++)
532 uint256(const basetype& b)
534 for (int i = 0; i < WIDTH; i++)
538 uint256& operator=(const basetype& b)
540 for (int i = 0; i < WIDTH; i++)
547 pn[0] = (unsigned int)b;
548 pn[1] = (unsigned int)(b >> 32);
549 for (int i = 2; i < WIDTH; i++)
553 uint256& operator=(uint64 b)
555 pn[0] = (unsigned int)b;
556 pn[1] = (unsigned int)(b >> 32);
557 for (int i = 2; i < WIDTH; i++)
562 explicit uint256(const std::string& str)
567 explicit uint256(const std::vector<unsigned char>& vch)
569 if (vch.size() == sizeof(pn))
570 memcpy(pn, &vch[0], sizeof(pn));
576 inline bool operator==(const uint256& a, uint64 b) { return (base_uint256)a == b; }
577 inline bool operator!=(const uint256& a, uint64 b) { return (base_uint256)a != b; }
578 inline const uint256 operator<<(const base_uint256& a, unsigned int shift) { return uint256(a) <<= shift; }
579 inline const uint256 operator>>(const base_uint256& a, unsigned int shift) { return uint256(a) >>= shift; }
580 inline const uint256 operator<<(const uint256& a, unsigned int shift) { return uint256(a) <<= shift; }
581 inline const uint256 operator>>(const uint256& a, unsigned int shift) { return uint256(a) >>= shift; }
583 inline const uint256 operator^(const base_uint256& a, const base_uint256& b) { return uint256(a) ^= b; }
584 inline const uint256 operator&(const base_uint256& a, const base_uint256& b) { return uint256(a) &= b; }
585 inline const uint256 operator|(const base_uint256& a, const base_uint256& b) { return uint256(a) |= b; }
586 inline const uint256 operator+(const base_uint256& a, const base_uint256& b) { return uint256(a) += b; }
587 inline const uint256 operator-(const base_uint256& a, const base_uint256& b) { return uint256(a) -= b; }
589 inline bool operator<(const base_uint256& a, const uint256& b) { return (base_uint256)a < (base_uint256)b; }
590 inline bool operator<=(const base_uint256& a, const uint256& b) { return (base_uint256)a <= (base_uint256)b; }
591 inline bool operator>(const base_uint256& a, const uint256& b) { return (base_uint256)a > (base_uint256)b; }
592 inline bool operator>=(const base_uint256& a, const uint256& b) { return (base_uint256)a >= (base_uint256)b; }
593 inline bool operator==(const base_uint256& a, const uint256& b) { return (base_uint256)a == (base_uint256)b; }
594 inline bool operator!=(const base_uint256& a, const uint256& b) { return (base_uint256)a != (base_uint256)b; }
595 inline const uint256 operator^(const base_uint256& a, const uint256& b) { return (base_uint256)a ^ (base_uint256)b; }
596 inline const uint256 operator&(const base_uint256& a, const uint256& b) { return (base_uint256)a & (base_uint256)b; }
597 inline const uint256 operator|(const base_uint256& a, const uint256& b) { return (base_uint256)a | (base_uint256)b; }
598 inline const uint256 operator+(const base_uint256& a, const uint256& b) { return (base_uint256)a + (base_uint256)b; }
599 inline const uint256 operator-(const base_uint256& a, const uint256& b) { return (base_uint256)a - (base_uint256)b; }
601 inline bool operator<(const uint256& a, const base_uint256& b) { return (base_uint256)a < (base_uint256)b; }
602 inline bool operator<=(const uint256& a, const base_uint256& b) { return (base_uint256)a <= (base_uint256)b; }
603 inline bool operator>(const uint256& a, const base_uint256& b) { return (base_uint256)a > (base_uint256)b; }
604 inline bool operator>=(const uint256& a, const base_uint256& b) { return (base_uint256)a >= (base_uint256)b; }
605 inline bool operator==(const uint256& a, const base_uint256& b) { return (base_uint256)a == (base_uint256)b; }
606 inline bool operator!=(const uint256& a, const base_uint256& b) { return (base_uint256)a != (base_uint256)b; }
607 inline const uint256 operator^(const uint256& a, const base_uint256& b) { return (base_uint256)a ^ (base_uint256)b; }
608 inline const uint256 operator&(const uint256& a, const base_uint256& b) { return (base_uint256)a & (base_uint256)b; }
609 inline const uint256 operator|(const uint256& a, const base_uint256& b) { return (base_uint256)a | (base_uint256)b; }
610 inline const uint256 operator+(const uint256& a, const base_uint256& b) { return (base_uint256)a + (base_uint256)b; }
611 inline const uint256 operator-(const uint256& a, const base_uint256& b) { return (base_uint256)a - (base_uint256)b; }
613 inline bool operator<(const uint256& a, const uint256& b) { return (base_uint256)a < (base_uint256)b; }
614 inline bool operator<=(const uint256& a, const uint256& b) { return (base_uint256)a <= (base_uint256)b; }
615 inline bool operator>(const uint256& a, const uint256& b) { return (base_uint256)a > (base_uint256)b; }
616 inline bool operator>=(const uint256& a, const uint256& b) { return (base_uint256)a >= (base_uint256)b; }
617 inline bool operator==(const uint256& a, const uint256& b) { return (base_uint256)a == (base_uint256)b; }
618 inline bool operator!=(const uint256& a, const uint256& b) { return (base_uint256)a != (base_uint256)b; }
619 inline const uint256 operator^(const uint256& a, const uint256& b) { return (base_uint256)a ^ (base_uint256)b; }
620 inline const uint256 operator&(const uint256& a, const uint256& b) { return (base_uint256)a & (base_uint256)b; }
621 inline const uint256 operator|(const uint256& a, const uint256& b) { return (base_uint256)a | (base_uint256)b; }
622 inline const uint256 operator+(const uint256& a, const uint256& b) { return (base_uint256)a + (base_uint256)b; }
623 inline const uint256 operator-(const uint256& a, const uint256& b) { return (base_uint256)a - (base_uint256)b; }
636 inline int Testuint256AdHoc(std::vector<std::string> vArg)
641 printf("%s\n", g.ToString().c_str());
642 g--; printf("g--\n");
643 printf("%s\n", g.ToString().c_str());
644 g--; printf("g--\n");
645 printf("%s\n", g.ToString().c_str());
646 g++; printf("g++\n");
647 printf("%s\n", g.ToString().c_str());
648 g++; printf("g++\n");
649 printf("%s\n", g.ToString().c_str());
650 g++; printf("g++\n");
651 printf("%s\n", g.ToString().c_str());
652 g++; printf("g++\n");
653 printf("%s\n", g.ToString().c_str());
659 printf("%s\n", a.ToString().c_str());
662 printf("b undefined\n");
663 printf("%s\n", b.ToString().c_str());
668 printf("%s\n", a.ToString().c_str());
673 printf("%s\n", a.ToString().c_str());
681 printf("a %s\n", a.ToString().c_str());
683 a = a | b | (uint256)0x1000;
686 printf("a %s\n", a.ToString().c_str());
687 printf("b %s\n", b.ToString().c_str());
692 printf("%s\n", a.ToString().c_str());
694 printf("%s\n", a.ToString().c_str());
696 printf("%s\n", a.ToString().c_str());
698 printf("%s\n", a.ToString().c_str());
700 printf("%s\n", a.ToString().c_str());
703 printf("%s\n", a.ToString().c_str());
705 printf("%s\n", a.ToString().c_str());
707 printf("%s\n", a.ToString().c_str());
709 printf("%s\n", d.ToString().c_str());
710 printf("%s\n", a.ToString().c_str());
712 printf("%s\n", a.ToString().c_str());
714 printf("%s\n", a.ToString().c_str());
718 printf("%s\n", d.ToString().c_str());
719 for (int i = uint256::WIDTH-1; i >= 0; i--) printf("%08x", d.pn[i]); printf("\n");
723 printf("%s\n", neg.ToString().c_str());
726 uint256 e = uint256("0xABCDEF123abcdef12345678909832180000011111111");
728 printf("%s\n", e.ToString().c_str());
732 uint256 x1 = uint256("0xABCDEF123abcdef12345678909832180000011111111");
734 printf("%s\n", x1.ToString().c_str());
735 for (int i = 0; i < 270; i += 4)
738 printf("%s\n", x2.ToString().c_str());
742 printf("%s\n", x1.ToString().c_str());
743 for (int i = 0; i < 270; i += 4)
747 printf("%s\n", x2.ToString().c_str());
751 for (int i = 0; i < 100; i++)
753 uint256 k = (~uint256(0) >> i);
754 printf("%s\n", k.ToString().c_str());
757 for (int i = 0; i < 100; i++)
759 uint256 k = (~uint256(0) << i);
760 printf("%s\n", k.ToString().c_str());