HelpSource/Classes/Magnitude.schelp

   1 class:: Magnitude
   2 summary:: Comparable value in a linear continuum
   3 categories:: Math
   4
   5 description::
   6 Magnitudes represent values along a linear continuum which can be compared against each other.
   7
   8 instancemethods::
   9 method:: <
  10 returns:: a link::Classes/Boolean:: whether the receiver is less than strong::aMagnitude::.
  11
  12 method:: <=
  13 returns:: a link::Classes/Boolean:: whether the receiver is less than or equal to strong::aMagnitude::.
  14
  15 method:: >
  16 returns:: a link::Classes/Boolean:: whether the receiver is greater than strong::aMagnitude::.
  17
  18 method:: >=
  19 returns:: a link::Classes/Boolean:: whether the receiver is greater than or equal to strong::aMagnitude::.
  20
  21 method:: min
  22 returns:: the minimum of the receiver and aMagnitude.
  23
  24 method:: max
  25 returns:: the maximum of the receiver and aMagnitude.
  26
  27 method:: clip
  28 If the receiver is less than minVal then answer minVal, else if the receiver is greater than maxVal then answer maxVal, else answer the receiver.
  29
  30 method:: inclusivelyBetween
  31 returns:: whether the receiver is greater than or equal to minVal and less than or equal to maxVal.
  32
  33 method:: exclusivelyBetween
  34 returns:: whether the receiver is greater than minVal and less than maxVal.
  35