HelpSource/Classes/Thunk.schelp

   1 class::Thunk
   2 summary::unevaluated value
   3 categories::Core>Kernel
   4
   5 description::
   6
   7 Thunk, "past tense of think", can be used       when a calculation may, or may not have to be performed at a later point in time, and its value is needed several times. This is an example of lazy evaluation, and can be used to avoid unnecessary calculations and to make state immutable.
   8
   9 classMethods::
  10
  11 method::new
  12
  13 argument::function
  14 some function that returns the desired value
  15
  16 instanceMethods::
  17
  18 method::value
  19
  20 return the value. If calculation is done, use previous value, otherwise do calculation.
  21
  22 examples::
  23
  24 code::
  25 // so for example, random values will result in a single instance:
  26 a = Thunk({ \done.postln; rrand(2.0, 8.0) });
  27 a.value; // posts "done"
  28 a.value;
  29 ::
  30
  31 code::
  32 // it is an AbstractFunction, so one can use it for math operations:
  33
  34 a = Thunk({ rrand(2.0, 8.0) });
  35 b = a * 5 / (a - 1);
  36 b.value;
  37 ::
  38
  39 code::
  40 // lazy evaluation
  41
  42 a = Thunk({ \done1.postln; Array.fill(10000, { |i| i + 6 % 5 * i / 2 }) }); // some calculation.
  43 b = Thunk({ \done2.postln;Array.fill(10000, { |i| i + 5 % 6 * i / 3 }) });// some other calculation.
  44 c = [a, b].choose + 700;
  45 (c * c * c).value; // caclulation happens here, and only once.
  46
  47 // compare to a function:
  48
  49 a = { \done1.postln; Array.fill(10000, { |i| i + 6 % 5 * i / 2 }) }; // some calculation.
  50 b = { \done2.postln;Array.fill(10000, { |i| i + 5 % 6 * i / 3 }) };// some other calculation.
  51 c = [a, b].choose + 700;
  52 (c * c * c).value; // calculation happens here, but 3 times (for each c)
  53 ::
  54