File: ref_c_bignum.html

package info (click to toggle)
rubybook 0.2.1-1
  • links: PTS
  • area: non-free
  • in suites: etch, etch-m68k, lenny, squeeze, wheezy
  • size: 4,248 kB
  • ctags: 1,042
  • sloc: xml: 60,486; makefile: 25
file content (232 lines) | stat: -rw-r--r-- 10,350 bytes parent folder | download | duplicates (3)
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
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
<html><title>Programming Ruby: The Pragmatic Programmer's Guide</title><head><meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"><STYLE TYPE="text/css"><!--
       BODY    { margin-left: 1in;
                 width: 6in;
                 font-family: helvetica, arial, sans-serif;
               }
       H1      { color: #000080;
                 font-family: helvetica, arial, sans-serif;
                 font-size: 22pt;
                 margin-left: 0in
               }
       H2      { color: #000080;  font: bold x-large helvetica, sans-serif;
                 margin-left: 0in }
       H3      { color: #000080;  font: bold   large helvetica, sans-serif; }
       H4      { color: #000080;  font: italic large helvetica, sans-serif; }
       .ruby   { background: #fff0f0 }
       .header { color: white }
       .subheader { color: #ffdddd }
       .sidebar   { width: 6in }
       span.sans { font-family: helvetica, arial, sans-serif }
       -->
   </STYLE><table bgcolor="#a03030" cellpadding="3" border="0" cellspacing="0"><tr><td colspan="3"><table bgcolor="#902020" cellpadding="20"><tr><td><h1 class="header">Programming Ruby</h1><h3 class="subheader">The Pragmatic Programmer's Guide</h3></td></tr></table></td></tr><tr><td width="33%" align="left"><a class="subheader" href="ref_c_array.html">Previous &lt;</a></td><td width="33%" align="center" valign="middle"><a class="subheader" href="builtins.html">Contents ^</a><br></td><td width="33%" align="right"><a class="subheader" href="ref_c_binding.html">Next ></a><br></td></tr></table></head><body bgcolor="white">
<!--
    Copyright (c) 2001 by Addison Wesley Longman.  This
    material may be distributed only subject to the terms and
    conditions set forth in the Open Publication License, v1.0 or
    later (the latest version is presently available at
    http://www.opencontent.org/openpub/).
-->

<table><tr><td height="20"><img src="dot.gif" width="1" height="20"></td></tr></table><table border="0" width="100%" bgcolor="660066" cellpadding="10"><tr><td valign="center"><font color="white" size="7">class Bignum</font></td><td><table border="0"><tr><td><font color="white">
                Parent:
              </font></td><td><font color="white">Integer</font></td></tr><tr><td><font color="white">
                Version:
              </font></td><td><font color="white">
               1.6
              </font></td></tr></table></td></tr></table><p></p><H3>Index:</H3><a href="#Arithmeticoperations"><i>Arithmetic operations</i></a> <a href="#Bitoperations"><i>Bit operations</i></a> <a href="#_lt_eq_lt"><i>&lt;=></i></a> <a href="#_ob_cb"><i>[ ]</i></a> <a href="#size"><i>size</i></a> <a href="#to_f"><i>to_f</i></a> <a href="#to_i"><i>to_i</i></a> <a href="#to_s"><i>to_s</i></a> <p></p><hr>
    <code>Bignum</code> objects hold integers outside the range of
  <code>Fixnum</code>. <code>Bignum</code> objects are created automatically when
  integer calculations would otherwise overflow a <code>Fixnum</code>. When a
  calculation involving <code>Bignum</code> objects returns a result that will 
  fit in a <code>Fixnum</code>, the result is automatically converted.
<P></P>
  For the purposes of the bitwise operations and <code>[]</code>, a
  <code>Bignum</code> is treated as if it were an infinite-length bitstring
  with 2's complement representation.
<P></P>
  While <code>Fixnum</code> values are immediate, <code>Bignum</code> objects are
  not---assignment and parameter passing work with references to
  objects, not the objects themselves.
<P></P>
  <table border="0" width="100%" cellpadding="10"><tr><td valign="center" colspan="2" bgcolor="990066"><font color="white" size="6">instance methods
       </font></td></tr><tr><td valign="center" bgcolor="#ff9999"><font size="4"><a name="Arithmeticoperations"><b>Arithmetic operations</b></a></font></td><td bgcolor="#ffaaaa">
<P></P>
      </td></tr><td></td><td>
<P></P>
      Performs various arithmetic operations on <i>big</i>.
<P></P>
      <table bgcolor="#fff0f0" cellspacing="0" border="0" cellpadding="3">
<tr>
  <td valign="top"><i>big</i></td>
  <td valign="top">+</td>
  <td valign="top"><i>aNumeric</i></td>
  <td valign="top">Addition</td>
</tr>
<tr>
  <td valign="top"><i>big</i></td>
  <td valign="top">--</td>
  <td valign="top"><i>aNumeric</i></td>
  <td valign="top">Subtraction</td>
</tr>
<tr>
  <td valign="top"><i>big</i></td>
  <td valign="top">*</td>
  <td valign="top"><i>aNumeric</i></td>
  <td valign="top">Multiplication</td>
</tr>
<tr>
  <td valign="top"><i>big</i></td>
  <td valign="top">/</td>
  <td valign="top"><i>aNumeric</i></td>
  <td valign="top">Division</td>
</tr>
<tr>
  <td valign="top"><i>big</i></td>
  <td valign="top">%</td>
  <td valign="top"><i>aNumeric</i></td>
  <td valign="top">Modulo</td>
</tr>
<tr>
  <td valign="top"><i>big</i></td>
  <td valign="top">**</td>
  <td valign="top"><i>aNumeric</i></td>
  <td valign="top">Exponentiation</td>
</tr>
</table>
<P></P>
      </td><tr><td valign="center" bgcolor="#ff9999"><font size="4"><a name="Bitoperations"><b>Bit operations</b></a></font></td><td bgcolor="#ffaaaa">
<P></P>
      </td></tr><td></td><td>
<P></P>
      Performs various operations on the binary
      representations of the <code>Bignum</code>.&nbsp;
<P></P>
      <table bgcolor="#fff0f0" cellspacing="0" border="0" cellpadding="3">
<tr>
<td colspan="3" valign="top">~ <i>big</i></td>
  <td valign="top">Invert bits</td>
</tr>
<tr>
  <td valign="top"><i>big</i></td>
  <td valign="top">|</td>
  <td valign="top"><i>aNumeric</i></td>
  <td valign="top">Bitwise <font size="-2">OR</font></td>
</tr>
<tr>
  <td valign="top"><i>big</i></td>
  <td valign="top">&amp;</td>
  <td valign="top"><i>aNumeric</i></td>
  <td valign="top">Bitwise <font size="-2">AND</font></td>
</tr>
<tr>
  <td valign="top"><i>big</i></td>
  <td valign="top">^</td>
  <td valign="top"><i>aNumeric</i></td>
  <td valign="top">Bitwise <font size="-2">EXCLUSIVE</font> <font size="-2">OR</font></td>
</tr>
<tr>
  <td valign="top"><i>big</i></td>
  <td valign="top">&lt;&lt;</td>
  <td valign="top"><i>aNumeric</i></td>
  <td valign="top">Left-shift <em>aNumeric</em> bits</td>
</tr>
<tr>
  <td valign="top"><i>big</i></td>
  <td valign="top">>></td>
  <td valign="top"><i>aNumeric</i></td>
  <td valign="top">Right-shift <em>aNumeric</em> bits
                                        (with sign extension)</td>
</tr>
</table>
<P></P>
      </td><tr><td valign="center" bgcolor="#ff9999"><font size="4"><a name="_lt_eq_lt"><b>&lt;=></b></a></font></td><td bgcolor="#ffaaaa">
        <i>big</i> &lt;=> <i>aNumeric</i> -> -1, 0, +1
      </td></tr><td></td><td>
<P></P>
      Comparison---Returns -1, 0, or +1 depending on
      whether <i>big</i> is less
      than, equal to, or greater than <i>aNumeric</i>. This is the
      basis for the tests in <code>Comparable</code>.
<P></P>
      </td><tr><td valign="center" bgcolor="#ff9999"><font size="4"><a name="_ob_cb"><b>[ ]</b></a></font></td><td bgcolor="#ffaaaa">
        <i>big</i>[ <i>n</i> ] -> 0, 1
      </td></tr><td></td><td>
<P></P>
      Bit Reference---Returns the <em>n</em>th bit in
      the (assumed) binary representation of <i>big</i>,
      where <i>big</i>[0] is the least significant bit.
<P></P>

<table bgcolor="#fff0f0" cellspacing="0" border="0" cellpadding="3" width="400"><tr><td><pre>
a&nbsp;=&nbsp;9**15
50.downto(0)&nbsp;do&nbsp;|n|
&nbsp;&nbsp;print&nbsp;a[n]
end
</pre></td></tr></table>

<em>produces:</em>
<table bgcolor="#fff0f0" cellspacing="0" border="0" cellpadding="3" width="400"><tr><td><pre>
000101110110100000111000011110010100111100010111001
</pre></td></tr></table>

<P></P>
      </td><tr><td valign="center" bgcolor="#ff9999"><font size="4"><a name="size"><b>size</b></a></font></td><td bgcolor="#ffaaaa">
        <i>big</i>.size -> <i>anInteger</i>
      </td></tr><td></td><td>
<P></P>
      Returns the number of bytes in the machine representation
      of <i>big</i>. 
<P></P>

<table bgcolor="#fff0f0" cellspacing="0" border="0" cellpadding="3" width="500">
<tr>
  <td valign="top"><code>(256**10&nbsp;-&nbsp;1).size</code></td>
  <td valign="top"></td>
  <td valign="top"><code>12</code></td>
</tr>
<tr>
  <td valign="top"><code>(256**20&nbsp;-&nbsp;1).size</code></td>
  <td valign="top"></td>
  <td valign="top"><code>20</code></td>
</tr>
<tr>
  <td valign="top"><code>(256**40&nbsp;-&nbsp;1).size</code></td>
  <td valign="top"></td>
  <td valign="top"><code>40</code></td>
</tr>
</table>
<P></P>

<P></P>
      </td><tr><td valign="center" bgcolor="#ff9999"><font size="4"><a name="to_f"><b>to_f</b></a></font></td><td bgcolor="#ffaaaa">
        <i>big</i>.to_f -> <i>aFloat</i>
      </td></tr><td></td><td>
<P></P>
      Converts <i>big</i> to a <code>Float</code>.  If <i>big</i> doesn't fit in a
      <code>Float</code>, the result is infinity.
<P></P>
      </td><tr><td valign="center" bgcolor="#ff9999"><font size="4"><a name="to_i"><b>to_i</b></a></font></td><td bgcolor="#ffaaaa">
        <i>big</i>.to_i -> <i><i>big</i></i>
      </td></tr><td></td><td>
<P></P>
      Returns <i>big</i>.
<P></P>
      </td><tr><td valign="center" bgcolor="#ff9999"><font size="4"><a name="to_s"><b>to_s</b></a></font></td><td bgcolor="#ffaaaa">
        <i>big</i>.to_s -> <i>aString</i>
      </td></tr><td></td><td>
<P></P>
      Returns a string containing the decimal representation of <i>big</i>.
<P></P>
      </td></table>
<P></P>

<p></p><hr><table bgcolor="#a03030" cellpadding="10" border="0" cellspacing="0"><tr><td width="33%" align="left"><a class="subheader" href="ref_c_array.html">Previous &lt;</a></td><td width="33%" align="center" valign="middle"><a class="subheader" href="builtins.html">Contents ^</a><br></td><td width="33%" align="right"><a class="subheader" href="ref_c_binding.html">Next ></a><br></td></tr></table><p></p><font size="-1">Extracted from the book "Programming Ruby -
     The Pragmatic Programmer's Guide"</font><br><font size="-3">
      Copyright
      &#169;
      2000 Addison Wesley Longman, Inc. Released under the terms of the
      <a href="http://www.opencontent.org/openpub/">Open Publication License</a> V1.0.
        <br>
      This reference is available for
        <a href="http://www.pragmaticprogrammer.com/ruby/downloads/book.html">download</a>.
   </font></body></html>