1 // Copyright (c) 2009-2010 Satoshi Nakamoto
2 // Copyright (c) 2009-2012 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 typedef long long int64;
15 typedef unsigned long long uint64;
18 inline int Testuint256AdHoc(std::vector<std::string> vArg);
22 // We have to keep a separate base class without constructors
23 // so the compiler will let us use it in a union
24 template<unsigned int BITS>
28 enum { WIDTH=BITS/32 };
29 unsigned int pn[WIDTH];
32 bool operator!() const
34 for (int i = 0; i < WIDTH; i++)
40 const base_uint operator~() const
43 for (int i = 0; i < WIDTH; i++)
48 const base_uint operator-() const
51 for (int i = 0; i < WIDTH; i++)
58 base_uint& operator=(uint64 b)
60 pn[0] = (unsigned int)b;
61 pn[1] = (unsigned int)(b >> 32);
62 for (int i = 2; i < WIDTH; i++)
67 base_uint& operator^=(const base_uint& b)
69 for (int i = 0; i < WIDTH; i++)
74 base_uint& operator&=(const base_uint& b)
76 for (int i = 0; i < WIDTH; i++)
81 base_uint& operator|=(const base_uint& b)
83 for (int i = 0; i < WIDTH; i++)
88 base_uint& operator^=(uint64 b)
90 pn[0] ^= (unsigned int)b;
91 pn[1] ^= (unsigned int)(b >> 32);
95 base_uint& operator|=(uint64 b)
97 pn[0] |= (unsigned int)b;
98 pn[1] |= (unsigned int)(b >> 32);
102 base_uint& operator<<=(unsigned int shift)
105 for (int i = 0; i < WIDTH; i++)
109 for (int i = 0; i < WIDTH; i++)
111 if (i+k+1 < WIDTH && shift != 0)
112 pn[i+k+1] |= (a.pn[i] >> (32-shift));
114 pn[i+k] |= (a.pn[i] << shift);
119 base_uint& operator>>=(unsigned int shift)
122 for (int i = 0; i < WIDTH; i++)
126 for (int i = 0; i < WIDTH; i++)
128 if (i-k-1 >= 0 && shift != 0)
129 pn[i-k-1] |= (a.pn[i] << (32-shift));
131 pn[i-k] |= (a.pn[i] >> shift);
136 base_uint& operator+=(const base_uint& b)
139 for (int i = 0; i < WIDTH; i++)
141 uint64 n = carry + pn[i] + b.pn[i];
142 pn[i] = n & 0xffffffff;
148 base_uint& operator-=(const base_uint& b)
154 base_uint& operator+=(uint64 b64)
162 base_uint& operator-=(uint64 b64)
171 base_uint& operator++()
175 while (++pn[i] == 0 && i < WIDTH-1)
180 const base_uint operator++(int)
183 const base_uint ret = *this;
188 base_uint& operator--()
192 while (--pn[i] == -1 && i < WIDTH-1)
197 const base_uint operator--(int)
200 const base_uint ret = *this;
206 friend inline bool operator<(const base_uint& a, const base_uint& b)
208 for (int i = base_uint::WIDTH-1; i >= 0; i--)
210 if (a.pn[i] < b.pn[i])
212 else if (a.pn[i] > b.pn[i])
218 friend inline bool operator<=(const base_uint& a, const base_uint& b)
220 for (int i = base_uint::WIDTH-1; i >= 0; i--)
222 if (a.pn[i] < b.pn[i])
224 else if (a.pn[i] > b.pn[i])
230 friend inline bool operator>(const base_uint& a, const base_uint& b)
232 for (int i = base_uint::WIDTH-1; i >= 0; i--)
234 if (a.pn[i] > b.pn[i])
236 else if (a.pn[i] < b.pn[i])
242 friend inline bool operator>=(const base_uint& a, const base_uint& b)
244 for (int i = base_uint::WIDTH-1; i >= 0; i--)
246 if (a.pn[i] > b.pn[i])
248 else if (a.pn[i] < b.pn[i])
254 friend inline bool operator==(const base_uint& a, const base_uint& b)
256 for (int i = 0; i < base_uint::WIDTH; i++)
257 if (a.pn[i] != b.pn[i])
262 friend inline bool operator==(const base_uint& a, uint64 b)
264 if (a.pn[0] != (unsigned int)b)
266 if (a.pn[1] != (unsigned int)(b >> 32))
268 for (int i = 2; i < base_uint::WIDTH; i++)
274 friend inline bool operator!=(const base_uint& a, const base_uint& b)
279 friend inline bool operator!=(const base_uint& a, uint64 b)
286 std::string GetHex() const
288 char psz[sizeof(pn)*2 + 1];
289 for (int i = 0; i < sizeof(pn); i++)
290 sprintf(psz + i*2, "%02x", ((unsigned char*)pn)[sizeof(pn) - i - 1]);
291 return std::string(psz, psz + sizeof(pn)*2);
294 void SetHex(const char* psz)
296 for (int i = 0; i < WIDTH; i++)
299 // skip leading spaces
300 while (isspace(*psz))
304 if (psz[0] == '0' && tolower(psz[1]) == 'x')
307 // hex string to uint
308 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 };
309 const char* pbegin = psz;
310 while (phexdigit[*psz] || *psz == '0')
313 unsigned char* p1 = (unsigned char*)pn;
314 unsigned char* pend = p1 + WIDTH * 4;
315 while (psz >= pbegin && p1 < pend)
317 *p1 = phexdigit[(unsigned char)*psz--];
320 *p1 |= (phexdigit[(unsigned char)*psz--] << 4);
326 void SetHex(const std::string& str)
331 std::string ToString() const
336 unsigned char* begin()
338 return (unsigned char*)&pn[0];
343 return (unsigned char*)&pn[WIDTH];
352 unsigned int GetSerializeSize(int nType=0, int nVersion=PROTOCOL_VERSION) const
357 template<typename Stream>
358 void Serialize(Stream& s, int nType=0, int nVersion=PROTOCOL_VERSION) const
360 s.write((char*)pn, sizeof(pn));
363 template<typename Stream>
364 void Unserialize(Stream& s, int nType=0, int nVersion=PROTOCOL_VERSION)
366 s.read((char*)pn, sizeof(pn));
370 friend class uint160;
371 friend class uint256;
372 friend inline int Testuint256AdHoc(std::vector<std::string> vArg);
375 typedef base_uint<160> base_uint160;
376 typedef base_uint<256> base_uint256;
381 // uint160 and uint256 could be implemented as templates, but to keep
382 // compile errors and debugging cleaner, they're copy and pasted.
387 //////////////////////////////////////////////////////////////////////////////
392 class uint160 : public base_uint160
395 typedef base_uint160 basetype;
399 for (int i = 0; i < WIDTH; i++)
403 uint160(const basetype& b)
405 for (int i = 0; i < WIDTH; i++)
409 uint160& operator=(const basetype& b)
411 for (int i = 0; i < WIDTH; i++)
418 pn[0] = (unsigned int)b;
419 pn[1] = (unsigned int)(b >> 32);
420 for (int i = 2; i < WIDTH; i++)
424 uint160& operator=(uint64 b)
426 pn[0] = (unsigned int)b;
427 pn[1] = (unsigned int)(b >> 32);
428 for (int i = 2; i < WIDTH; i++)
433 explicit uint160(const std::string& str)
438 explicit uint160(const std::vector<unsigned char>& vch)
440 if (vch.size() == sizeof(pn))
441 memcpy(pn, &vch[0], sizeof(pn));
447 inline bool operator==(const uint160& a, uint64 b) { return (base_uint160)a == b; }
448 inline bool operator!=(const uint160& a, uint64 b) { return (base_uint160)a != b; }
449 inline const uint160 operator<<(const base_uint160& a, unsigned int shift) { return uint160(a) <<= shift; }
450 inline const uint160 operator>>(const base_uint160& a, unsigned int shift) { return uint160(a) >>= shift; }
451 inline const uint160 operator<<(const uint160& a, unsigned int shift) { return uint160(a) <<= shift; }
452 inline const uint160 operator>>(const uint160& a, unsigned int shift) { return uint160(a) >>= shift; }
454 inline const uint160 operator^(const base_uint160& a, const base_uint160& b) { return uint160(a) ^= b; }
455 inline const uint160 operator&(const base_uint160& a, const base_uint160& b) { return uint160(a) &= b; }
456 inline const uint160 operator|(const base_uint160& a, const base_uint160& b) { return uint160(a) |= b; }
457 inline const uint160 operator+(const base_uint160& a, const base_uint160& b) { return uint160(a) += b; }
458 inline const uint160 operator-(const base_uint160& a, const base_uint160& b) { return uint160(a) -= b; }
460 inline bool operator<(const base_uint160& a, const uint160& b) { return (base_uint160)a < (base_uint160)b; }
461 inline bool operator<=(const base_uint160& a, const uint160& b) { return (base_uint160)a <= (base_uint160)b; }
462 inline bool operator>(const base_uint160& a, const uint160& b) { return (base_uint160)a > (base_uint160)b; }
463 inline bool operator>=(const base_uint160& a, const uint160& b) { return (base_uint160)a >= (base_uint160)b; }
464 inline bool operator==(const base_uint160& a, const uint160& b) { return (base_uint160)a == (base_uint160)b; }
465 inline bool operator!=(const base_uint160& a, const uint160& b) { return (base_uint160)a != (base_uint160)b; }
466 inline const uint160 operator^(const base_uint160& a, const uint160& b) { return (base_uint160)a ^ (base_uint160)b; }
467 inline const uint160 operator&(const base_uint160& a, const uint160& b) { return (base_uint160)a & (base_uint160)b; }
468 inline const uint160 operator|(const base_uint160& a, const uint160& b) { return (base_uint160)a | (base_uint160)b; }
469 inline const uint160 operator+(const base_uint160& a, const uint160& b) { return (base_uint160)a + (base_uint160)b; }
470 inline const uint160 operator-(const base_uint160& a, const uint160& b) { return (base_uint160)a - (base_uint160)b; }
472 inline bool operator<(const uint160& a, const base_uint160& b) { return (base_uint160)a < (base_uint160)b; }
473 inline bool operator<=(const uint160& a, const base_uint160& b) { return (base_uint160)a <= (base_uint160)b; }
474 inline bool operator>(const uint160& a, const base_uint160& b) { return (base_uint160)a > (base_uint160)b; }
475 inline bool operator>=(const uint160& a, const base_uint160& b) { return (base_uint160)a >= (base_uint160)b; }
476 inline bool operator==(const uint160& a, const base_uint160& b) { return (base_uint160)a == (base_uint160)b; }
477 inline bool operator!=(const uint160& a, const base_uint160& b) { return (base_uint160)a != (base_uint160)b; }
478 inline const uint160 operator^(const uint160& a, const base_uint160& b) { return (base_uint160)a ^ (base_uint160)b; }
479 inline const uint160 operator&(const uint160& a, const base_uint160& b) { return (base_uint160)a & (base_uint160)b; }
480 inline const uint160 operator|(const uint160& a, const base_uint160& b) { return (base_uint160)a | (base_uint160)b; }
481 inline const uint160 operator+(const uint160& a, const base_uint160& b) { return (base_uint160)a + (base_uint160)b; }
482 inline const uint160 operator-(const uint160& a, const base_uint160& b) { return (base_uint160)a - (base_uint160)b; }
484 inline bool operator<(const uint160& a, const uint160& b) { return (base_uint160)a < (base_uint160)b; }
485 inline bool operator<=(const uint160& a, const uint160& b) { return (base_uint160)a <= (base_uint160)b; }
486 inline bool operator>(const uint160& a, const uint160& b) { return (base_uint160)a > (base_uint160)b; }
487 inline bool operator>=(const uint160& a, const uint160& b) { return (base_uint160)a >= (base_uint160)b; }
488 inline bool operator==(const uint160& a, const uint160& b) { return (base_uint160)a == (base_uint160)b; }
489 inline bool operator!=(const uint160& a, const uint160& b) { return (base_uint160)a != (base_uint160)b; }
490 inline const uint160 operator^(const uint160& a, const uint160& b) { return (base_uint160)a ^ (base_uint160)b; }
491 inline const uint160 operator&(const uint160& a, const uint160& b) { return (base_uint160)a & (base_uint160)b; }
492 inline const uint160 operator|(const uint160& a, const uint160& b) { return (base_uint160)a | (base_uint160)b; }
493 inline const uint160 operator+(const uint160& a, const uint160& b) { return (base_uint160)a + (base_uint160)b; }
494 inline const uint160 operator-(const uint160& a, const uint160& b) { return (base_uint160)a - (base_uint160)b; }
501 //////////////////////////////////////////////////////////////////////////////
506 class uint256 : public base_uint256
509 typedef base_uint256 basetype;
513 for (int i = 0; i < WIDTH; i++)
517 uint256(const basetype& b)
519 for (int i = 0; i < WIDTH; i++)
523 uint256& operator=(const basetype& b)
525 for (int i = 0; i < WIDTH; i++)
532 pn[0] = (unsigned int)b;
533 pn[1] = (unsigned int)(b >> 32);
534 for (int i = 2; i < WIDTH; i++)
538 uint256& operator=(uint64 b)
540 pn[0] = (unsigned int)b;
541 pn[1] = (unsigned int)(b >> 32);
542 for (int i = 2; i < WIDTH; i++)
547 explicit uint256(const std::string& str)
552 explicit uint256(const std::vector<unsigned char>& vch)
554 if (vch.size() == sizeof(pn))
555 memcpy(pn, &vch[0], sizeof(pn));
561 inline bool operator==(const uint256& a, uint64 b) { return (base_uint256)a == b; }
562 inline bool operator!=(const uint256& a, uint64 b) { return (base_uint256)a != b; }
563 inline const uint256 operator<<(const base_uint256& a, unsigned int shift) { return uint256(a) <<= shift; }
564 inline const uint256 operator>>(const base_uint256& a, unsigned int shift) { return uint256(a) >>= shift; }
565 inline const uint256 operator<<(const uint256& a, unsigned int shift) { return uint256(a) <<= shift; }
566 inline const uint256 operator>>(const uint256& a, unsigned int shift) { return uint256(a) >>= shift; }
568 inline const uint256 operator^(const base_uint256& a, const base_uint256& b) { return uint256(a) ^= b; }
569 inline const uint256 operator&(const base_uint256& a, const base_uint256& b) { return uint256(a) &= b; }
570 inline const uint256 operator|(const base_uint256& a, const base_uint256& b) { return uint256(a) |= b; }
571 inline const uint256 operator+(const base_uint256& a, const base_uint256& b) { return uint256(a) += b; }
572 inline const uint256 operator-(const base_uint256& a, const base_uint256& b) { return uint256(a) -= b; }
574 inline bool operator<(const base_uint256& a, const uint256& b) { return (base_uint256)a < (base_uint256)b; }
575 inline bool operator<=(const base_uint256& a, const uint256& b) { return (base_uint256)a <= (base_uint256)b; }
576 inline bool operator>(const base_uint256& a, const uint256& b) { return (base_uint256)a > (base_uint256)b; }
577 inline bool operator>=(const base_uint256& a, const uint256& b) { return (base_uint256)a >= (base_uint256)b; }
578 inline bool operator==(const base_uint256& a, const uint256& b) { return (base_uint256)a == (base_uint256)b; }
579 inline bool operator!=(const base_uint256& a, const uint256& b) { return (base_uint256)a != (base_uint256)b; }
580 inline const uint256 operator^(const base_uint256& a, const uint256& b) { return (base_uint256)a ^ (base_uint256)b; }
581 inline const uint256 operator&(const base_uint256& a, const uint256& b) { return (base_uint256)a & (base_uint256)b; }
582 inline const uint256 operator|(const base_uint256& a, const uint256& b) { return (base_uint256)a | (base_uint256)b; }
583 inline const uint256 operator+(const base_uint256& a, const uint256& b) { return (base_uint256)a + (base_uint256)b; }
584 inline const uint256 operator-(const base_uint256& a, const uint256& b) { return (base_uint256)a - (base_uint256)b; }
586 inline bool operator<(const uint256& a, const base_uint256& b) { return (base_uint256)a < (base_uint256)b; }
587 inline bool operator<=(const uint256& a, const base_uint256& b) { return (base_uint256)a <= (base_uint256)b; }
588 inline bool operator>(const uint256& a, const base_uint256& b) { return (base_uint256)a > (base_uint256)b; }
589 inline bool operator>=(const uint256& a, const base_uint256& b) { return (base_uint256)a >= (base_uint256)b; }
590 inline bool operator==(const uint256& a, const base_uint256& b) { return (base_uint256)a == (base_uint256)b; }
591 inline bool operator!=(const uint256& a, const base_uint256& b) { return (base_uint256)a != (base_uint256)b; }
592 inline const uint256 operator^(const uint256& a, const base_uint256& b) { return (base_uint256)a ^ (base_uint256)b; }
593 inline const uint256 operator&(const uint256& a, const base_uint256& b) { return (base_uint256)a & (base_uint256)b; }
594 inline const uint256 operator|(const uint256& a, const base_uint256& b) { return (base_uint256)a | (base_uint256)b; }
595 inline const uint256 operator+(const uint256& a, const base_uint256& b) { return (base_uint256)a + (base_uint256)b; }
596 inline const uint256 operator-(const uint256& a, const base_uint256& b) { return (base_uint256)a - (base_uint256)b; }
598 inline bool operator<(const uint256& a, const uint256& b) { return (base_uint256)a < (base_uint256)b; }
599 inline bool operator<=(const uint256& a, const uint256& b) { return (base_uint256)a <= (base_uint256)b; }
600 inline bool operator>(const uint256& a, const uint256& b) { return (base_uint256)a > (base_uint256)b; }
601 inline bool operator>=(const uint256& a, const uint256& b) { return (base_uint256)a >= (base_uint256)b; }
602 inline bool operator==(const uint256& a, const uint256& b) { return (base_uint256)a == (base_uint256)b; }
603 inline bool operator!=(const uint256& a, const uint256& b) { return (base_uint256)a != (base_uint256)b; }
604 inline const uint256 operator^(const uint256& a, const uint256& b) { return (base_uint256)a ^ (base_uint256)b; }
605 inline const uint256 operator&(const uint256& a, const uint256& b) { return (base_uint256)a & (base_uint256)b; }
606 inline const uint256 operator|(const uint256& a, const uint256& b) { return (base_uint256)a | (base_uint256)b; }
607 inline const uint256 operator+(const uint256& a, const uint256& b) { return (base_uint256)a + (base_uint256)b; }
608 inline const uint256 operator-(const uint256& a, const uint256& b) { return (base_uint256)a - (base_uint256)b; }
621 inline int Testuint256AdHoc(std::vector<std::string> vArg)
626 printf("%s\n", g.ToString().c_str());
627 g--; printf("g--\n");
628 printf("%s\n", g.ToString().c_str());
629 g--; printf("g--\n");
630 printf("%s\n", g.ToString().c_str());
631 g++; printf("g++\n");
632 printf("%s\n", g.ToString().c_str());
633 g++; printf("g++\n");
634 printf("%s\n", g.ToString().c_str());
635 g++; printf("g++\n");
636 printf("%s\n", g.ToString().c_str());
637 g++; printf("g++\n");
638 printf("%s\n", g.ToString().c_str());
644 printf("%s\n", a.ToString().c_str());
647 printf("b undefined\n");
648 printf("%s\n", b.ToString().c_str());
653 printf("%s\n", a.ToString().c_str());
658 printf("%s\n", a.ToString().c_str());
666 printf("a %s\n", a.ToString().c_str());
668 a = a | b | (uint256)0x1000;
671 printf("a %s\n", a.ToString().c_str());
672 printf("b %s\n", b.ToString().c_str());
677 printf("%s\n", a.ToString().c_str());
679 printf("%s\n", a.ToString().c_str());
681 printf("%s\n", a.ToString().c_str());
683 printf("%s\n", a.ToString().c_str());
685 printf("%s\n", a.ToString().c_str());
688 printf("%s\n", a.ToString().c_str());
690 printf("%s\n", a.ToString().c_str());
692 printf("%s\n", a.ToString().c_str());
694 printf("%s\n", d.ToString().c_str());
695 printf("%s\n", a.ToString().c_str());
697 printf("%s\n", a.ToString().c_str());
699 printf("%s\n", a.ToString().c_str());
703 printf("%s\n", d.ToString().c_str());
704 for (int i = uint256::WIDTH-1; i >= 0; i--) printf("%08x", d.pn[i]); printf("\n");
708 printf("%s\n", neg.ToString().c_str());
711 uint256 e = uint256("0xABCDEF123abcdef12345678909832180000011111111");
713 printf("%s\n", e.ToString().c_str());
717 uint256 x1 = uint256("0xABCDEF123abcdef12345678909832180000011111111");
719 printf("%s\n", x1.ToString().c_str());
720 for (int i = 0; i < 270; i += 4)
723 printf("%s\n", x2.ToString().c_str());
727 printf("%s\n", x1.ToString().c_str());
728 for (int i = 0; i < 270; i += 4)
732 printf("%s\n", x2.ToString().c_str());
736 for (int i = 0; i < 100; i++)
738 uint256 k = (~uint256(0) >> i);
739 printf("%s\n", k.ToString().c_str());
742 for (int i = 0; i < 100; i++)
744 uint256 k = (~uint256(0) << i);
745 printf("%s\n", k.ToString().c_str());