aboutsummaryrefslogtreecommitdiffstats
path: root/common/number/int.go
blob: 0cac94254a05aa0e2dab40475d40c357659c4974 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
// Copyright 2015 The go-ethereum Authors
// This file is part of the go-ethereum library.
//
// The go-ethereum library is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// The go-ethereum library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.

package number

import (
    "math/big"

    "github.com/ethereum/go-ethereum/common"
)

var (
    tt256   = new(big.Int).Lsh(big.NewInt(1), 256)
    tt256m1 = new(big.Int).Sub(new(big.Int).Lsh(big.NewInt(1), 256), big.NewInt(1))
    tt255   = new(big.Int).Lsh(big.NewInt(1), 255)
)

func limitUnsigned256(x *Number) *Number {
    x.num.And(x.num, tt256m1)
    return x
}

func limitSigned256(x *Number) *Number {
    if x.num.Cmp(tt255) < 0 {
        return x
    }
    x.num.Sub(x.num, tt256)
    return x
}

// Initialiser is a Number function
type Initialiser func(n int64) *Number

// A Number represents a generic integer with a bounding function limiter. Limit is called after each operations
// to give "fake" bounded integers. New types of Number can be created through NewInitialiser returning a lambda
// with the new Initialiser.
type Number struct {
    num   *big.Int
    limit func(n *Number) *Number
}

// NewInitialiser returns a new initialiser for a new *Number without having to expose certain fields
func NewInitialiser(limiter func(*Number) *Number) Initialiser {
    return func(n int64) *Number {
        return &Number{big.NewInt(n), limiter}
    }
}

// Uint256 returns a Number with a UNSIGNED limiter up to 256 bits
func Uint256(n int64) *Number {
    return &Number{big.NewInt(n), limitUnsigned256}
}

// Int256 returns Number with a SIGNED limiter up to 256 bits
func Int256(n int64) *Number {
    return &Number{big.NewInt(n), limitSigned256}
}

// Big returns a Number with a SIGNED unlimited size
func Big(n int64) *Number {
    return &Number{big.NewInt(n), func(x *Number) *Number { return x }}
}

// Add sets i to sum of x+y
func (i *Number) Add(x, y *Number) *Number {
    i.num.Add(x.num, y.num)
    return i.limit(i)
}

// Sub sets i to difference of x-y
func (i *Number) Sub(x, y *Number) *Number {
    i.num.Sub(x.num, y.num)
    return i.limit(i)
}

// Mul sets i to product of x*y
func (i *Number) Mul(x, y *Number) *Number {
    i.num.Mul(x.num, y.num)
    return i.limit(i)
}

// Div sets i to the quotient prodject of x/y
func (i *Number) Div(x, y *Number) *Number {
    i.num.Div(x.num, y.num)
    return i.limit(i)
}

// Mod sets i to x % y
func (i *Number) Mod(x, y *Number) *Number {
    i.num.Mod(x.num, y.num)
    return i.limit(i)
}

// Lsh sets i to x << s
func (i *Number) Lsh(x *Number, s uint) *Number {
    i.num.Lsh(x.num, s)
    return i.limit(i)
}

// Pow sets i to x^y
func (i *Number) Pow(x, y *Number) *Number {
    i.num.Exp(x.num, y.num, big.NewInt(0))
    return i.limit(i)
}

// Setters

// Set sets x to i
func (i *Number) Set(x *Number) *Number {
    i.num.Set(x.num)
    return i.limit(i)
}

// SetBytes sets x bytes to i
func (i *Number) SetBytes(x []byte) *Number {
    i.num.SetBytes(x)
    return i.limit(i)
}

// Cmp compares x and y and returns:
//
//     -1 if x <  y
//     0 if x == y
//     +1 if x >  y
func (i *Number) Cmp(x *Number) int {
    return i.num.Cmp(x.num)
}

// Getters

// String returns the string representation of i
func (i *Number) String() string {
    return i.num.String()
}

// Bytes returns the byte representation of i
func (i *Number) Bytes() []byte {
    return i.num.Bytes()
}

// Uint64 returns the Uint64 representation of x. If x cannot be represented in an int64, the result is undefined.
func (i *Number) Uint64() uint64 {
    return i.num.Uint64()
}

// Int64 returns the int64 representation of x. If x cannot be represented in an int64, the result is undefined.
func (i *Number) Int64() int64 {
    return i.num.Int64()
}

// Int256 returns the signed version of i
func (i *Number) Int256() *Number {
    return Int(0).Set(i)
}

// Uint256 returns the unsigned version of i
func (i *Number) Uint256() *Number {
    return Uint(0).Set(i)
}

// FirstBitSet returns the index of the first bit that's set to 1
func (i *Number) FirstBitSet() int {
    for j := 0; j < i.num.BitLen(); j++ {
        if i.num.Bit(j) > 0 {
            return j
        }
    }

    return i.num.BitLen()
}

// Variables
var (
    Zero       = Uint(0)
    One        = Uint(1)
    Two        = Uint(2)
    MaxUint256 = Uint(0).SetBytes(common.Hex2Bytes("ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff"))

    MinOne = Int(-1)

    // "typedefs"
    Uint = Uint256
    Int  = Int256
)