Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
Regenerated docs
- Loading branch information
Showing
80 changed files
with
32,678 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,314 @@ | ||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" | ||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> | ||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> | ||
<head> | ||
<meta name="Content-Type" content="text/html; charset=utf-8" /> | ||
<title>Class: Array</title> | ||
<link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" /> | ||
<link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" /> | ||
<link rel="stylesheet" href="css/custom.css" type="text/css" media="screen" charset="utf-8" /> | ||
|
||
<script type="text/javascript" charset="utf-8"> | ||
relpath = ''; | ||
if (relpath != '') relpath += '/'; | ||
</script> | ||
<base id="base_target" target="_top" /> | ||
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script> | ||
<script type="text/javascript" charset="utf-8" src="js/autocomplete.js"></script> | ||
<script type="text/javascript" charset="utf-8" src="js/app.js"></script> | ||
<script type="text/javascript" charset="utf-8" src="js/live.js"></script> | ||
|
||
</head> | ||
<body> | ||
<script type="text/javascript" charset="utf-8"> | ||
if (window.top.frames.main) document.body.className = 'frames'; | ||
</script> | ||
|
||
<div id="header"> | ||
<div id="menu"> | ||
|
||
|
||
<a href="object_index.html" target="_self" title="Index (A)">Index (A)</a> | ||
» | ||
|
||
|
||
<span class="title">Array</span> | ||
|
||
|
||
<div class="noframes"> | ||
<span class="title"></span> | ||
<a id="frames_link" class="link_disabled">Frames</a> | | ||
<a target="_top" id="noframes_link" class="link_disabled">No Frames</a> | ||
<span class="title"></span> | ||
</div> | ||
</div> | ||
|
||
<div id="search2"> | ||
|
||
|
||
<div class="search2_center"> | ||
<form class="search2" onsubmit="return false;" action=""> | ||
<input name="q" type="search" placeholder="Search" id="search_box2" size="30" value="" /> | ||
</form> | ||
</div> | ||
<script type="text/javascript" charset="utf-8"> | ||
$('#search_box2').focus(function(){ | ||
var search_index = relpath + 'search_index.json'; | ||
jQuery.getJSON(search_index, go_data); | ||
|
||
function go_data(adata) { | ||
$('#search_box2').autocomplete(adata, { | ||
width: 300, | ||
matchContains: true, | ||
formatItem: function(item) { | ||
return item.text; | ||
} | ||
}).result(function(event, item) { | ||
if (window.location.search) { | ||
window.location.href = relpath + $(item.href_tag).attr("href"); | ||
} else { | ||
location.href = relpath + $(item.href_tag).attr("href"); | ||
} | ||
}); | ||
} | ||
}); | ||
</script> | ||
</div> | ||
|
||
<div class="clear"></div> | ||
</div> | ||
|
||
<iframe id="search_frame"></iframe> | ||
|
||
<div id="content"><h1>Class: Array | ||
|
||
|
||
</h1> | ||
|
||
<div id="info_box"> | ||
<dl class="box"> | ||
|
||
|
||
|
||
|
||
|
||
|
||
<dt class="r1 last">Defined in:</dt> | ||
<dd class="r1 last"> | ||
|
||
lib/plist4r/mixin/ruby_stdlib.rb | ||
|
||
|
||
</dd> | ||
</dl> | ||
</div> | ||
<div class="clear"></div> | ||
|
||
|
||
<h3 class="inherited">Instance Methods</h3> | ||
<ul id="methods_ribbon"> | ||
|
||
|
||
<li class="r1"><a href="#multidim%3F-instance_method" target="_self" title="Array#multidim? (method)">multidim?</a></li> | ||
|
||
|
||
<li class="r2"><a href="#to_ranges-instance_method" target="_self" title="Array#to_ranges (method)">to_ranges</a></li> | ||
|
||
|
||
</ul> | ||
|
||
|
||
|
||
|
||
|
||
<div id="instance_method_details" class="method_details_list"> | ||
<h2>Instance Method Details</h2> | ||
|
||
|
||
<div class="method_details first" id="multidim?-instance_method"> | ||
<p class="signature first""> | ||
|
||
- (<tt>true</tt>, <tt>false</tt>) <strong>multidim?</strong> | ||
|
||
|
||
|
||
</p><div class="docstring"> | ||
<div class="discussion"> | ||
<p> | ||
And array is considered multi-dimensional if all of the first-order | ||
elements are also arrays. | ||
</p> | ||
|
||
|
||
</div> | ||
</div> | ||
<div class="tags"> | ||
|
||
<div class="examples"> | ||
<h3>Examples:</h3> | ||
|
||
<h4><div class='inline'></div></h4> | ||
<pre class="example code"><span class='lbrack token'>[</span><span class='lbrack token'>[</span><span class='integer val'>1</span><span class='rbrack token'>]</span><span class='comma token'>,</span><span class='lbrack token'>[</span><span class='integer val'>2</span><span class='rbrack token'>]</span><span class='comma token'>,</span><span class='lbrack token'>[</span><span class='integer val'>3</span><span class='rbrack token'>]</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='multidim? fid id'>multidim?</span> | ||
<span class='assign token'>=</span><span class='gt op'>></span> <span class='true true kw'>true</span> | ||
|
||
<span class='lbrack token'>[</span><span class='lbrack token'>[</span><span class='integer val'>1</span><span class='rbrack token'>]</span><span class='comma token'>,</span><span class='integer val'>2</span><span class='comma token'>,</span><span class='lbrack token'>[</span><span class='integer val'>3</span><span class='rbrack token'>]</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='multidim? fid id'>multidim?</span> | ||
<span class='assign token'>=</span><span class='gt op'>></span> <span class='false false kw'>false</span> | ||
</pre> | ||
|
||
</div> | ||
<h3>Returns:</h3> | ||
<ul class="return"> | ||
|
||
<li> | ||
|
||
<span class='type'>(<tt>true</tt>, <tt>false</tt>)</span> | ||
|
||
|
||
|
||
|
||
— | ||
<div class='inline'><p> | ||
true for a Multi-Dimensional array, false otherwise | ||
</p> | ||
</div> | ||
|
||
</li> | ||
|
||
</ul> | ||
|
||
</div><table class="source_code"> | ||
<tr> | ||
<td> | ||
<pre class="lines"> | ||
|
||
|
||
36 | ||
37 | ||
38 | ||
39 | ||
40 | ||
41 | ||
42 | ||
43 | ||
44 | ||
45 | ||
46</pre> | ||
</td> | ||
<td> | ||
<pre class="code"><span class="info file"># File 'lib/plist4r/mixin/ruby_stdlib.rb', line 36</span> | ||
|
||
<span class='def def kw'>def</span> <span class='multidim? fid id'>multidim?</span> | ||
<span class='case case kw'>case</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='size identifier id'>size</span> | ||
<span class='when when kw'>when</span> <span class='integer val'>0</span> | ||
<span class='false false kw'>false</span> | ||
<span class='else else kw'>else</span> | ||
<span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='e identifier id'>e</span><span class='bitor op'>|</span> | ||
<span class='return return kw'>return</span> <span class='false false kw'>false</span> <span class='unless unless_mod kw'>unless</span> <span class='e identifier id'>e</span><span class='dot token'>.</span><span class='class identifier id'>class</span> <span class='eq op'>==</span> <span class='Array constant id'>Array</span> | ||
<span class='end end kw'>end</span> | ||
<span class='true true kw'>true</span> | ||
<span class='end end kw'>end</span> | ||
<span class='end end kw'>end</span> | ||
</pre> | ||
</td> | ||
</tr> | ||
</table> | ||
</div> | ||
|
||
|
||
<div class="method_details " id="to_ranges-instance_method"> | ||
<p class="signature ""> | ||
|
||
- (<tt><a href="Object.html" target="_self" title="Object (class)">Object</a></tt>) <strong>to_ranges</strong> | ||
|
||
|
||
|
||
</p><div class="docstring"> | ||
<div class="discussion"> | ||
<p> | ||
Converts an array of values (which must respond to #succ) to an array of | ||
ranges. For example, | ||
</p> | ||
|
||
|
||
</div> | ||
</div> | ||
<div class="tags"> | ||
|
||
<div class="examples"> | ||
<h3>Examples:</h3> | ||
|
||
<h4><div class='inline'></div></h4> | ||
<pre class="example code"><span class='lbrack token'>[</span><span class='integer val'>3</span><span class='comma token'>,</span><span class='integer val'>4</span><span class='comma token'>,</span><span class='integer val'>5</span><span class='comma token'>,</span><span class='integer val'>1</span><span class='comma token'>,</span><span class='integer val'>6</span><span class='comma token'>,</span><span class='integer val'>9</span><span class='comma token'>,</span><span class='integer val'>8</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='to_ranges identifier id'>to_ranges</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='integer val'>1</span><span class='comma token'>,</span><span class='float val'>3</span><span class='dot2 op'>..</span><span class='integer val'>6</span><span class='comma token'>,</span><span class='float val'>8</span><span class='dot2 op'>..</span><span class='integer val'>9</span><span class='rbrack token'>]</span> | ||
</pre> | ||
|
||
</div> | ||
|
||
</div><table class="source_code"> | ||
<tr> | ||
<td> | ||
<pre class="lines"> | ||
|
||
|
||
51 | ||
52 | ||
53 | ||
54 | ||
55 | ||
56 | ||
57 | ||
58 | ||
59 | ||
60 | ||
61 | ||
62 | ||
63 | ||
64 | ||
65 | ||
66 | ||
67 | ||
68 | ||
69</pre> | ||
</td> | ||
<td> | ||
<pre class="code"><span class="info file"># File 'lib/plist4r/mixin/ruby_stdlib.rb', line 51</span> | ||
|
||
<span class='def def kw'>def</span> <span class='to_ranges identifier id'>to_ranges</span> | ||
<span class='array identifier id'>array</span> <span class='assign token'>=</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='compact identifier id'>compact</span><span class='dot token'>.</span><span class='uniq identifier id'>uniq</span><span class='dot token'>.</span><span class='sort identifier id'>sort</span> | ||
<span class='ranges identifier id'>ranges</span> <span class='assign token'>=</span> <span class='lbrack token'>[</span><span class='rbrack token'>]</span> | ||
<span class='if if kw'>if</span> <span class='notop op'>!</span><span class='array identifier id'>array</span><span class='dot token'>.</span><span class='empty? fid id'>empty?</span> | ||
<span class='comment val'># Initialize the left and right endpoints of the range</span> | ||
<span class='left identifier id'>left</span><span class='comma token'>,</span> <span class='right identifier id'>right</span> <span class='assign token'>=</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='first identifier id'>first</span><span class='comma token'>,</span> <span class='nil nil kw'>nil</span> | ||
<span class='array identifier id'>array</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='obj identifier id'>obj</span><span class='bitor op'>|</span> | ||
<span class='comment val'># If the right endpoint is set and obj is not equal to right's successor </span> | ||
<span class='comment val'># then we need to create a range.</span> | ||
<span class='if if kw'>if</span> <span class='right identifier id'>right</span> <span class='andop op'>&&</span> <span class='obj identifier id'>obj</span> <span class='neq op'>!=</span> <span class='right identifier id'>right</span><span class='dot token'>.</span><span class='succ identifier id'>succ</span> | ||
<span class='ranges identifier id'>ranges</span> <span class='lshft op'><<</span> <span class='Range constant id'>Range</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='left identifier id'>left</span><span class='comma token'>,</span><span class='right identifier id'>right</span><span class='rparen token'>)</span> | ||
<span class='left identifier id'>left</span> <span class='assign token'>=</span> <span class='obj identifier id'>obj</span> | ||
<span class='end end kw'>end</span> | ||
<span class='right identifier id'>right</span> <span class='assign token'>=</span> <span class='obj identifier id'>obj</span> | ||
<span class='end end kw'>end</span> | ||
<span class='ranges identifier id'>ranges</span> <span class='lshft op'><<</span> <span class='Range constant id'>Range</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='left identifier id'>left</span><span class='comma token'>,</span><span class='right identifier id'>right</span><span class='rparen token'>)</span> | ||
<span class='end end kw'>end</span> | ||
<span class='ranges identifier id'>ranges</span> | ||
<span class='end end kw'>end</span> | ||
</pre> | ||
</td> | ||
</tr> | ||
</table> | ||
</div> | ||
|
||
|
||
</div> | ||
|
||
</div> | ||
|
||
<div id="footer"> | ||
Generated on Sat May 29 12:47:30 2010 by | ||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool">yard</a> | ||
0.5.4 and the | ||
<a href="http://github.com/dreamcat4/yard-slipstream">yard-slipstream</a> plugin | ||
(ruby-1.8.7). | ||
</div> | ||
|
||
</body> | ||
</html> |
Oops, something went wrong.