eymiha_util 0.1.5 → 0.1.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (58) hide show
  1. data/gem_package.rb +1 -1
  2. data/html/classes/BaseEnvelope.html +203 -203
  3. data/html/classes/BaseEnvelope.src/M000001.html +15 -15
  4. data/html/classes/BaseEnvelope.src/M000002.html +15 -15
  5. data/html/classes/BaseEnvelope.src/M000003.html +15 -15
  6. data/html/classes/Enum.html +133 -0
  7. data/html/classes/Envelope.html +328 -328
  8. data/html/classes/Envelope.src/M000016.html +15 -15
  9. data/html/classes/Envelope.src/M000017.html +15 -15
  10. data/html/classes/Envelope.src/M000018.html +15 -15
  11. data/html/classes/Envelope.src/M000019.html +15 -15
  12. data/html/classes/Envelope.src/M000020.html +15 -15
  13. data/html/classes/Envelope.src/M000021.html +15 -15
  14. data/html/classes/Envelope.src/M000023.html +15 -15
  15. data/html/classes/EnvelopeException.html +118 -118
  16. data/html/classes/ForwardReference.html +203 -203
  17. data/html/classes/ForwardReference.src/M000024.html +20 -20
  18. data/html/classes/ForwardReference.src/M000025.html +17 -17
  19. data/html/classes/ForwardReferencer.html +173 -173
  20. data/html/classes/ForwardReferencing.html +319 -319
  21. data/html/classes/ForwardReferencing.src/M000026.html +19 -19
  22. data/html/classes/ForwardReferencing.src/M000027.html +19 -19
  23. data/html/classes/ForwardReferencing.src/M000028.html +19 -19
  24. data/html/classes/ForwardReferencing.src/M000029.html +31 -31
  25. data/html/classes/ForwardReferencing.src/M000030.html +17 -17
  26. data/html/classes/ForwardReferencing.src/M000031.html +24 -24
  27. data/html/classes/ForwardReferencing.src/M000032.html +17 -17
  28. data/html/classes/ForwardReferencing.src/M000033.html +17 -17
  29. data/html/classes/ForwardReferencing.src/M000034.html +17 -17
  30. data/html/classes/Histogram.html +324 -324
  31. data/html/classes/Histogram.src/M000007.html +15 -15
  32. data/html/classes/Histogram.src/M000008.html +15 -15
  33. data/html/classes/Histogram.src/M000009.html +15 -15
  34. data/html/classes/Histogram.src/M000010.html +15 -15
  35. data/html/classes/Histogram.src/M000011.html +15 -15
  36. data/html/classes/Histogram.src/M000012.html +15 -15
  37. data/html/classes/Histogram.src/M000013.html +15 -15
  38. data/html/classes/Histogram.src/M000014.html +15 -15
  39. data/html/classes/Histogram.src/M000015.html +15 -15
  40. data/html/classes/HistogramException.html +117 -117
  41. data/html/classes/MethodicHash.html +221 -221
  42. data/html/classes/MethodicHash.src/M000004.html +15 -15
  43. data/html/classes/MethodicHash.src/M000005.html +15 -15
  44. data/html/classes/MethodicHash.src/M000006.html +15 -15
  45. data/html/created.rid +1 -1
  46. data/html/files/lib/enum_rb.html +123 -0
  47. data/html/files/lib/envelope_rb.html +108 -108
  48. data/html/files/lib/forward_referencing_rb.html +119 -119
  49. data/html/files/lib/histogram_rb.html +108 -108
  50. data/html/files/lib/methodic_hash_rb.html +139 -139
  51. data/html/fr_class_index.html +35 -34
  52. data/html/fr_file_index.html +30 -29
  53. data/html/fr_method_index.html +59 -59
  54. data/html/index.html +23 -23
  55. data/html/rdoc-style.css +207 -207
  56. data/lib/enum.rb +57 -0
  57. data/test/tc_enum.rb +70 -0
  58. metadata +6 -2
data/html/classes/BaseEnvelope.src/M000002.html CHANGED
@@ -1,20 +1,20 @@
1
- <?xml version="1.0" encoding="iso-8859-1"?>
2
- <!DOCTYPE html
3
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
-
6
- <html>
7
- <head>
8
- <title>raise_no_compare (BaseEnvelope)</title>
9
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
10
- <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
11
- </head>
12
- <body class="standalone-code">
13
- <pre><span class="ruby-comment cmt"># File lib/envelope.rb, line 24</span>
1
+ <?xml version="1.0" encoding="iso-8859-1"?>
2
+ <!DOCTYPE html
3
+ PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
+
6
+ <html>
7
+ <head>
8
+ <title>raise_no_compare (BaseEnvelope)</title>
9
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
10
+ <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
11
+ </head>
12
+ <body class="standalone-code">
13
+ <pre><span class="ruby-comment cmt"># File lib/envelope.rb, line 24</span>
14
14
  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">raise_no_compare</span>(<span class="ruby-identifier">value</span>=<span class="ruby-keyword kw">nil</span>)
15
15
  <span class="ruby-identifier">value</span> = <span class="ruby-node">&quot;'#{value}' &quot;</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">value</span> <span class="ruby-operator">==</span> <span class="ruby-keyword kw">nil</span>
16
16
  <span class="ruby-identifier">raise</span> <span class="ruby-constant">EnvelopeException</span>,
17
17
  <span class="ruby-node">&quot;The value #{value}cannot be compared with the envelope&quot;</span>
18
- <span class="ruby-keyword kw">end</span></pre>
19
- </body>
18
+ <span class="ruby-keyword kw">end</span></pre>
19
+ </body>
20
20
  </html>
data/html/classes/BaseEnvelope.src/M000003.html CHANGED
@@ -1,18 +1,18 @@
1
- <?xml version="1.0" encoding="iso-8859-1"?>
2
- <!DOCTYPE html
3
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
-
6
- <html>
7
- <head>
8
- <title>new (BaseEnvelope)</title>
9
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
10
- <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
11
- </head>
12
- <body class="standalone-code">
13
- <pre><span class="ruby-comment cmt"># File lib/envelope.rb, line 34</span>
1
+ <?xml version="1.0" encoding="iso-8859-1"?>
2
+ <!DOCTYPE html
3
+ PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
+
6
+ <html>
7
+ <head>
8
+ <title>new (BaseEnvelope)</title>
9
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
10
+ <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
11
+ </head>
12
+ <body class="standalone-code">
13
+ <pre><span class="ruby-comment cmt"># File lib/envelope.rb, line 34</span>
14
14
  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>
15
15
  <span class="ruby-ivar">@count</span> = <span class="ruby-value">0</span>
16
- <span class="ruby-keyword kw">end</span></pre>
17
- </body>
16
+ <span class="ruby-keyword kw">end</span></pre>
17
+ </body>
18
18
  </html>
data/html/classes/Enum.html ADDED
@@ -0,0 +1,133 @@
1
+ <?xml version="1.0" encoding="iso-8859-1"?>
2
+ <!DOCTYPE html
3
+ PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
+
6
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7
+ <head>
8
+ <title>Class: Enum</title>
9
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
10
+ <meta http-equiv="Content-Script-Type" content="text/javascript" />
11
+ <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
12
+ <script type="text/javascript">
13
+ // <![CDATA[
14
+
15
+ function popupCode( url ) {
16
+ window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
17
+ }
18
+
19
+ function toggleCode( id ) {
20
+ if ( document.getElementById )
21
+ elem = document.getElementById( id );
22
+ else if ( document.all )
23
+ elem = eval( "document.all." + id );
24
+ else
25
+ return false;
26
+
27
+ elemStyle = elem.style;
28
+
29
+ if ( elemStyle.display != "block" ) {
30
+ elemStyle.display = "block"
31
+ } else {
32
+ elemStyle.display = "none"
33
+ }
34
+
35
+ return true;
36
+ }
37
+
38
+ // Make codeblocks hidden by default
39
+ document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
40
+
41
+ // ]]>
42
+ </script>
43
+
44
+ </head>
45
+ <body>
46
+
47
+
48
+
49
+ <div id="classHeader">
50
+ <table class="header-table">
51
+ <tr class="top-aligned-row">
52
+ <td><strong>Class</strong></td>
53
+ <td class="class-name-in-header">Enum</td>
54
+ </tr>
55
+ <tr class="top-aligned-row">
56
+ <td><strong>In:</strong></td>
57
+ <td>
58
+ <a href="../files/lib/enum_rb.html">
59
+ lib/enum.rb
60
+ </a>
61
+ <br />
62
+ </td>
63
+ </tr>
64
+
65
+ <tr class="top-aligned-row">
66
+ <td><strong>Parent:</strong></td>
67
+ <td>
68
+ Object
69
+ </td>
70
+ </tr>
71
+ </table>
72
+ </div>
73
+ <!-- banner header -->
74
+
75
+ <div id="bodyContent">
76
+
77
+
78
+
79
+ <div id="contextContent">
80
+
81
+ <div id="description">
82
+ <p>
83
+ Enums are used to build a sets of enumerated values.
84
+ </p>
85
+ <p>
86
+ Numeric and bitwise enums are provided, and include provisions for assigned
87
+ values and the allowance of gaps.
88
+ </p>
89
+ <pre>
90
+ enum %w(N1 N2 +2 N3 N4 =7 N5 N6 3 N7)
91
+ </pre>
92
+ <p>
93
+ gives N1 = 0, N2 = 1, N3 = 4, N4 = 5, N5 = 7, N6 = 8 and N7 = 3
94
+ </p>
95
+ <pre>
96
+ enum_bitwise %w(B1 B2 +2 B3 B4 =7 B5 B6 3 B7)
97
+ </pre>
98
+ <p>
99
+ gives B1 = 1, B2 = 2, B3 = 16, B4 = 32, B5 = 128, B6 = 256 and B7 = 8
100
+ </p>
101
+
102
+ </div>
103
+
104
+
105
+ </div>
106
+
107
+
108
+ </div>
109
+
110
+
111
+ <!-- if includes -->
112
+
113
+ <div id="section">
114
+
115
+
116
+
117
+
118
+
119
+
120
+
121
+
122
+ <!-- if method_list -->
123
+
124
+
125
+ </div>
126
+
127
+
128
+ <div id="validator-badges">
129
+ <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
130
+ </div>
131
+
132
+ </body>
133
+ </html>
data/html/classes/Envelope.html CHANGED
@@ -1,329 +1,329 @@
1
- <?xml version="1.0" encoding="iso-8859-1"?>
2
- <!DOCTYPE html
3
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
-
6
- <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7
- <head>
8
- <title>Class: Envelope</title>
9
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
10
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
11
- <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
12
- <script type="text/javascript">
13
- // <![CDATA[
14
-
15
- function popupCode( url ) {
16
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
17
- }
18
-
19
- function toggleCode( id ) {
20
- if ( document.getElementById )
21
- elem = document.getElementById( id );
22
- else if ( document.all )
23
- elem = eval( "document.all." + id );
24
- else
25
- return false;
26
-
27
- elemStyle = elem.style;
28
-
29
- if ( elemStyle.display != "block" ) {
30
- elemStyle.display = "block"
31
- } else {
32
- elemStyle.display = "none"
33
- }
34
-
35
- return true;
36
- }
37
-
38
- // Make codeblocks hidden by default
39
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
40
-
41
- // ]]>
42
- </script>
43
-
44
- </head>
45
- <body>
46
-
47
-
48
-
49
- <div id="classHeader">
50
- <table class="header-table">
51
- <tr class="top-aligned-row">
52
- <td><strong>Class</strong></td>
53
- <td class="class-name-in-header">Envelope</td>
54
- </tr>
55
- <tr class="top-aligned-row">
56
- <td><strong>In:</strong></td>
57
- <td>
58
- <a href="../files/lib/envelope_rb.html">
59
- lib/envelope.rb
60
- </a>
61
- <br />
62
- </td>
63
- </tr>
64
-
65
- <tr class="top-aligned-row">
66
- <td><strong>Parent:</strong></td>
67
- <td>
68
- <a href="BaseEnvelope.html">
69
- BaseEnvelope
70
- </a>
71
- </td>
72
- </tr>
73
- </table>
74
- </div>
75
- <!-- banner header -->
76
-
77
- <div id="bodyContent">
78
-
79
-
80
-
81
- <div id="contextContent">
82
-
83
- <div id="description">
84
- <p>
85
- An <a href="Envelope.html">Envelope</a> is the minimum envelope that will
86
- completely contain a set of values. Values may be added to an instance, and
87
- it can return the number of values considered so far and its <a
88
- href="Envelope.html#M000019">high</a> and <a
89
- href="Envelope.html#M000020">low</a> boundaries.
90
- </p>
91
- <p>
92
- Envelopes can be used to generate ranges, however the result may be of
93
- limited utility if the types of values being enveloped don&#8216;t play
94
- nicely with ranges.
95
- </p>
96
-
97
- </div>
98
-
99
-
100
- </div>
101
-
102
- <div id="method-list">
103
- <h3 class="section-bar">Methods</h3>
104
-
105
- <div class="name-list">
106
- <a href="#M000022">===</a>&nbsp;&nbsp;
107
- <a href="#M000018">add</a>&nbsp;&nbsp;
108
- <a href="#M000021">contains?</a>&nbsp;&nbsp;
109
- <a href="#M000019">high</a>&nbsp;&nbsp;
110
- <a href="#M000020">low</a>&nbsp;&nbsp;
111
- <a href="#M000016">new</a>&nbsp;&nbsp;
112
- <a href="#M000023">to_range</a>&nbsp;&nbsp;
113
- <a href="#M000017">to_s</a>&nbsp;&nbsp;
114
- </div>
115
- </div>
116
-
117
- </div>
118
-
119
-
120
- <!-- if includes -->
121
-
122
- <div id="section">
123
-
124
-
125
-
126
-
127
-
128
-
129
-
130
-
131
- <!-- if method_list -->
132
- <div id="methods">
133
- <h3 class="section-bar">Public Class methods</h3>
134
-
135
- <div id="method-M000016" class="method-detail">
136
- <a name="M000016"></a>
137
-
138
- <div class="method-heading">
139
- <a href="Envelope.src/M000016.html" target="Code" class="method-signature"
140
- onclick="popupCode('Envelope.src/M000016.html');return false;">
141
- <span class="method-name">new</span><span class="method-args">(value=nil)</span>
142
- </a>
143
- </div>
144
-
145
- <div class="method-description">
146
- <p>
147
- Creates and returns an instance. If an argument is given, it is passed to
148
- the set method to initialize the <a href="Envelope.html#M000016">new</a>
149
- instance.
150
- </p>
151
- </div>
152
- </div>
153
-
154
- <h3 class="section-bar">Public Instance methods</h3>
155
-
156
- <div id="method-M000022" class="method-detail">
157
- <a name="M000022"></a>
158
-
159
- <div class="method-heading">
160
- <span class="method-name">===</span><span class="method-args">(value)</span>
161
- </div>
162
-
163
- <div class="method-description">
164
- <p>
165
- Alias for contains?
166
- </p>
167
- </div>
168
- </div>
169
-
170
- <div id="method-M000018" class="method-detail">
171
- <a name="M000018"></a>
172
-
173
- <div class="method-heading">
174
- <a href="Envelope.src/M000018.html" target="Code" class="method-signature"
175
- onclick="popupCode('Envelope.src/M000018.html');return false;">
176
- <span class="method-name">add</span><span class="method-args">(value)</span>
177
- </a>
178
- </div>
179
-
180
- <div class="method-description">
181
- <p>
182
- Adds a value to the instance. When
183
- </p>
184
- <ul>
185
- <li>x is an <a href="Envelope.html">Envelope</a>, it is coalesced into the
186
- instance.
187
-
188
- </li>
189
- <li>otherwise, the envelope is extened to contain the value.
190
-
191
- </li>
192
- <li>if the value cannot be compared to the boundaries, an <a
193
- href="EnvelopeException.html">EnvelopeException</a> is raised.
194
-
195
- </li>
196
- </ul>
197
- <p>
198
- The modified instance is returned.
199
- </p>
200
- </div>
201
- </div>
202
-
203
- <div id="method-M000021" class="method-detail">
204
- <a name="M000021"></a>
205
-
206
- <div class="method-heading">
207
- <a href="Envelope.src/M000021.html" target="Code" class="method-signature"
208
- onclick="popupCode('Envelope.src/M000021.html');return false;">
209
- <span class="method-name">contains?</span><span class="method-args">(value)</span>
210
- </a>
211
- </div>
212
-
213
- <div class="method-description">
214
- <p>
215
- Returns true if the instance completely contains the argument:
216
- </p>
217
- <ul>
218
- <li>value is an <a href="Envelope.html">Envelope</a>, its <a
219
- href="Envelope.html#M000019">high</a> and <a
220
- href="Envelope.html#M000020">low</a> are contained.
221
-
222
- </li>
223
- <li>otherwise, the value is contained.
224
-
225
- </li>
226
- <li>if the value cannot be compared to the boundaries, an <a
227
- href="EnvelopeException.html">EnvelopeException</a> is raised.
228
-
229
- </li>
230
- </ul>
231
- </div>
232
- </div>
233
-
234
- <div id="method-M000019" class="method-detail">
235
- <a name="M000019"></a>
236
-
237
- <div class="method-heading">
238
- <a href="Envelope.src/M000019.html" target="Code" class="method-signature"
239
- onclick="popupCode('Envelope.src/M000019.html');return false;">
240
- <span class="method-name">high</span><span class="method-args">()</span>
241
- </a>
242
- </div>
243
-
244
- <div class="method-description">
245
- <p>
246
- Returns the <a href="Envelope.html#M000019">high</a> boundary of the
247
- instance.
248
- </p>
249
- <ul>
250
- <li>if there are no boundaries, an <a
251
- href="EnvelopeException.html">EnvelopeException</a> is raised.
252
-
253
- </li>
254
- </ul>
255
- </div>
256
- </div>
257
-
258
- <div id="method-M000020" class="method-detail">
259
- <a name="M000020"></a>
260
-
261
- <div class="method-heading">
262
- <a href="Envelope.src/M000020.html" target="Code" class="method-signature"
263
- onclick="popupCode('Envelope.src/M000020.html');return false;">
264
- <span class="method-name">low</span><span class="method-args">()</span>
265
- </a>
266
- </div>
267
-
268
- <div class="method-description">
269
- <p>
270
- Returns the <a href="Envelope.html#M000020">low</a> boundary of the
271
- instance.
272
- </p>
273
- <ul>
274
- <li>if there are no boundaries, an <a
275
- href="EnvelopeException.html">EnvelopeException</a> is raised.
276
-
277
- </li>
278
- </ul>
279
- </div>
280
- </div>
281
-
282
- <div id="method-M000023" class="method-detail">
283
- <a name="M000023"></a>
284
-
285
- <div class="method-heading">
286
- <a href="Envelope.src/M000023.html" target="Code" class="method-signature"
287
- onclick="popupCode('Envelope.src/M000023.html');return false;">
288
- <span class="method-name">to_range</span><span class="method-args">()</span>
289
- </a>
290
- </div>
291
-
292
- <div class="method-description">
293
- <p>
294
- Returns an inclusive range from the <a href="Envelope.html#M000020">low</a>
295
- to <a href="Envelope.html#M000019">high</a> boundaries
296
- </p>
297
- </div>
298
- </div>
299
-
300
- <div id="method-M000017" class="method-detail">
301
- <a name="M000017"></a>
302
-
303
- <div class="method-heading">
304
- <a href="Envelope.src/M000017.html" target="Code" class="method-signature"
305
- onclick="popupCode('Envelope.src/M000017.html');return false;">
306
- <span class="method-name">to_s</span><span class="method-args">()</span>
307
- </a>
308
- </div>
309
-
310
- <div class="method-description">
311
- <p>
312
- Returns a string representation of the instance.
313
- </p>
314
- </div>
315
- </div>
316
-
317
-
318
- </div>
319
-
320
-
321
- </div>
322
-
323
-
324
- <div id="validator-badges">
325
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
326
- </div>
327
-
328
- </body>
1
+ <?xml version="1.0" encoding="iso-8859-1"?>
2
+ <!DOCTYPE html
3
+ PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
+
6
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7
+ <head>
8
+ <title>Class: Envelope</title>
9
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
10
+ <meta http-equiv="Content-Script-Type" content="text/javascript" />
11
+ <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
12
+ <script type="text/javascript">
13
+ // <![CDATA[
14
+
15
+ function popupCode( url ) {
16
+ window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
17
+ }
18
+
19
+ function toggleCode( id ) {
20
+ if ( document.getElementById )
21
+ elem = document.getElementById( id );
22
+ else if ( document.all )
23
+ elem = eval( "document.all." + id );
24
+ else
25
+ return false;
26
+
27
+ elemStyle = elem.style;
28
+
29
+ if ( elemStyle.display != "block" ) {
30
+ elemStyle.display = "block"
31
+ } else {
32
+ elemStyle.display = "none"
33
+ }
34
+
35
+ return true;
36
+ }
37
+
38
+ // Make codeblocks hidden by default
39
+ document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
40
+
41
+ // ]]>
42
+ </script>
43
+
44
+ </head>
45
+ <body>
46
+
47
+
48
+
49
+ <div id="classHeader">
50
+ <table class="header-table">
51
+ <tr class="top-aligned-row">
52
+ <td><strong>Class</strong></td>
53
+ <td class="class-name-in-header">Envelope</td>
54
+ </tr>
55
+ <tr class="top-aligned-row">
56
+ <td><strong>In:</strong></td>
57
+ <td>
58
+ <a href="../files/lib/envelope_rb.html">
59
+ lib/envelope.rb
60
+ </a>
61
+ <br />
62
+ </td>
63
+ </tr>
64
+
65
+ <tr class="top-aligned-row">
66
+ <td><strong>Parent:</strong></td>
67
+ <td>
68
+ <a href="BaseEnvelope.html">
69
+ BaseEnvelope
70
+ </a>
71
+ </td>
72
+ </tr>
73
+ </table>
74
+ </div>
75
+ <!-- banner header -->
76
+
77
+ <div id="bodyContent">
78
+
79
+
80
+
81
+ <div id="contextContent">
82
+
83
+ <div id="description">
84
+ <p>
85
+ An <a href="Envelope.html">Envelope</a> is the minimum envelope that will
86
+ completely contain a set of values. Values may be added to an instance, and
87
+ it can return the number of values considered so far and its <a
88
+ href="Envelope.html#M000019">high</a> and <a
89
+ href="Envelope.html#M000020">low</a> boundaries.
90
+ </p>
91
+ <p>
92
+ Envelopes can be used to generate ranges, however the result may be of
93
+ limited utility if the types of values being enveloped don&#8216;t play
94
+ nicely with ranges.
95
+ </p>
96
+
97
+ </div>
98
+
99
+
100
+ </div>
101
+
102
+ <div id="method-list">
103
+ <h3 class="section-bar">Methods</h3>
104
+
105
+ <div class="name-list">
106
+ <a href="#M000022">===</a>&nbsp;&nbsp;
107
+ <a href="#M000018">add</a>&nbsp;&nbsp;
108
+ <a href="#M000021">contains?</a>&nbsp;&nbsp;
109
+ <a href="#M000019">high</a>&nbsp;&nbsp;
110
+ <a href="#M000020">low</a>&nbsp;&nbsp;
111
+ <a href="#M000016">new</a>&nbsp;&nbsp;
112
+ <a href="#M000023">to_range</a>&nbsp;&nbsp;
113
+ <a href="#M000017">to_s</a>&nbsp;&nbsp;
114
+ </div>
115
+ </div>
116
+
117
+ </div>
118
+
119
+
120
+ <!-- if includes -->
121
+
122
+ <div id="section">
123
+
124
+
125
+
126
+
127
+
128
+
129
+
130
+
131
+ <!-- if method_list -->
132
+ <div id="methods">
133
+ <h3 class="section-bar">Public Class methods</h3>
134
+
135
+ <div id="method-M000016" class="method-detail">
136
+ <a name="M000016"></a>
137
+
138
+ <div class="method-heading">
139
+ <a href="Envelope.src/M000016.html" target="Code" class="method-signature"
140
+ onclick="popupCode('Envelope.src/M000016.html');return false;">
141
+ <span class="method-name">new</span><span class="method-args">(value=nil)</span>
142
+ </a>
143
+ </div>
144
+
145
+ <div class="method-description">
146
+ <p>
147
+ Creates and returns an instance. If an argument is given, it is passed to
148
+ the set method to initialize the <a href="Envelope.html#M000016">new</a>
149
+ instance.
150
+ </p>
151
+ </div>
152
+ </div>
153
+
154
+ <h3 class="section-bar">Public Instance methods</h3>
155
+
156
+ <div id="method-M000022" class="method-detail">
157
+ <a name="M000022"></a>
158
+
159
+ <div class="method-heading">
160
+ <span class="method-name">===</span><span class="method-args">(value)</span>
161
+ </div>
162
+
163
+ <div class="method-description">
164
+ <p>
165
+ Alias for contains?
166
+ </p>
167
+ </div>
168
+ </div>
169
+
170
+ <div id="method-M000018" class="method-detail">
171
+ <a name="M000018"></a>
172
+
173
+ <div class="method-heading">
174
+ <a href="Envelope.src/M000018.html" target="Code" class="method-signature"
175
+ onclick="popupCode('Envelope.src/M000018.html');return false;">
176
+ <span class="method-name">add</span><span class="method-args">(value)</span>
177
+ </a>
178
+ </div>
179
+
180
+ <div class="method-description">
181
+ <p>
182
+ Adds a value to the instance. When
183
+ </p>
184
+ <ul>
185
+ <li>x is an <a href="Envelope.html">Envelope</a>, it is coalesced into the
186
+ instance.
187
+
188
+ </li>
189
+ <li>otherwise, the envelope is extened to contain the value.
190
+
191
+ </li>
192
+ <li>if the value cannot be compared to the boundaries, an <a
193
+ href="EnvelopeException.html">EnvelopeException</a> is raised.
194
+
195
+ </li>
196
+ </ul>
197
+ <p>
198
+ The modified instance is returned.
199
+ </p>
200
+ </div>
201
+ </div>
202
+
203
+ <div id="method-M000021" class="method-detail">
204
+ <a name="M000021"></a>
205
+
206
+ <div class="method-heading">
207
+ <a href="Envelope.src/M000021.html" target="Code" class="method-signature"
208
+ onclick="popupCode('Envelope.src/M000021.html');return false;">
209
+ <span class="method-name">contains?</span><span class="method-args">(value)</span>
210
+ </a>
211
+ </div>
212
+
213
+ <div class="method-description">
214
+ <p>
215
+ Returns true if the instance completely contains the argument:
216
+ </p>
217
+ <ul>
218
+ <li>value is an <a href="Envelope.html">Envelope</a>, its <a
219
+ href="Envelope.html#M000019">high</a> and <a
220
+ href="Envelope.html#M000020">low</a> are contained.
221
+
222
+ </li>
223
+ <li>otherwise, the value is contained.
224
+
225
+ </li>
226
+ <li>if the value cannot be compared to the boundaries, an <a
227
+ href="EnvelopeException.html">EnvelopeException</a> is raised.
228
+
229
+ </li>
230
+ </ul>
231
+ </div>
232
+ </div>
233
+
234
+ <div id="method-M000019" class="method-detail">
235
+ <a name="M000019"></a>
236
+
237
+ <div class="method-heading">
238
+ <a href="Envelope.src/M000019.html" target="Code" class="method-signature"
239
+ onclick="popupCode('Envelope.src/M000019.html');return false;">
240
+ <span class="method-name">high</span><span class="method-args">()</span>
241
+ </a>
242
+ </div>
243
+
244
+ <div class="method-description">
245
+ <p>
246
+ Returns the <a href="Envelope.html#M000019">high</a> boundary of the
247
+ instance.
248
+ </p>
249
+ <ul>
250
+ <li>if there are no boundaries, an <a
251
+ href="EnvelopeException.html">EnvelopeException</a> is raised.
252
+
253
+ </li>
254
+ </ul>
255
+ </div>
256
+ </div>
257
+
258
+ <div id="method-M000020" class="method-detail">
259
+ <a name="M000020"></a>
260
+
261
+ <div class="method-heading">
262
+ <a href="Envelope.src/M000020.html" target="Code" class="method-signature"
263
+ onclick="popupCode('Envelope.src/M000020.html');return false;">
264
+ <span class="method-name">low</span><span class="method-args">()</span>
265
+ </a>
266
+ </div>
267
+
268
+ <div class="method-description">
269
+ <p>
270
+ Returns the <a href="Envelope.html#M000020">low</a> boundary of the
271
+ instance.
272
+ </p>
273
+ <ul>
274
+ <li>if there are no boundaries, an <a
275
+ href="EnvelopeException.html">EnvelopeException</a> is raised.
276
+
277
+ </li>
278
+ </ul>
279
+ </div>
280
+ </div>
281
+
282
+ <div id="method-M000023" class="method-detail">
283
+ <a name="M000023"></a>
284
+
285
+ <div class="method-heading">
286
+ <a href="Envelope.src/M000023.html" target="Code" class="method-signature"
287
+ onclick="popupCode('Envelope.src/M000023.html');return false;">
288
+ <span class="method-name">to_range</span><span class="method-args">()</span>
289
+ </a>
290
+ </div>
291
+
292
+ <div class="method-description">
293
+ <p>
294
+ Returns an inclusive range from the <a href="Envelope.html#M000020">low</a>
295
+ to <a href="Envelope.html#M000019">high</a> boundaries
296
+ </p>
297
+ </div>
298
+ </div>
299
+
300
+ <div id="method-M000017" class="method-detail">
301
+ <a name="M000017"></a>
302
+
303
+ <div class="method-heading">
304
+ <a href="Envelope.src/M000017.html" target="Code" class="method-signature"
305
+ onclick="popupCode('Envelope.src/M000017.html');return false;">
306
+ <span class="method-name">to_s</span><span class="method-args">()</span>
307
+ </a>
308
+ </div>
309
+
310
+ <div class="method-description">
311
+ <p>
312
+ Returns a string representation of the instance.
313
+ </p>
314
+ </div>
315
+ </div>
316
+
317
+
318
+ </div>
319
+
320
+
321
+ </div>
322
+
323
+
324
+ <div id="validator-badges">
325
+ <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
326
+ </div>
327
+
328
+ </body>
329
329
  </html>