clean up indentation and spacing
[supercollider.git] / HelpSource / Classes / Logistic.schelp
blob3b2c9ae811e2570c2cfadf427338393891ecb554
1 class:: Logistic
2 summary:: Chaotic noise function
3 related:: Classes/Crackle, Classes/LatoocarfianN
4 categories::  UGens>Generators>Chaotic
7 Description::
9 A noise generator based on the logistic map:
10 code::
11 y = chaosParam * y * (1.0 - y)
14 classmethods::
15 private:: categories
17 method::ar, kr
19 argument::chaosParam
20 a parameter of the chaotic function with useful values from 0.0 to 4.0. Chaos occurs from 3.57 up. Don't use values outside this range if you don't want the UGen to blow up.
22 argument::freq
23 Frequency of calculation; if over the sampling rate, this is clamped to the sampling rate
25 argument:: init
26 Initial value of y in the equation above
28 argument::mul
29 Output will be multiplied by this value.
31 argument::add
32 This value will be added to the output.
34 discussion::
35 y will stay in the range of 0.0 to 1.0 for normal values of the chaosParam. This leads to a DC offset, and may cause a pop when you stop the Synth. For output you might want to combine this UGen with a LeakDC or rescale around 0.0 via mul and add: see example below.
37 examples::
38 code::
39 // default values
40 { Logistic.ar }.play
42 // onset of chaos
43 { Logistic.ar(Line.kr(3.55, 3.6, 5), 1000) }.play
45 // explore via Mouse
46 { Logistic.ar(MouseX.kr(3, 3.99), MouseY.kr(10, 10000, 'exponential'), 0.25, 0.5) }.play