HelpSource/Classes/CheckBadValues.schelp

   1 class:: CheckBadValues
   2 summary:: Test for infinity, not-a-number, and denormals
   3 categories:: UGens>Info
   4
   5 description::
   6 This link::Classes/UGen:: tests for infinity, NaN (not a number), and denormals. If one of these is found, it posts a warning. Its output is as follows: 0 = a normal float, 1 = NaN, 2 = infinity, and 3 = a denormal.
   7
   8 classmethods::
   9
  10 method:: ar, kr
  11 argument:: in
  12 the link::Classes/UGen:: whose output is to be tested.
  13 argument:: id
  14 an id number to identify this link::Classes/UGen::. The default is 0.
  15 argument:: post
  16 One of three post modes:
  17
  18 list::
  19 ## 0 = no posting;
  20 ## 1 = post a line for every bad value;
  21 ## 2 = post a line only when the floating-point classification changes (e.g., normal -> NaN and vice versa)
  22 ::
  23
  24 The default post mode is 2. Post mode 1 is retained for backward compatibility; be aware that it generates a large amount of output.
  25
  26 examples::
  27 code::
  28 { CheckBadValues.kr(SinOsc.ar); 0}.play // nothing wrong here
  29
  30 { CheckBadValues.kr(1 / 0, 1).poll; 0 }.play // check infinity
  31
  32 x = { arg test = -1; CheckBadValues.kr(test); 0 }.play // check NaN
  33 x.set(\test, -1.sqrt);
  34
  35 // don't post, but do something with the output
  36 (
  37 x = { arg freq = 440;
  38         var good;
  39         good = BinaryOpUGen('==', CheckBadValues.kr(freq, 0, 0), 0);
  40         SinOsc.ar(freq, 0, 0.1) * good // silence the output if freq is bad
  41 }.play;
  42 )
  43 x.set(\freq, -1.sqrt);
  44
  45 // the UGen method checkBadValues passes through the input for quick testing
  46 { SinOsc.ar(440, 0, 0.1).checkBadValues }.play
  47 ::