|
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> |
|
2 <html xmlns:yui="http://yuilibrary.com/rdf/1.0/yui.rdf#"> |
|
3 <head> |
|
4 <meta http-equiv="content-type" content="text/html; charset=UTF-8" /> |
|
5 <title>API: collection array-extras.js (YUI Library)</title> |
|
6 |
|
7 <link rel="stylesheet" type="text/css" href="assets/reset-fonts-grids-min.css" /> |
|
8 <link rel="stylesheet" type="text/css" href="assets/api.css" /> |
|
9 |
|
10 <script type="text/javascript" src="assets/api-js"></script> |
|
11 <script type="text/javascript" src="assets/ac-js"></script> |
|
12 </head> |
|
13 |
|
14 <body id="yahoo-com"> |
|
15 |
|
16 <div id="doc3" class="yui-t2"> |
|
17 <div id="hd"> |
|
18 <h1><a href="http://developer.yahoo.com/yui/" title="Yahoo! UI Library">Yahoo! UI Library</a></h1> |
|
19 <h3>collection <span class="subtitle">3.0.0b1</span></h3> |
|
20 <a href="./index.html" title="Yahoo! UI Library">Yahoo! UI Library</a> |
|
21 > <a href="./module_collection.html" title="collection">collection</a> |
|
22 |
|
23 > array-extras.js (source view) |
|
24 <form onsubmit="return false"> |
|
25 <div id="propertysearch"> |
|
26 Search: <input autocomplete="off" id="searchinput" /> |
|
27 <div id="searchresults"> |
|
28 |
|
29 </div> |
|
30 </div> |
|
31 </form> |
|
32 </div> |
|
33 |
|
34 <div id="bd"> |
|
35 <div id="yui-main"> |
|
36 <div class="yui-b"> |
|
37 <form action="#" name="yui-classopts-form" method="get" id="yui-classopts-form"> |
|
38 <fieldset> |
|
39 <legend>Filters</legend> |
|
40 <span class="classopts"><input type="checkbox" name="show_private" id="show_private" /> <label for="show_private">Show Private</label></span> |
|
41 <span class="classopts"><input type="checkbox" name="show_protected" id="show_protected" /> <label for="show_protected">Show Protected</label></span> |
|
42 <span class="classopts"><input type="checkbox" name="show_deprecated" id="show_deprecated" /> <label for="show_deprecated">Show Deprecated</label></span> |
|
43 </fieldset> |
|
44 </form> |
|
45 |
|
46 <div id="srcout"> |
|
47 <style> |
|
48 #doc3 .classopts { display:none; } |
|
49 </style> |
|
50 <div class="highlight" ><pre><span class="c">/**</span> |
|
51 <span class="c"> * Collection utilities beyond what is provided in the YUI core</span> |
|
52 <span class="c"> * @module collection</span> |
|
53 <span class="c"> */</span> |
|
54 |
|
55 <span class="k">var</span> <span class="nx">L</span> <span class="o">=</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">Lang</span><span class="o">,</span> <span class="nx">Native</span> <span class="o">=</span> <span class="nb">Array</span><span class="o">.</span><span class="nx">prototype</span><span class="o">,</span> <span class="nx">A</span> <span class="o">=</span> <span class="nx">Y</span><span class="o">.</span><span class="nb">Array</span><span class="o">;</span> |
|
56 |
|
57 <span class="c">/**</span> |
|
58 <span class="c"> * Adds the following array utilities to the YUI instance</span> |
|
59 <span class="c"> * (Y.Array). This is in addition to the methods provided</span> |
|
60 <span class="c"> * in the core.</span> |
|
61 <span class="c"> * @class YUI~array~extras</span> |
|
62 <span class="c"> */</span> |
|
63 |
|
64 <span class="c">/**</span> |
|
65 <span class="c"> * Returns the index of the last item in the array</span> |
|
66 <span class="c"> * that contains the specified value, -1 if the</span> |
|
67 <span class="c"> * value isn't found.</span> |
|
68 <span class="c"> * method Array.lastIndexOf</span> |
|
69 <span class="c"> * @static</span> |
|
70 <span class="c"> * @param a {Array} the array to search</span> |
|
71 <span class="c"> * @param val the value to search for</span> |
|
72 <span class="c"> * @return {int} the index of hte item that contains the value or -1</span> |
|
73 <span class="c"> */</span> |
|
74 <span class="nx">A</span><span class="o">.</span><span class="nx">lastIndexOf</span> <span class="o">=</span> <span class="o">(</span><span class="nx">Native</span><span class="o">.</span><span class="nx">lastIndexOf</span><span class="o">)</span> <span class="o">?</span> |
|
75 <span class="k">function</span><span class="o">(</span><span class="nx">a</span> <span class="o">,</span><span class="nx">val</span><span class="o">)</span> <span class="o">{</span> |
|
76 <span class="k">return</span> <span class="nx">a</span><span class="o">.</span><span class="nx">lastIndexOf</span><span class="o">(</span><span class="nx">val</span><span class="o">);</span> |
|
77 <span class="o">}</span> <span class="o">:</span> |
|
78 <span class="k">function</span><span class="o">(</span><span class="nx">a</span><span class="o">,</span> <span class="nx">val</span><span class="o">)</span> <span class="o">{</span> |
|
79 <span class="k">for</span> <span class="o">(</span><span class="k">var</span> <span class="nx">i</span><span class="o">=</span><span class="nx">a</span><span class="o">.</span><span class="nx">length</span><span class="o">-</span><span class="m">1</span><span class="o">;</span> <span class="nx">i</span><span class="o">>=</span><span class="m">0</span><span class="o">;</span> <span class="nx">i</span><span class="o">=</span><span class="nx">i</span><span class="o">-</span><span class="m">1</span><span class="o">)</span> <span class="o">{</span> |
|
80 <span class="k">if</span> <span class="o">(</span><span class="nx">a</span><span class="o">[</span><span class="nx">i</span><span class="o">]</span> <span class="o">===</span> <span class="nx">val</span><span class="o">)</span> <span class="o">{</span> |
|
81 <span class="k">break</span><span class="o">;</span> |
|
82 <span class="o">}</span> |
|
83 <span class="o">}</span> |
|
84 <span class="k">return</span> <span class="nx">i</span><span class="o">;</span> |
|
85 <span class="o">};</span> |
|
86 |
|
87 <span class="c">/**</span> |
|
88 <span class="c"> * Returns a copy of the array with the duplicate entries removed</span> |
|
89 <span class="c"> * @method Array.unique</span> |
|
90 <span class="c"> * @static</span> |
|
91 <span class="c"> * @param a {Array} the array to find the subset of uniques for</span> |
|
92 <span class="c"> * @param sort {bool} flag to denote if the array is sorted or not. Defaults to false, the more general operation</span> |
|
93 <span class="c"> * @return {Array} a copy of the array with duplicate entries removed</span> |
|
94 <span class="c"> */</span> |
|
95 <span class="nx">A</span><span class="o">.</span><span class="nx">unique</span> <span class="o">=</span> <span class="k">function</span><span class="o">(</span><span class="nx">a</span><span class="o">,</span> <span class="nx">sort</span><span class="o">)</span> <span class="o">{</span> |
|
96 <span class="k">var</span> <span class="nx">s</span> <span class="o">=</span> <span class="nx">L</span><span class="o">.</span><span class="nx">isValue</span><span class="o">(</span><span class="nx">sort</span><span class="o">)</span> <span class="o">?</span> <span class="nx">sort</span> <span class="o">:</span> <span class="kc">false</span><span class="o">,</span> |
|
97 <span class="nx">b</span> <span class="o">=</span> <span class="nx">a</span><span class="o">.</span><span class="nx">slice</span><span class="o">(),</span> <span class="nx">i</span> <span class="o">=</span> <span class="m">0</span><span class="o">,</span> <span class="nx">n</span> <span class="o">=</span> <span class="o">-</span><span class="m">1</span><span class="o">,</span> <span class="nx">item</span> <span class="o">=</span> <span class="kc">null</span><span class="o">;</span> |
|
98 <span class="k">if</span> <span class="o">(</span><span class="nx">s</span><span class="o">)</span> <span class="o">{</span> |
|
99 <span class="k">while</span> <span class="o">(</span><span class="nx">i</span> <span class="o"><</span> <span class="nx">b</span><span class="o">.</span><span class="nx">length</span><span class="o">)</span> <span class="o">{</span> |
|
100 <span class="k">if</span> <span class="o">(</span><span class="nx">b</span><span class="o">[</span><span class="nx">i</span><span class="o">]</span> <span class="o">===</span> <span class="nx">item</span><span class="o">)</span> <span class="o">{</span> |
|
101 <span class="nx">n</span> <span class="o">=</span> <span class="o">(</span><span class="nx">n</span> <span class="o">==</span> <span class="o">-</span><span class="m">1</span> <span class="o">?</span> <span class="nx">i</span> <span class="o">:</span> <span class="nx">n</span><span class="o">);</span> |
|
102 <span class="nx">i</span> <span class="o">+=</span> <span class="m">1</span><span class="o">;</span> |
|
103 <span class="o">}</span> <span class="k">else</span> <span class="k">if</span> <span class="o">(</span><span class="nx">n</span> <span class="o">!==</span> <span class="o">-</span><span class="m">1</span><span class="o">)</span> <span class="o">{</span> |
|
104 <span class="nx">b</span><span class="o">.</span><span class="nx">splice</span><span class="o">(</span><span class="nx">n</span><span class="o">,</span> <span class="nx">i</span><span class="o">-</span><span class="nx">n</span><span class="o">);</span> |
|
105 <span class="nx">i</span> <span class="o">=</span> <span class="nx">n</span><span class="o">;</span> |
|
106 <span class="nx">n</span> <span class="o">=</span> <span class="o">-</span><span class="m">1</span><span class="o">;</span> |
|
107 <span class="o">}</span> <span class="k">else</span> <span class="o">{</span> |
|
108 <span class="nx">item</span> <span class="o">=</span> <span class="nx">b</span><span class="o">[</span><span class="nx">i</span><span class="o">];</span> |
|
109 <span class="nx">i</span> <span class="o">+=</span> <span class="m">1</span><span class="o">;</span> |
|
110 <span class="o">}</span> |
|
111 <span class="o">}</span> |
|
112 <span class="k">return</span> <span class="nx">b</span><span class="o">;</span> |
|
113 <span class="o">}</span> <span class="k">else</span> <span class="o">{</span> |
|
114 <span class="k">while</span> <span class="o">(</span><span class="nx">i</span> <span class="o"><</span> <span class="nx">b</span><span class="o">.</span><span class="nx">length</span><span class="o">)</span> <span class="o">{</span> |
|
115 <span class="nx">item</span> <span class="o">=</span> <span class="nx">b</span><span class="o">[</span><span class="nx">i</span><span class="o">];</span> |
|
116 <span class="k">while</span> <span class="o">((</span><span class="nx">n</span> <span class="o">=</span> <span class="nx">b</span><span class="o">.</span><span class="nx">lastIndexOf</span><span class="o">(</span><span class="nx">item</span><span class="o">))</span> <span class="o">!==</span> <span class="nx">i</span><span class="o">)</span> <span class="o">{</span> |
|
117 <span class="nx">b</span><span class="o">.</span><span class="nx">splice</span><span class="o">(</span><span class="nx">n</span><span class="o">,</span> <span class="m">1</span><span class="o">);</span> |
|
118 <span class="o">}</span> |
|
119 <span class="nx">i</span> <span class="o">+=</span> <span class="m">1</span><span class="o">;</span> |
|
120 <span class="o">}</span> |
|
121 <span class="k">return</span> <span class="nx">b</span><span class="o">;</span> |
|
122 <span class="o">}</span> |
|
123 <span class="o">};</span> |
|
124 |
|
125 <span class="c">/**</span> |
|
126 <span class="c">* Executes the supplied function on each item in the array.</span> |
|
127 <span class="c">* Returns a new array containing the items that the supplied</span> |
|
128 <span class="c">* function returned true for.</span> |
|
129 <span class="c">* @method Array.filter</span> |
|
130 <span class="c">* @param a {Array} the array to iterate</span> |
|
131 <span class="c">* @param f {Function} the function to execute on each item</span> |
|
132 <span class="c">* @param o Optional context object</span> |
|
133 <span class="c">* @static</span> |
|
134 <span class="c">* @return {Array} The items on which the supplied function</span> |
|
135 <span class="c">* returned true. If no items matched an empty array is </span> |
|
136 <span class="c">* returned.</span> |
|
137 <span class="c">*/</span> |
|
138 <span class="nx">A</span><span class="o">.</span><span class="nx">filter</span> <span class="o">=</span> <span class="o">(</span><span class="nx">Native</span><span class="o">.</span><span class="nx">filter</span><span class="o">)</span> <span class="o">?</span> |
|
139 <span class="k">function</span><span class="o">(</span><span class="nx">a</span><span class="o">,</span> <span class="nx">f</span><span class="o">,</span> <span class="nx">o</span><span class="o">)</span> <span class="o">{</span> |
|
140 <span class="k">return</span> <span class="nx">Native</span><span class="o">.</span><span class="nx">filter</span><span class="o">.</span><span class="nx">call</span><span class="o">(</span><span class="nx">a</span><span class="o">,</span> <span class="nx">f</span><span class="o">,</span> <span class="nx">o</span><span class="o">);</span> |
|
141 <span class="o">}</span> <span class="o">:</span> |
|
142 <span class="k">function</span><span class="o">(</span><span class="nx">a</span><span class="o">,</span> <span class="nx">f</span><span class="o">,</span> <span class="nx">o</span><span class="o">)</span> <span class="o">{</span> |
|
143 <span class="k">var</span> <span class="nx">results</span> <span class="o">=</span> <span class="o">[];</span> |
|
144 <span class="nx">A</span><span class="o">.</span><span class="nx">each</span><span class="o">(</span><span class="nx">a</span><span class="o">,</span> <span class="k">function</span><span class="o">(</span><span class="nx">item</span><span class="o">,</span> <span class="nx">i</span><span class="o">,</span> <span class="nx">a</span><span class="o">)</span> <span class="o">{</span> |
|
145 <span class="k">if</span> <span class="o">(</span><span class="nx">f</span><span class="o">.</span><span class="nx">call</span><span class="o">(</span><span class="nx">o</span><span class="o">,</span> <span class="nx">item</span><span class="o">,</span> <span class="nx">i</span><span class="o">,</span> <span class="nx">a</span><span class="o">))</span> <span class="o">{</span> |
|
146 <span class="nx">results</span><span class="o">.</span><span class="nx">push</span><span class="o">(</span><span class="nx">item</span><span class="o">);</span> |
|
147 <span class="o">}</span> |
|
148 <span class="o">});</span> |
|
149 |
|
150 <span class="k">return</span> <span class="nx">results</span><span class="o">;</span> |
|
151 <span class="o">};</span> |
|
152 |
|
153 <span class="c">/**</span> |
|
154 <span class="c">* The inverse of filter. Executes the supplied function on each item. </span> |
|
155 <span class="c">* Returns a new array containing the items that the supplied</span> |
|
156 <span class="c">* function returned *false* for.</span> |
|
157 <span class="c">* @method Array.reject</span> |
|
158 <span class="c">* @param a {Array} the array to iterate</span> |
|
159 <span class="c">* @param f {Function} the function to execute on each item</span> |
|
160 <span class="c">* @param o Optional context object</span> |
|
161 <span class="c">* @static</span> |
|
162 <span class="c">* @return {Array} The items on which the supplied function</span> |
|
163 <span class="c">* returned false.</span> |
|
164 <span class="c">*/</span> |
|
165 <span class="nx">A</span><span class="o">.</span><span class="nx">reject</span> <span class="o">=</span> <span class="k">function</span><span class="o">(</span><span class="nx">a</span><span class="o">,</span> <span class="nx">f</span><span class="o">,</span> <span class="nx">o</span><span class="o">)</span> <span class="o">{</span> |
|
166 <span class="k">return</span> <span class="nx">A</span><span class="o">.</span><span class="nx">filter</span><span class="o">(</span><span class="nx">a</span><span class="o">,</span> <span class="k">function</span><span class="o">(</span><span class="nx">item</span><span class="o">,</span> <span class="nx">i</span><span class="o">,</span> <span class="nx">a</span><span class="o">)</span> <span class="o">{</span> |
|
167 <span class="k">return</span> <span class="o">!</span><span class="nx">f</span><span class="o">.</span><span class="nx">call</span><span class="o">(</span><span class="nx">o</span><span class="o">,</span> <span class="nx">item</span><span class="o">,</span> <span class="nx">i</span><span class="o">,</span> <span class="nx">a</span><span class="o">);</span> |
|
168 <span class="o">});</span> |
|
169 <span class="o">};</span> |
|
170 |
|
171 <span class="c">/**</span> |
|
172 <span class="c">* Executes the supplied function on each item in the array.</span> |
|
173 <span class="c">* @method Array.every</span> |
|
174 <span class="c">* @param a {Array} the array to iterate</span> |
|
175 <span class="c">* @param f {Function} the function to execute on each item</span> |
|
176 <span class="c">* @param o Optional context object</span> |
|
177 <span class="c">* @static</span> |
|
178 <span class="c">* @return {boolean} true if every item in the array returns true</span> |
|
179 <span class="c">* from the supplied function.</span> |
|
180 <span class="c">*/</span> |
|
181 <span class="nx">A</span><span class="o">.</span><span class="nx">every</span> <span class="o">=</span> <span class="o">(</span><span class="nx">Native</span><span class="o">.</span><span class="nx">every</span><span class="o">)</span> <span class="o">?</span> |
|
182 <span class="k">function</span><span class="o">(</span><span class="nx">a</span><span class="o">,</span> <span class="nx">f</span><span class="o">,</span> <span class="nx">o</span><span class="o">)</span> <span class="o">{</span> |
|
183 <span class="k">return</span> <span class="nx">Native</span><span class="o">.</span><span class="nx">every</span><span class="o">.</span><span class="nx">call</span><span class="o">(</span><span class="nx">a</span><span class="o">,</span><span class="nx">f</span><span class="o">,</span><span class="nx">o</span><span class="o">);</span> |
|
184 <span class="o">}</span> <span class="o">:</span> |
|
185 <span class="k">function</span><span class="o">(</span><span class="nx">a</span><span class="o">,</span> <span class="nx">f</span><span class="o">,</span> <span class="nx">o</span><span class="o">)</span> <span class="o">{</span> |
|
186 <span class="k">var</span> <span class="nx">l</span> <span class="o">=</span> <span class="nx">a</span><span class="o">.</span><span class="nx">length</span><span class="o">;</span> |
|
187 <span class="k">for</span> <span class="o">(</span><span class="k">var</span> <span class="nx">i</span> <span class="o">=</span> <span class="m">0</span><span class="o">;</span> <span class="nx">i</span> <span class="o"><</span> <span class="nx">l</span><span class="o">;</span> <span class="nx">i</span><span class="o">=</span><span class="nx">i</span><span class="o">+</span><span class="m">1</span><span class="o">)</span> <span class="o">{</span> |
|
188 <span class="k">if</span> <span class="o">(!</span><span class="nx">f</span><span class="o">.</span><span class="nx">call</span><span class="o">(</span><span class="nx">o</span><span class="o">,</span> <span class="nx">a</span><span class="o">[</span><span class="nx">i</span><span class="o">],</span> <span class="nx">i</span><span class="o">,</span> <span class="nx">a</span><span class="o">))</span> <span class="o">{</span> |
|
189 <span class="k">return</span> <span class="kc">false</span><span class="o">;</span> |
|
190 <span class="o">}</span> |
|
191 <span class="o">}</span> |
|
192 |
|
193 <span class="k">return</span> <span class="kc">true</span><span class="o">;</span> |
|
194 <span class="o">};</span> |
|
195 |
|
196 <span class="c">/**</span> |
|
197 <span class="c">* Executes the supplied function on each item in the array.</span> |
|
198 <span class="c">* @method Array.map</span> |
|
199 <span class="c">* @param a {Array} the array to iterate</span> |
|
200 <span class="c">* @param f {Function} the function to execute on each item</span> |
|
201 <span class="c">* @param o Optional context object</span> |
|
202 <span class="c">* @static</span> |
|
203 <span class="c">* @return {Array} A new array containing the return value</span> |
|
204 <span class="c">* of the supplied function for each item in the original</span> |
|
205 <span class="c">* array.</span> |
|
206 <span class="c">*/</span> |
|
207 <span class="nx">A</span><span class="o">.</span><span class="nx">map</span> <span class="o">=</span> <span class="o">(</span><span class="nx">Native</span><span class="o">.</span><span class="nx">map</span><span class="o">)</span> <span class="o">?</span> |
|
208 <span class="k">function</span><span class="o">(</span><span class="nx">a</span><span class="o">,</span> <span class="nx">f</span><span class="o">,</span> <span class="nx">o</span><span class="o">)</span> <span class="o">{</span> |
|
209 <span class="k">return</span> <span class="nx">Native</span><span class="o">.</span><span class="nx">map</span><span class="o">.</span><span class="nx">call</span><span class="o">(</span><span class="nx">a</span><span class="o">,</span> <span class="nx">f</span><span class="o">,</span> <span class="nx">o</span><span class="o">);</span> |
|
210 <span class="o">}</span> <span class="o">:</span> |
|
211 <span class="k">function</span><span class="o">(</span><span class="nx">a</span><span class="o">,</span> <span class="nx">f</span><span class="o">,</span> <span class="nx">o</span><span class="o">)</span> <span class="o">{</span> |
|
212 <span class="k">var</span> <span class="nx">results</span> <span class="o">=</span> <span class="o">[];</span> |
|
213 <span class="nx">A</span><span class="o">.</span><span class="nx">each</span><span class="o">(</span><span class="nx">a</span><span class="o">,</span> <span class="k">function</span><span class="o">(</span><span class="nx">item</span><span class="o">,</span> <span class="nx">i</span><span class="o">,</span> <span class="nx">a</span><span class="o">)</span> <span class="o">{</span> |
|
214 <span class="nx">results</span><span class="o">.</span><span class="nx">push</span><span class="o">(</span><span class="nx">f</span><span class="o">.</span><span class="nx">call</span><span class="o">(</span><span class="nx">o</span><span class="o">,</span> <span class="nx">item</span><span class="o">,</span> <span class="nx">i</span><span class="o">,</span> <span class="nx">a</span><span class="o">));</span> |
|
215 <span class="o">});</span> |
|
216 <span class="k">return</span> <span class="nx">results</span><span class="o">;</span> |
|
217 <span class="o">};</span> |
|
218 |
|
219 |
|
220 <span class="c">/**</span> |
|
221 <span class="c">* Executes the supplied function on each item in the array.</span> |
|
222 <span class="c">* Reduce "folds" the array into a single value.</span> |
|
223 <span class="c">* @method Array.reduce</span> |
|
224 <span class="c">* @param a {Array} the array to iterate</span> |
|
225 <span class="c">* @param init The initial value to start from</span> |
|
226 <span class="c">* @param f {Function} the function to execute on each item. It</span> |
|
227 <span class="c">* is responsible for returning the updated value of the</span> |
|
228 <span class="c">* computation.</span> |
|
229 <span class="c">* @param o Optional context object</span> |
|
230 <span class="c">* @static</span> |
|
231 <span class="c">* @return A value that results from iteratively applying the</span> |
|
232 <span class="c">* supplied function to each element in the array.</span> |
|
233 <span class="c">*/</span> |
|
234 <span class="nx">A</span><span class="o">.</span><span class="nx">reduce</span> <span class="o">=</span> <span class="o">(</span><span class="nx">Native</span><span class="o">.</span><span class="nx">reduce</span><span class="o">)</span> <span class="o">?</span> |
|
235 <span class="k">function</span><span class="o">(</span><span class="nx">a</span><span class="o">,</span> <span class="nx">init</span><span class="o">,</span> <span class="nx">f</span><span class="o">,</span> <span class="nx">o</span><span class="o">)</span> <span class="o">{</span> |
|
236 <span class="c">//Firefox's Array.reduce does not allow inclusion of a</span> |
|
237 <span class="c"></span> <span class="c">// thisObject, so we need to implement it manually</span> |
|
238 <span class="c"></span> <span class="k">return</span> <span class="nx">Native</span><span class="o">.</span><span class="nx">reduce</span><span class="o">.</span><span class="nx">call</span><span class="o">(</span><span class="nx">a</span><span class="o">,</span> <span class="k">function</span><span class="o">(</span><span class="nx">init</span><span class="o">,</span> <span class="nx">item</span><span class="o">,</span> <span class="nx">i</span><span class="o">,</span> <span class="nx">a</span><span class="o">)</span> <span class="o">{</span> |
|
239 <span class="k">return</span> <span class="nx">f</span><span class="o">.</span><span class="nx">call</span><span class="o">(</span><span class="nx">o</span><span class="o">,</span> <span class="nx">init</span><span class="o">,</span> <span class="nx">item</span><span class="o">,</span> <span class="nx">i</span><span class="o">,</span> <span class="nx">a</span><span class="o">);</span> |
|
240 <span class="o">},</span> <span class="nx">init</span><span class="o">);</span> |
|
241 <span class="o">}</span> <span class="o">:</span> |
|
242 <span class="k">function</span><span class="o">(</span><span class="nx">a</span><span class="o">,</span> <span class="nx">init</span><span class="o">,</span> <span class="nx">f</span><span class="o">,</span> <span class="nx">o</span><span class="o">)</span> <span class="o">{</span> |
|
243 <span class="k">var</span> <span class="nx">r</span> <span class="o">=</span> <span class="nx">init</span><span class="o">;</span> |
|
244 <span class="nx">A</span><span class="o">.</span><span class="nx">each</span><span class="o">(</span><span class="nx">a</span><span class="o">,</span> <span class="k">function</span> <span class="o">(</span><span class="nx">item</span><span class="o">,</span> <span class="nx">i</span><span class="o">,</span> <span class="nx">a</span><span class="o">)</span> <span class="o">{</span> |
|
245 <span class="nx">r</span> <span class="o">=</span> <span class="nx">f</span><span class="o">.</span><span class="nx">call</span><span class="o">(</span><span class="nx">o</span><span class="o">,</span> <span class="nx">r</span><span class="o">,</span> <span class="nx">item</span><span class="o">,</span> <span class="nx">i</span><span class="o">,</span> <span class="nx">a</span><span class="o">);</span> |
|
246 <span class="o">});</span> |
|
247 <span class="k">return</span> <span class="nx">r</span><span class="o">;</span> |
|
248 <span class="o">};</span> |
|
249 |
|
250 |
|
251 <span class="c">/**</span> |
|
252 <span class="c">* Executes the supplied function on each item in the array,</span> |
|
253 <span class="c">* searching for the first item that matches the supplied</span> |
|
254 <span class="c">* function.</span> |
|
255 <span class="c">* @method Array.find</span> |
|
256 <span class="c">* @param a {Array} the array to search</span> |
|
257 <span class="c">* @param f {Function} the function to execute on each item. </span> |
|
258 <span class="c">* Iteration is stopped as soon as this function returns true</span> |
|
259 <span class="c">* on an item.</span> |
|
260 <span class="c">* @param o Optional context object</span> |
|
261 <span class="c">* @static</span> |
|
262 <span class="c">* @return {object} the first item that the supplied function</span> |
|
263 <span class="c">* returns true for, or null if it never returns true</span> |
|
264 <span class="c">*/</span> |
|
265 <span class="nx">A</span><span class="o">.</span><span class="nx">find</span> <span class="o">=</span> <span class="k">function</span><span class="o">(</span><span class="nx">a</span><span class="o">,</span> <span class="nx">f</span><span class="o">,</span> <span class="nx">o</span><span class="o">)</span> <span class="o">{</span> |
|
266 <span class="k">var</span> <span class="nx">l</span> <span class="o">=</span> <span class="nx">a</span><span class="o">.</span><span class="nx">length</span><span class="o">;</span> |
|
267 <span class="k">for</span><span class="o">(</span><span class="k">var</span> <span class="nx">i</span><span class="o">=</span><span class="m">0</span><span class="o">;</span> <span class="nx">i</span> <span class="o"><</span> <span class="nx">l</span><span class="o">;</span> <span class="nx">i</span><span class="o">++)</span> <span class="o">{</span> |
|
268 <span class="k">if</span> <span class="o">(</span><span class="nx">f</span><span class="o">.</span><span class="nx">call</span><span class="o">(</span><span class="nx">o</span><span class="o">,</span> <span class="nx">a</span><span class="o">[</span><span class="nx">i</span><span class="o">],</span> <span class="nx">i</span><span class="o">,</span> <span class="nx">a</span><span class="o">))</span> <span class="o">{</span> |
|
269 <span class="k">return</span> <span class="nx">a</span><span class="o">[</span><span class="nx">i</span><span class="o">];</span> |
|
270 <span class="o">}</span> |
|
271 <span class="o">}</span> |
|
272 <span class="k">return</span> <span class="kc">null</span><span class="o">;</span> |
|
273 <span class="o">};</span> |
|
274 |
|
275 <span class="c">/**</span> |
|
276 <span class="c">* Iterates over an array, returning a new array of all the elements</span> |
|
277 <span class="c">* that match the supplied regular expression</span> |
|
278 <span class="c">* @method Array.grep</span> |
|
279 <span class="c">* @param a {Array} a collection to iterate over</span> |
|
280 <span class="c">* @param pattern {RegExp} The regular expression to test against </span> |
|
281 <span class="c">* each item</span> |
|
282 <span class="c">* @static</span> |
|
283 <span class="c">* @return {Array} All the items in the collection that </span> |
|
284 <span class="c">* produce a match against the supplied regular expression. </span> |
|
285 <span class="c">* If no items match, an empty array is returned.</span> |
|
286 <span class="c">*/</span> |
|
287 <span class="nx">A</span><span class="o">.</span><span class="nx">grep</span> <span class="o">=</span> <span class="k">function</span> <span class="o">(</span><span class="nx">a</span><span class="o">,</span> <span class="nx">pattern</span><span class="o">)</span> <span class="o">{</span> |
|
288 <span class="k">return</span> <span class="nx">A</span><span class="o">.</span><span class="nx">filter</span><span class="o">(</span><span class="nx">a</span><span class="o">,</span> <span class="k">function</span> <span class="o">(</span><span class="nx">item</span><span class="o">,</span> <span class="nx">index</span><span class="o">)</span> <span class="o">{</span> |
|
289 <span class="k">return</span> <span class="nx">pattern</span><span class="o">.</span><span class="nx">test</span><span class="o">(</span><span class="nx">item</span><span class="o">);</span> |
|
290 <span class="o">});</span> |
|
291 <span class="o">};</span> |
|
292 |
|
293 |
|
294 <span class="c">/**</span> |
|
295 <span class="c">* Partitions an array into two new arrays, one with the items</span> |
|
296 <span class="c">* that match the supplied function, and one with the items that</span> |
|
297 <span class="c">* do not.</span> |
|
298 <span class="c">* @method Array.partition</span> |
|
299 <span class="c">* @param a {Array} a collection to iterate over</span> |
|
300 <span class="c">* @paran f {Function} a function that will receive each item </span> |
|
301 <span class="c">* in the collection and its index.</span> |
|
302 <span class="c">* @param o Optional execution context of f.</span> |
|
303 <span class="c">* @static</span> |
|
304 <span class="c">* @return An object with two members, 'matches' and 'rejects',</span> |
|
305 <span class="c">* that are arrays containing the items that were selected or </span> |
|
306 <span class="c">* rejected by the test function (or an empty array).</span> |
|
307 <span class="c">*/</span> |
|
308 <span class="nx">A</span><span class="o">.</span><span class="nx">partition</span> <span class="o">=</span> <span class="k">function</span> <span class="o">(</span><span class="nx">a</span><span class="o">,</span> <span class="nx">f</span><span class="o">,</span> <span class="nx">o</span><span class="o">)</span> <span class="o">{</span> |
|
309 <span class="k">var</span> <span class="nx">results</span> <span class="o">=</span> <span class="o">{</span><span class="nx">matches</span><span class="o">:</span> <span class="o">[],</span> <span class="nx">rejects</span><span class="o">:</span> <span class="o">[]};</span> |
|
310 <span class="nx">A</span><span class="o">.</span><span class="nx">each</span><span class="o">(</span><span class="nx">a</span><span class="o">,</span> <span class="k">function</span> <span class="o">(</span><span class="nx">item</span><span class="o">,</span> <span class="nx">index</span><span class="o">)</span> <span class="o">{</span> |
|
311 <span class="k">var</span> <span class="nx">set</span> <span class="o">=</span> <span class="nx">f</span><span class="o">.</span><span class="nx">call</span><span class="o">(</span><span class="nx">o</span><span class="o">,</span> <span class="nx">item</span><span class="o">,</span> <span class="nx">index</span><span class="o">,</span> <span class="nx">a</span><span class="o">)</span> <span class="o">?</span> <span class="nx">results</span><span class="o">.</span><span class="nx">matches</span> <span class="o">:</span> <span class="nx">results</span><span class="o">.</span><span class="nx">rejects</span><span class="o">;</span> |
|
312 <span class="nx">set</span><span class="o">.</span><span class="nx">push</span><span class="o">(</span><span class="nx">item</span><span class="o">);</span> |
|
313 <span class="o">});</span> |
|
314 <span class="k">return</span> <span class="nx">results</span><span class="o">;</span> |
|
315 <span class="o">};</span> |
|
316 |
|
317 <span class="c">/**</span> |
|
318 <span class="c">* Creates an array of arrays by pairing the corresponding</span> |
|
319 <span class="c">* elements of two arrays together into a new array.</span> |
|
320 <span class="c">* @method Array.zip</span> |
|
321 <span class="c">* @param a {Array} a collection to iterate over</span> |
|
322 <span class="c">* @param a2 {Array} another collection whose members will be </span> |
|
323 <span class="c">* paired with members of the first parameter</span> |
|
324 <span class="c">* @static</span> |
|
325 <span class="c">* @return An array of arrays formed by pairing each element </span> |
|
326 <span class="c">* of the first collection with an item in the second collection </span> |
|
327 <span class="c">* having the corresponding index.</span> |
|
328 <span class="c">*/</span> |
|
329 <span class="nx">A</span><span class="o">.</span><span class="nx">zip</span> <span class="o">=</span> <span class="k">function</span> <span class="o">(</span><span class="nx">a</span><span class="o">,</span> <span class="nx">a2</span><span class="o">)</span> <span class="o">{</span> |
|
330 <span class="k">var</span> <span class="nx">results</span> <span class="o">=</span> <span class="o">[];</span> |
|
331 <span class="nx">A</span><span class="o">.</span><span class="nx">each</span><span class="o">(</span><span class="nx">a</span><span class="o">,</span> <span class="k">function</span> <span class="o">(</span><span class="nx">item</span><span class="o">,</span> <span class="nx">index</span><span class="o">)</span> <span class="o">{</span> |
|
332 <span class="nx">results</span><span class="o">.</span><span class="nx">push</span><span class="o">([</span><span class="nx">item</span><span class="o">,</span> <span class="nx">a2</span><span class="o">[</span><span class="nx">index</span><span class="o">]]);</span> |
|
333 <span class="o">});</span> |
|
334 <span class="k">return</span> <span class="nx">results</span><span class="o">;</span> |
|
335 <span class="o">};</span> |
|
336 </pre></div> |
|
337 </div> |
|
338 </div> |
|
339 </div> |
|
340 <div class="yui-b"> |
|
341 <div class="nav"> |
|
342 |
|
343 <div id="moduleList" class="module"> |
|
344 <h4>Modules</h4> |
|
345 <ul class="content"> |
|
346 <li class=""><a href="module_anim.html" title="anim">anim</a></li> |
|
347 <li class=""><a href="module_attribute.html" title="attribute">attribute</a></li> |
|
348 <li class=""><a href="module_base.html" title="base">base</a></li> |
|
349 <li class=""><a href="module_cache.html" title="cache">cache</a></li> |
|
350 <li class=""><a href="module_classnamemanager.html" title="classnamemanager">classnamemanager</a></li> |
|
351 <li class="selected"><a href="module_collection.html" title="collection">collection</a></li> |
|
352 <li class=""><a href="module_console.html" title="console">console</a></li> |
|
353 <li class=""><a href="module_console-filters.html" title="console-filters">console-filters</a></li> |
|
354 <li class=""><a href="module_cookie.html" title="cookie">cookie</a></li> |
|
355 <li class=""><a href="module_dataschema.html" title="dataschema">dataschema</a></li> |
|
356 <li class=""><a href="module_datasource.html" title="datasource">datasource</a></li> |
|
357 <li class=""><a href="module_datatype.html" title="datatype">datatype</a></li> |
|
358 <li class=""><a href="module_dd.html" title="dd">dd</a></li> |
|
359 <li class=""><a href="module_dom.html" title="dom">dom</a></li> |
|
360 <li class=""><a href="module_dump.html" title="dump">dump</a></li> |
|
361 <li class=""><a href="module_event.html" title="event">event</a></li> |
|
362 <li class=""><a href="module_event-custom.html" title="event-custom">event-custom</a></li> |
|
363 <li class=""><a href="module_event-simulate.html" title="event-simulate">event-simulate</a></li> |
|
364 <li class=""><a href="module_history.html" title="history">history</a></li> |
|
365 <li class=""><a href="module_imageloader.html" title="imageloader">imageloader</a></li> |
|
366 <li class=""><a href="module_io.html" title="io">io</a></li> |
|
367 <li class=""><a href="module_json.html" title="json">json</a></li> |
|
368 <li class=""><a href="module_node.html" title="node">node</a></li> |
|
369 <li class=""><a href="module_node-focusmanager.html" title="node-focusmanager">node-focusmanager</a></li> |
|
370 <li class=""><a href="module_node-menunav.html" title="node-menunav">node-menunav</a></li> |
|
371 <li class=""><a href="module_oop.html" title="oop">oop</a></li> |
|
372 <li class=""><a href="module_overlay.html" title="overlay">overlay</a></li> |
|
373 <li class=""><a href="module_plugin.html" title="plugin">plugin</a></li> |
|
374 <li class=""><a href="module_profiler.html" title="profiler">profiler</a></li> |
|
375 <li class=""><a href="module_queue.html" title="queue">queue</a></li> |
|
376 <li class=""><a href="module_slider.html" title="slider">slider</a></li> |
|
377 <li class=""><a href="module_stylesheet.html" title="stylesheet">stylesheet</a></li> |
|
378 <li class=""><a href="module_substitute.html" title="substitute">substitute</a></li> |
|
379 <li class=""><a href="module_test.html" title="test">test</a></li> |
|
380 <li class=""><a href="module_widget.html" title="widget">widget</a></li> |
|
381 <li class=""><a href="module_widget-position.html" title="widget-position">widget-position</a></li> |
|
382 <li class=""><a href="module_widget-position-ext.html" title="widget-position-ext">widget-position-ext</a></li> |
|
383 <li class=""><a href="module_widget-stack.html" title="widget-stack">widget-stack</a></li> |
|
384 <li class=""><a href="module_widget-stdmod.html" title="widget-stdmod">widget-stdmod</a></li> |
|
385 <li class=""><a href="module_yui.html" title="yui">yui</a></li> |
|
386 </ul> |
|
387 </div> |
|
388 |
|
389 <div id="classList" class="module"> |
|
390 <h4>Classes</h4> |
|
391 <ul class="content"> |
|
392 <li class=""><a href="YUI~array~extras.html" title="YUI~array~extras">YUI~array~extras</a></li> |
|
393 </ul> |
|
394 </div> |
|
395 |
|
396 <div id="fileList" class="module"> |
|
397 <h4>Files</h4> |
|
398 <ul class="content"> |
|
399 <li class="selected"><a href="array-extras.js.html" title="array-extras.js">array-extras.js</a></li> |
|
400 </ul> |
|
401 </div> |
|
402 |
|
403 |
|
404 |
|
405 |
|
406 |
|
407 </div> |
|
408 </div> |
|
409 </div> |
|
410 <div id="ft"> |
|
411 <hr /> |
|
412 Copyright © 2009 Yahoo! Inc. All rights reserved. |
|
413 </div> |
|
414 </div> |
|
415 <script type="text/javascript"> |
|
416 ALL_YUI_PROPS = [{"access": "", "host": "YUI~array~extras", "name": "Array.every", "url": "YUI~array~extras.html#method_Array.every", "type": "method"}, {"access": "", "host": "YUI~array~extras", "name": "Array.filter", "url": "YUI~array~extras.html#method_Array.filter", "type": "method"}, {"access": "", "host": "YUI~array~extras", "name": "Array.find", "url": "YUI~array~extras.html#method_Array.find", "type": "method"}, {"access": "", "host": "YUI~array~extras", "name": "Array.grep", "url": "YUI~array~extras.html#method_Array.grep", "type": "method"}, {"access": "", "host": "YUI~array~extras", "name": "Array.map", "url": "YUI~array~extras.html#method_Array.map", "type": "method"}, {"access": "", "host": "YUI~array~extras", "name": "Array.partition", "url": "YUI~array~extras.html#method_Array.partition", "type": "method"}, {"access": "", "host": "YUI~array~extras", "name": "Array.reduce", "url": "YUI~array~extras.html#method_Array.reduce", "type": "method"}, {"access": "", "host": "YUI~array~extras", "name": "Array.reject", "url": "YUI~array~extras.html#method_Array.reject", "type": "method"}, {"access": "", "host": "YUI~array~extras", "name": "Array.unique", "url": "YUI~array~extras.html#method_Array.unique", "type": "method"}, {"access": "", "host": "YUI~array~extras", "name": "Array.zip", "url": "YUI~array~extras.html#method_Array.zip", "type": "method"}, {"access": "", "host": "YUI~array~extras", "name": "lastIndexOf", "url": "YUI~array~extras.html#property_lastIndexOf", "type": "property"}]; |
|
417 </script> |
|
418 </body> |
|
419 </html> |