1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217
|
<html><title>Programming Ruby: The Pragmatic Programmer's Guide</title><head><meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"><STYLE TYPE="text/css"><!--
BODY { margin-left: 1in;
width: 6in;
font-family: helvetica, arial, sans-serif;
}
H1 { color: #000080;
font-family: helvetica, arial, sans-serif;
font-size: 22pt;
margin-left: 0in
}
H2 { color: #000080; font: bold x-large helvetica, sans-serif;
margin-left: 0in }
H3 { color: #000080; font: bold large helvetica, sans-serif; }
H4 { color: #000080; font: italic large helvetica, sans-serif; }
.ruby { background: #fff0f0 }
.header { color: white }
.subheader { color: #ffdddd }
.sidebar { width: 6in }
span.sans { font-family: helvetica, arial, sans-serif }
-->
</STYLE><table bgcolor="#a03030" cellpadding="3" border="0" cellspacing="0"><tr><td colspan="3"><table bgcolor="#902020" cellpadding="20"><tr><td><h1 class="header">Programming Ruby</h1><h3 class="subheader">The Pragmatic Programmer's Guide</h3></td></tr></table></td></tr><tr><td width="33%" align="left"><a class="subheader" href="ref_c_object.html">Previous <</a></td><td width="33%" align="center" valign="middle"><a class="subheader" href="builtins.html">Contents ^</a><br></td><td width="33%" align="right"><a class="subheader" href="ref_c_range.html">Next ></a><br></td></tr></table></head><body bgcolor="white">
<!--
Copyright (c) 2001 by Addison Wesley Longman. This
material may be distributed only subject to the terms and
conditions set forth in the Open Publication License, v1.0 or
later (the latest version is presently available at
http://www.opencontent.org/openpub/).
-->
<table><tr><td height="20"><img src="dot.gif" width="1" height="20"></td></tr></table><table border="0" width="100%" bgcolor="660066" cellpadding="10"><tr><td valign="center"><font color="white" size="7">class Proc</font></td><td><table border="0"><tr><td><font color="white">
Parent:
</font></td><td><font color="white">Object</font></td></tr><tr><td><font color="white">
Version:
</font></td><td><font color="white">
1.6
</font></td></tr></table></td></tr></table><p></p><H3>Index:</H3><a href="#new">new</a> <a href="#_ob_cb"><i>[ ]</i></a> <a href="#arity"><i>arity</i></a> <a href="#call"><i>call</i></a> <p></p><hr>
<P></P>
<code>Proc</code> objects are blocks of code that have been bound to a set
of local variables. Once bound, the code may be called in different
contexts and still access those variables.
<P></P>
<table bgcolor="#fff0f0" cellspacing="0" border="0" cellpadding="3" width="500">
<tr>
<td colspan="3" valign="top"><code>def genTimes(factor)</code></td>
</tr>
<tr>
<td colspan="3" valign="top"><code> return Proc.new {|n| n*factor }</code></td>
</tr>
<tr>
<td colspan="3" valign="top"><code>end</code></td>
</tr>
<tr>
<td colspan="3" valign="top"><code></code></td>
</tr>
<tr>
<td colspan="3" valign="top"><code>times3 = genTimes(3)</code></td>
</tr>
<tr>
<td colspan="3" valign="top"><code>times5 = genTimes(5)</code></td>
</tr>
<tr>
<td colspan="3" valign="top"><code></code></td>
</tr>
<tr>
<td valign="top"><code>times3.call(12)</code></td>
<td valign="top"></td>
<td valign="top"><code>36</code></td>
</tr>
<tr>
<td valign="top"><code>times5.call(5)</code></td>
<td valign="top"></td>
<td valign="top"><code>25</code></td>
</tr>
<tr>
<td valign="top"><code>times3.call(times5.call(4))</code></td>
<td valign="top"></td>
<td valign="top"><code>60</code></td>
</tr>
</table>
<P></P>
<P></P>
<table border="0" width="100%" cellpadding="10"><tr><td valign="center" colspan="2" bgcolor="990066"><font color="white" size="6">class methods
</font></td></tr><tr><td valign="center" bgcolor="#ff9999"><font size="4"><a name="new"><b>new</b></a></font></td><td bgcolor="#ffaaaa">
Proc.new <i>[</i>{| | block }
<i>]</i>
-> <i>aProc</i>
</td></tr><td></td><td>
<P></P>
Creates a new <code>Proc</code> object, bound to the current context. It
may be called without a block only within a method with an
attached block, in which case that block is converted to the
<code>Proc</code> object.
<P></P>
<table bgcolor="#fff0f0" cellspacing="0" border="0" cellpadding="3" width="500">
<tr>
<td colspan="3" valign="top"><code>def procFrom</code></td>
</tr>
<tr>
<td colspan="3" valign="top"><code> Proc.new</code></td>
</tr>
<tr>
<td colspan="3" valign="top"><code>end</code></td>
</tr>
<tr>
<td colspan="3" valign="top"><code>aProc = procFrom { "hello" }</code></td>
</tr>
<tr>
<td valign="top"><code>aProc.call</code></td>
<td valign="top"></td>
<td valign="top"><code>"hello"</code></td>
</tr>
</table>
<P></P>
<P></P>
</td></table>
<P></P>
<table border="0" width="100%" cellpadding="10"><tr><td valign="center" colspan="2" bgcolor="990066"><font color="white" size="6">instance methods
</font></td></tr><tr><td valign="center" bgcolor="#ff9999"><font size="4"><a name="_ob_cb"><b>[ ]</b></a></font></td><td bgcolor="#ffaaaa">
<i>prc</i>[ <i>[</i><i>params</i><i>]<sup>*</sup></i> ]
-> <i>anObject</i>
</td></tr><td></td><td>
<P></P>
Synonym for <code>Proc.call</code>.
<P></P>
</td><tr><td valign="center" bgcolor="#ff9999"><font size="4"><a name="arity"><b>arity</b></a></font></td><td bgcolor="#ffaaaa">
<i>prc</i>.arity -> <i>anInteger</i>
</td></tr><td></td><td>
<P></P>
Returns the number of arguments required by the block. If the
block takes no arguments, returns -1. If it takes one argument,
returns -2. Otherwise, returns a positive argument count unless
the last argument is prefixed with *, in which case the argument
count is negated. The number of required arguments is
<i>anInteger</i> for positive values, and
<code>(</code><i>anInteger</i><code>+1).abs</code> otherwise.
<P></P>
<table bgcolor="#fff0f0" cellspacing="0" border="0" cellpadding="3" width="500">
<tr>
<td valign="top"><code>Proc.new {||}.arity</code></td>
<td valign="top"></td>
<td valign="top"><code>0</code></td>
</tr>
<tr>
<td valign="top"><code>Proc.new {|a|}.arity</code></td>
<td valign="top"></td>
<td valign="top"><code>-1</code></td>
</tr>
<tr>
<td valign="top"><code>Proc.new {|a,b|}.arity</code></td>
<td valign="top"></td>
<td valign="top"><code>2</code></td>
</tr>
<tr>
<td valign="top"><code>Proc.new {|a,b,c|}.arity</code></td>
<td valign="top"></td>
<td valign="top"><code>3</code></td>
</tr>
<tr>
<td valign="top"><code>Proc.new {|*a|}.arity</code></td>
<td valign="top"></td>
<td valign="top"><code>-1</code></td>
</tr>
<tr>
<td valign="top"><code>Proc.new {|a,*b|}.arity</code></td>
<td valign="top"></td>
<td valign="top"><code>-2</code></td>
</tr>
</table>
<P></P>
<P></P>
</td><tr><td valign="center" bgcolor="#ff9999"><font size="4"><a name="call"><b>call</b></a></font></td><td bgcolor="#ffaaaa">
<i>prc</i>.call( <i>[</i><i>params</i><i>]<sup>*</sup></i> )
-> <i>anObject</i>
</td></tr><td></td><td>
<P></P>
Invokes the block, setting the block's parameters to the values
in <i>params</i> using the same rules as used by parallel
assignment. Returns the value of the last expression evaluated
in the block.
<P></P>
<table bgcolor="#fff0f0" cellspacing="0" border="0" cellpadding="3" width="500">
<tr>
<td colspan="3" valign="top"><code>aProc = Proc.new {|a, *b| b.collect {|i| i*a }}</code></td>
</tr>
<tr>
<td valign="top"><code>aProc.call(9, 1, 2, 3)</code></td>
<td valign="top"></td>
<td valign="top"><code>[9, 18, 27]</code></td>
</tr>
<tr>
<td valign="top"><code>aProc[9, 1, 2, 3]</code></td>
<td valign="top"></td>
<td valign="top"><code>[9, 18, 27]</code></td>
</tr>
</table>
<P></P>
<P></P>
</td></table>
<P></P>
<p></p><hr><table bgcolor="#a03030" cellpadding="10" border="0" cellspacing="0"><tr><td width="33%" align="left"><a class="subheader" href="ref_c_object.html">Previous <</a></td><td width="33%" align="center" valign="middle"><a class="subheader" href="builtins.html">Contents ^</a><br></td><td width="33%" align="right"><a class="subheader" href="ref_c_range.html">Next ></a><br></td></tr></table><p></p><font size="-1">Extracted from the book "Programming Ruby -
The Pragmatic Programmer's Guide"</font><br><font size="-3">
Copyright
©
2000 Addison Wesley Longman, Inc. Released under the terms of the
<a href="http://www.opencontent.org/openpub/">Open Publication License</a> V1.0.
<br>
This reference is available for
<a href="http://www.pragmaticprogrammer.com/ruby/downloads/book.html">download</a>.
</font></body></html>
|