[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[sc-dev] SF.net SVN: supercollider:[8295] trunk/build/Help

To: sc-dev@xxxxxxxxxxxxxxxx
Subject: [sc-dev] SF.net SVN: supercollider:[8295] trunk/build/Help
From: jrhb@xxxxxxxxxxxxxxxxxxxxx
Date: Thu, 25 Dec 2008 18:44:45 +0000
List-id: SuperCollider developers mailing list <sc-devel.create.ucsb.edu>
Reply-to: sc-dev@xxxxxxxxxxxxxxxx
Sender: owner-sc-dev@xxxxxxxxxxxxxxxx
Revision: 8295
          http://supercollider.svn.sourceforge.net/supercollider/?rev=8295&view=rev
Author:   jrhb
Date:     2008-12-25 18:44:45 +0000 (Thu, 25 Dec 2008)

Log Message:
-----------
improve helpfiles

Modified Paths:
--------------
    trunk/build/Help/BinaryOps/BinaryOpUGen.html
    trunk/build/Help/UGens/Algebraic/UnaryOpUGen.html

Modified: trunk/build/Help/BinaryOps/BinaryOpUGen.html
===================================================================
--- trunk/build/Help/BinaryOps/BinaryOpUGen.html	2008-12-25 18:23:39 UTC (rev 8294)
+++ trunk/build/Help/BinaryOps/BinaryOpUGen.html	2008-12-25 18:44:45 UTC (rev 8295)
@@ -7,66 +7,80 @@
 <meta name="Generator" content="Cocoa HTML Writer">
 <meta name="CocoaVersion" content="949.43">
 <style type="text/css">
-p.p1 {margin: 0.0px 0.0px 0.0px 0.0px; font: 18.0px Helvetica}
+p.p1 {margin: 0.0px 0.0px 0.0px 0.0px; font: 12.0px Helvetica}
 p.p2 {margin: 0.0px 0.0px 0.0px 0.0px; font: 12.0px Helvetica; min-height: 14.0px}
-p.p3 {margin: 0.0px 0.0px 0.0px 0.0px; font: 12.0px Helvetica}
+p.p3 {margin: 0.0px 0.0px 0.0px 0.0px; font: 12.0px Helvetica; color: #0000ff}
 p.p4 {margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco; color: #000000}
-p.p5 {margin: 0.0px 0.0px 0.0px 0.0px; font: 12.0px Monaco; min-height: 16.0px}
-p.p6 {margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco}
+p.p5 {margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco; min-height: 12.0px}
+p.p6 {margin: 0.0px 0.0px 0.0px 0.0px; font: 12.0px Monaco; min-height: 16.0px}
 p.p7 {margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco; color: #bf0000}
-p.p8 {margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco; min-height: 12.0px}
-span.s1 {color: #0000bf}
-span.s2 {color: #0000ff}
-span.s3 {color: #606060}
-span.s4 {color: #982316}
-span.s5 {color: #000000}
+p.p8 {margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco; color: #000000; min-height: 12.0px}
+p.p9 {margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco; color: #bf0000; min-height: 12.0px}
+p.p10 {margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco}
+span.s1 {font: 18.0px Helvetica}
+span.s2 {color: #000000}
+span.s3 {color: #0000ff}
+span.s4 {color: #0000bf}
+span.s5 {color: #bf0000}
+span.s6 {color: #606060}
+span.s7 {color: #982316}
 span.Apple-tab-span {white-space:pre}
 </style>
 </head>
 <body>
-<p class="p1"><b>BinaryOpUGen</b></p>
+<p class="p1"><span class="s1"><b>BinaryOpUGen<span class="Apple-tab-span">	</span><span class="Apple-tab-span">	</span><span class="Apple-tab-span">	</span></b></span><b>apply a binary operation to the values of an input ugen</b></p>
 <p class="p2"><br></p>
-<p class="p3"><b>superclass: UGen</b></p>
+<p class="p1"><b>superclass: UGen</b></p>
 <p class="p2"><br></p>
-<p class="p3">BinaryOpUGens are created as the result of a binary operator applied to a UGen.<span class="Apple-converted-space"> </span></p>
 <p class="p2"><br></p>
-<p class="p4">(<span class="s1">SinOsc</span>.ar(200) * <span class="s1">ClipNoise</span>.ar).dump;</p>
-<p class="p4">(<span class="s1">SinOsc</span>.ar(200).thresh(0.5)).dump;</p>
+<p class="p3"><span class="s2">see also: <a href="../UGens/Algebraic/UnaryOpUGen.html">UnaryOpUGen</a></span></p>
+<p class="p1">structurally related: <a href="../Core/BinaryOpFunction.html"><span class="s3">BinaryOpFunction</span></a>, <a href="../Streams-Patterns-Events/Pbinop.html"><span class="s3">Pbinop</span></a></p>
+<p class="p2"><br></p>
+<p class="p2"><br></p>
+<p class="p1"><span class="Apple-tab-span">	</span><b>*new(selector, a, b)<span class="Apple-tab-span">	</span><span class="Apple-tab-span">	</span></b>return a new instance that applies the operator (<b>selector</b>) to the ugens (<b>a </b>and<b> b</b>)</p>
+<p class="p2"><span class="Apple-tab-span">	</span><span class="Apple-tab-span">	</span><span class="Apple-tab-span">	</span><span class="Apple-tab-span">	</span><span class="Apple-tab-span">	</span><span class="Apple-tab-span">	</span></p>
+<p class="p1">BinaryOpUGens are created as the result of a binary operator applied to a UGen.<span class="Apple-converted-space"> </span></p>
+<p class="p2"><br></p>
+<p class="p4"><span class="Apple-tab-span">	</span>(<span class="s4">SinOsc</span>.ar(200) * <span class="s4">ClipNoise</span>.ar).dump;</p>
+<p class="p4"><span class="Apple-tab-span">	</span>(<span class="s4">SinOsc</span>.ar(200).thresh(0.5)).dump;</p>
 <p class="p5"><br></p>
-<p class="p3">The use of the binary operators <b>*</b> and <b>thresh</b> above each instantiate a BinaryOpUGen. The operators themselves<span class="Apple-converted-space">  </span>(which are methods) are not to be confused with the resulting BinaryOpUGen (which is an object).<span class="Apple-converted-space"> </span></p>
-<p class="p3">Operating on UGens instead of numbers, what results is not a result of the calculation, but a structure that represents that calculation. For the immediate operations on numbers, see for example <a href="../Math/SimpleNumber.html"><span class="s2">SimpleNumber</span></a>.</p>
+<p class="p6"><br></p>
+<p class="p1">The use of the binary operators <b>*</b> and <b>thresh</b> above each instantiate a BinaryOpUGen. The operators themselves<span class="Apple-converted-space">  </span>(which are methods) are not to be confused with the resulting BinaryOpUGen (which is an object).<span class="Apple-converted-space"> </span></p>
+<p class="p1">Operating on UGens instead of numbers, what results is not a result of the calculation, but a structure that represents that calculation. For the immediate operations on numbers, see for example <a href="../Math/SimpleNumber.html"><span class="s3">SimpleNumber</span></a>.</p>
 <p class="p2"><br></p>
-<p class="p3">There are helpfiles for each the different operators, listed below.</p>
+<p class="p1">There are helpfiles for each the different operators, listed below. Examples for unary operations on UGens are to be found in UGen's superclass <a href="../Core/Kernel/AbstractFunction.html"><span class="s3">AbstractFunction</span></a>.</p>
 <p class="p2"><br></p>
-<p class="p3">The operators &gt;, &gt;=, &lt;, and &lt;= are particularly useful for triggering. They should not be confused with their use in conditionals. Compare</p>
-<p class="p5"><br></p>
-<p class="p6">if(1 &gt; 0) {<span class="s3">"1 is greater than 0"</span>.postln }; <span class="s4">// &gt; returns a boolean</span></p>
-<p class="p5"><br></p>
-<p class="p3">with</p>
-<p class="p5"><br></p>
+<p class="p1">The following operators have their own helpfiles:</p>
+<p class="p2"><br></p>
+<p class="p1"><b>+ - * / ** absdif amclip atan2 clip2 difsqr excess fold2 hypot hypotApx max min ring1 ring2 ring3 ring4 round scaleneg sqrdif sqrsum sumsqr thresh trunc wrap2</b></p>
+<p class="p2"><b></b><br></p>
+<p class="p7"><span class="s2"><span class="Apple-tab-span">	</span></span>// example</p>
+<p class="p8"><span class="Apple-tab-span">	</span></p>
+<p class="p7"><span class="s2"><span class="Apple-tab-span">	</span>a = </span><span class="s4">WhiteNoise</span><span class="s2">.ar; </span>// a WhiteNoise</p>
+<p class="p7"><span class="s2"><span class="Apple-tab-span">	</span>b = a + 2; </span>// a BinaryOpUGen.</p>
+<p class="p4"><span class="Apple-tab-span">	</span>b.operator; <span class="s5">// +</span></p>
+<p class="p9"><span class="Apple-tab-span">	</span></p>
+<p class="p2"><b></b><br></p>
+<p class="p1"><b>The comparison operators</b></p>
+<p class="p2"><br></p>
+<p class="p1">The operators &gt;, &gt;=, &lt;, and &lt;= are particularly useful for triggering. They should not be confused with their use in conditionals. Compare</p>
+<p class="p6"><br></p>
+<p class="p10">if(1 &gt; 0) { <span class="s6">"1 is greater than 0"</span>.postln }; <span class="s7">// &gt; returns a boolean</span></p>
+<p class="p6"><br></p>
+<p class="p1">with</p>
+<p class="p6"><br></p>
 <p class="p7">// trigger an envelope</p>
 <p class="p4">(</p>
 <p class="p4">{</p>
-<p class="p4"><span class="Apple-tab-span">	</span><span class="s1">var</span> trig;</p>
-<p class="p4"><span class="Apple-tab-span">	</span>trig = <span class="s1">SinOsc</span>.ar(1) &gt; 0.1;</p>
-<p class="p4"><span class="Apple-tab-span">	</span><span class="s1">EnvGen</span>.kr(<span class="s1">Env</span>.perc, trig, doneAction: 0) * <span class="s1">SinOsc</span>.ar(440,0,0.1)</p>
+<p class="p4"><span class="Apple-tab-span">	</span><span class="s4">var</span> trig;</p>
+<p class="p4"><span class="Apple-tab-span">	</span>trig = <span class="s4">SinOsc</span>.ar(1) &gt; 0.1;</p>
+<p class="p4"><span class="Apple-tab-span">	</span><span class="s4">EnvGen</span>.kr(<span class="s4">Env</span>.perc, trig, doneAction: 0) * <span class="s4">SinOsc</span>.ar(440,0,0.1)</p>
 <p class="p4">}.play</p>
-<p class="p7"><span class="s5">) </span>// &gt; outputs 0 or 1</p>
-<p class="p5"><br></p>
-<p class="p3">See the individual helpfiles for more detail.</p>
+<p class="p7"><span class="s2">) </span>// &gt; outputs 0 or 1</p>
+<p class="p6"><br></p>
+<p class="p1">See the individual helpfiles ( <a href="greaterthan.html"><span class="s3">&gt;</span></a>, <a href="greaterorequalthan.html"><span class="s3">&gt;=</span></a>, <a href="lessthan.html"><span class="s3">&lt;</span></a>, <a href="lessorequalthan.html"><span class="s3">&lt;=</span></a><span class="s3"> </span>) for more detail.</p>
 <p class="p2"><br></p>
-<p class="p3">The following operators have their own helpfiles:</p>
 <p class="p2"><br></p>
-<p class="p3"><b>+ - * / ** absdif amclip atan2 clip2 difsqr excess fold2 hypot hypotApx max min ring1 ring2 ring3 ring4 round scaleneg sqrdif sqrsum sumsqr thresh trunc wrap2</b></p>
 <p class="p2"><br></p>
-<p class="p2"><br></p>
-<p class="p6">// using exp for compression or expansion</p>
-<p class="p6">(</p>
-<p class="p8"><br></p>
-<p class="p8"><br></p>
-<p class="p6">)</p>
-<p class="p8"><br></p>
-<p class="p8"><br></p>
-<p class="p8"><br></p>
 </body>
 </html>

Modified: trunk/build/Help/UGens/Algebraic/UnaryOpUGen.html
===================================================================
--- trunk/build/Help/UGens/Algebraic/UnaryOpUGen.html	2008-12-25 18:23:39 UTC (rev 8294)
+++ trunk/build/Help/UGens/Algebraic/UnaryOpUGen.html	2008-12-25 18:44:45 UTC (rev 8295)
@@ -5,46 +5,56 @@
 <meta http-equiv="Content-Style-Type" content="text/css">
 <title></title>
 <meta name="Generator" content="Cocoa HTML Writer">
-<meta name="CocoaVersion" content="949.35">
+<meta name="CocoaVersion" content="949.43">
 <style type="text/css">
 p.p1 {margin: 0.0px 0.0px 0.0px 0.0px; font: 12.0px Helvetica}
 p.p2 {margin: 0.0px 0.0px 0.0px 0.0px; font: 12.0px Helvetica; min-height: 14.0px}
-p.p3 {margin: 0.0px 0.0px 0.0px 0.0px; font: 12.0px Helvetica; color: #0000ff}
-p.p4 {margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco; color: #bf0000}
-p.p5 {margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco; min-height: 12.0px}
-p.p6 {margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco}
-p.p7 {margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco; color: #bf0000; min-height: 12.0px}
+p.p3 {margin: 0.0px 0.0px 0.0px 0.0px; font: 12.0px Helvetica; color: #0021e7}
+p.p4 {margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco}
+p.p5 {margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco; color: #ad140d}
+p.p6 {margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco; min-height: 12.0px}
+p.p7 {margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco; color: #ad140d; min-height: 12.0px}
 span.s1 {font: 18.0px Helvetica}
 span.s2 {color: #000000}
-span.s3 {color: #0000bf}
-span.s4 {color: #bf0000}
+span.s3 {text-decoration: underline}
+span.s4 {color: #0000ff}
+span.s5 {color: #0000bf}
+span.s6 {color: #001bb9}
+span.s7 {color: #ad140d}
 span.Apple-tab-span {white-space:pre}
 </style>
 </head>
 <body>
-<p class="p1"><span class="s1"><b>UnaryOpUgen</b></span><span class="Apple-tab-span">	</span><span class="Apple-tab-span">	</span>unary operator on a ugen</p>
+<p class="p1"><span class="s1"><b>UnaryOpUgen</b></span><span class="Apple-tab-span">	</span><span class="Apple-tab-span">	</span><b>apply a unary operation to the values of an input ugen</b></p>
 <p class="p2"><br></p>
 <p class="p1">superclass: BasicOpUGen</p>
 <p class="p2"><br></p>
-<p class="p3"><span class="s2">see also <a href="../../BinaryOps/BinaryOpUGen.html">BinaryOpUGen</a></span></p>
+<p class="p3"><span class="s2">see also: <a href="../../BinaryOps/BinaryOpUGen.html"><span class="s3">BinaryOpUGen</span></a></span></p>
+<p class="p1">structurally related: <a href="../../Core/UnaryOpFunction.html"><span class="s4">UnaryOpFunction</span></a>, <a href="../../Streams-Patterns-Events/Punop.html"><span class="s4">Punop</span></a></p>
 <p class="p2"><br></p>
+<p class="p2"><br></p>
 <p class="p1"><span class="Apple-tab-span">	</span><b>*new(selector, a)<span class="Apple-tab-span">	</span><span class="Apple-tab-span">	</span></b>return a new instance that applies the operator (<b>selector</b>) to the ugen (<b>a</b>)</p>
-<p class="p1"><span class="Apple-tab-span">	</span><span class="Apple-tab-span">	</span><span class="Apple-tab-span">	</span><span class="Apple-tab-span">	</span><span class="Apple-tab-span">	</span><span class="Apple-tab-span">	</span>normally, this is implicitly called when applying a unary operator to a UGen.</p>
+<p class="p2"><br></p>
+<p class="p1">UnaryOpUGens are created as the result of a unary operator applied to a UGen.<span class="Apple-converted-space"> </span></p>
+<p class="p2"><br></p>
+<p class="p4"><span class="Apple-tab-span">	</span>(<span class="s5">SinOsc</span>.ar(200).abs).dump;</p>
+<p class="p4"><span class="Apple-tab-span">	</span>(<span class="s5">LFSaw</span>.ar(200).sin).dump;</p>
+<p class="p2"><br></p>
 <p class="p2"><span class="Apple-tab-span">	</span></p>
-<p class="p1">Examples for unary operations on UGens are to be found in UGen's superclass AbstractFunction.<span class="Apple-converted-space"> </span></p>
+<p class="p1">Examples for unary operations on UGens are to be found in UGen's superclass <a href="../../Core/Kernel/AbstractFunction.html"><span class="s4">AbstractFunction</span></a>.<span class="Apple-converted-space"> </span></p>
 <p class="p1">They include: <b>neg, abs, ceil, floor, frac, squared, cubed, sqrt, exp, log, log2, log10, sin, cos, scurve, distort</b></p>
 <p class="p2"><span class="Apple-tab-span">	</span></p>
-<p class="p4"><span class="s2"><span class="Apple-tab-span">	</span></span>// example</p>
-<p class="p5"><span class="Apple-tab-span">	</span></p>
-<p class="p4"><span class="s2"><span class="Apple-tab-span">	</span>a = </span><span class="s3">WhiteNoise</span><span class="s2">.ar; </span>// a WhiteNoise</p>
-<p class="p4"><span class="s2"><span class="Apple-tab-span">	</span>b = a.squared; </span>// a UnaryOpUGen.</p>
-<p class="p6"><span class="Apple-tab-span">	</span>b.operator; <span class="s4">// squared</span></p>
+<p class="p5"><span class="s2"><span class="Apple-tab-span">	</span></span>// example</p>
+<p class="p6"><span class="Apple-tab-span">	</span></p>
+<p class="p5"><span class="s2"><span class="Apple-tab-span">	</span>a = </span><span class="s6">WhiteNoise</span><span class="s2">.ar; </span>// a WhiteNoise</p>
+<p class="p5"><span class="s2"><span class="Apple-tab-span">	</span>b = a.squared; </span>// a UnaryOpUGen.</p>
+<p class="p4"><span class="Apple-tab-span">	</span>b.operator; <span class="s7">// squared</span></p>
 <p class="p7"><span class="Apple-tab-span">	</span></p>
-<p class="p4"><span class="Apple-tab-span">	</span>// sound example</p>
+<p class="p5"><span class="Apple-tab-span">	</span>// sound example</p>
 <p class="p7"><span class="Apple-tab-span">	</span></p>
-<p class="p6"><span class="Apple-tab-span">	</span>{ <span class="s3">var</span> a = <span class="s3">LFSaw</span>.ar(300).range(0, 2pi); a.sin * 0.1 }.play;</p>
-<p class="p5"><span class="Apple-tab-span">	</span></p>
-<p class="p5"><span class="Apple-tab-span">	</span></p>
-<p class="p5"><span class="Apple-tab-span">	</span></p>
+<p class="p4"><span class="Apple-tab-span">	</span>{ <span class="s6">var</span> a = <span class="s6">LFSaw</span>.ar(300).range(0, 2pi); a.sin * 0.1 }.play;</p>
+<p class="p6"><span class="Apple-tab-span">	</span></p>
+<p class="p6"><span class="Apple-tab-span">	</span></p>
+<p class="p6"><span class="Apple-tab-span">	</span></p>
 </body>
 </html>


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.

_______________________________________________
sc-dev mailing list

info (subscription, etc.): http://www.beast.bham.ac.uk/research/sc_mailing_lists.shtml
archive: https://listarc.bham.ac.uk/marchives/sc-dev/
search: https://listarc.bham.ac.uk/lists/sc-dev/search/
Prev by Date: Re: [sc-dev] bad or missing line breaks in class library
Next by Date: [sc-dev] Where do the gremlins come from?
Previous by thread: [sc-dev] SF.net SVN: supercollider:[8294] trunk/build/SCClassLibrary/Common/Control/ Volume.sc
Next by thread: [sc-dev] Where do the gremlins come from?
Index(es):
- Date
- Thread