Update version according to OSCI-856
[packages/precise/mcollective.git] / doc / classes / Array.html
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: Array</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">Array</td>
54         </tr>
55         <tr class="top-aligned-row">
56             <td><strong>In:</strong></td>
57             <td>
58                 <a href="../files/lib/mcollective/monkey_patches_rb.html">
59                 lib/mcollective/monkey_patches.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 a method # that walks an array in groups, pass a block to call the block on
84 each sub array
85 </p>
86
87     </div>
88
89
90    </div>
91
92     <div id="method-list">
93       <h3 class="section-bar">Methods</h3>
94
95       <div class="name-list">
96       <a href="#M000013">in_groups_of</a>&nbsp;&nbsp;
97       </div>
98     </div>
99
100   </div>
101
102
103     <!-- if includes -->
104
105     <div id="section">
106
107
108
109
110
111       
112
113
114     <!-- if method_list -->
115     <div id="methods">
116       <h3 class="section-bar">Public Instance methods</h3>
117
118       <div id="method-M000013" class="method-detail">
119         <a name="M000013"></a>
120
121         <div class="method-heading">
122           <a href="#M000013" class="method-signature">
123           <span class="method-name">in_groups_of</span><span class="method-args">(chunk_size, padded_with=nil) {|a| ...}</span>
124           </a>
125         </div>
126       
127         <div class="method-description">
128           <p><a class="source-toggle" href="#"
129             onclick="toggleCode('M000013-source');return false;">[Source]</a></p>
130           <div class="method-source-code" id="M000013-source">
131 <pre>
132     <span class="ruby-comment cmt"># File lib/mcollective/monkey_patches.rb, line 29</span>
133 29:   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">in_groups_of</span>(<span class="ruby-identifier">chunk_size</span>, <span class="ruby-identifier">padded_with</span>=<span class="ruby-keyword kw">nil</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>)
134 30:     <span class="ruby-identifier">arr</span> = <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">clone</span>
135 31: 
136 32:     <span class="ruby-comment cmt"># how many to add</span>
137 33:     <span class="ruby-identifier">padding</span> = <span class="ruby-identifier">chunk_size</span> <span class="ruby-operator">-</span> (<span class="ruby-identifier">arr</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">%</span> <span class="ruby-identifier">chunk_size</span>)
138 34: 
139 35:     <span class="ruby-comment cmt"># pad at the end</span>
140 36:     <span class="ruby-identifier">arr</span>.<span class="ruby-identifier">concat</span>([<span class="ruby-identifier">padded_with</span>] <span class="ruby-operator">*</span> <span class="ruby-identifier">padding</span>) <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">padding</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">chunk_size</span>
141 37: 
142 38:     <span class="ruby-comment cmt"># how many chunks we'll make</span>
143 39:     <span class="ruby-identifier">count</span> = <span class="ruby-identifier">arr</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">/</span> <span class="ruby-identifier">chunk_size</span>
144 40: 
145 41:     <span class="ruby-comment cmt"># make that many arrays</span>
146 42:     <span class="ruby-identifier">result</span> = []
147 43:     <span class="ruby-identifier">count</span>.<span class="ruby-identifier">times</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">s</span><span class="ruby-operator">|</span> <span class="ruby-identifier">result</span> <span class="ruby-operator">&lt;&lt;</span>  <span class="ruby-identifier">arr</span>[<span class="ruby-identifier">s</span> <span class="ruby-operator">*</span> <span class="ruby-identifier">chunk_size</span>, <span class="ruby-identifier">chunk_size</span>]}
148 44: 
149 45:     <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">block_given?</span>
150 46:       <span class="ruby-identifier">result</span>.<span class="ruby-identifier">each_with_index</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">a</span>, <span class="ruby-identifier">i</span><span class="ruby-operator">|</span>
151 47:         <span class="ruby-keyword kw">case</span> <span class="ruby-identifier">block</span>.<span class="ruby-identifier">arity</span>
152 48:           <span class="ruby-keyword kw">when</span> <span class="ruby-value">1</span>
153 49:             <span class="ruby-keyword kw">yield</span>(<span class="ruby-identifier">a</span>)
154 50:           <span class="ruby-keyword kw">when</span> <span class="ruby-value">2</span>
155 51:             <span class="ruby-keyword kw">yield</span>(<span class="ruby-identifier">a</span>, (<span class="ruby-identifier">i</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">result</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">-</span> <span class="ruby-value">1</span>))
156 52:           <span class="ruby-keyword kw">else</span>
157 53:             <span class="ruby-identifier">raise</span> <span class="ruby-node">&quot;Expected 1 or 2 arguments, got #{block.arity}&quot;</span>
158 54:         <span class="ruby-keyword kw">end</span>
159 55:       <span class="ruby-keyword kw">end</span>
160 56:     <span class="ruby-keyword kw">else</span>
161 57:       <span class="ruby-identifier">result</span>
162 58:     <span class="ruby-keyword kw">end</span>
163 59:   <span class="ruby-keyword kw">end</span>
164 </pre>
165           </div>
166         </div>
167       </div>
168
169
170     </div>
171
172
173   </div>
174
175
176 <div id="validator-badges">
177   <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
178 </div>
179
180 </body>
181 </html>