HelpSource/Classes/Interval.schelp

   1 CLASS::Interval
   2 summary::range of integers
   3 categories:: Math
   4
   5 DESCRIPTION::
   6 An Interval is a range of integers from a starting value to an ending value by some step value.
   7
   8 CLASSMETHODS::
   9
  10 method::new
  11 Create a new Interval.
  12 code::
  13 Interval(10, 30, 4);
  14 10 to: 30; // the message to creates an interval with step 1
  15 ::
  16
  17 INSTANCEMETHODS::
  18
  19 method::start
  20 The starting value of the interval.
  21
  22 method::end
  23 The ending value of the interval.
  24
  25 method::step
  26 The step value of the interval.
  27
  28 method::size
  29 Return the number of items in the interval.
  30 code::
  31 Interval(10, 30, 4).size.postln;
  32 ::
  33
  34 method::at
  35 Return the indexed item in the interval.
  36 code::
  37 Interval(10, 30, 4).at(3).postln;
  38 ::
  39
  40 method::do
  41 Evaluates function for each item in the interval. The function is passed two arguments, the item and an integer index.
  42 code::
  43 Interval(10, 30, 4).do({ arg item, i; item.postln });
  44 ::