help/scale

   1 NAME
   2     scale - scale a number or numbers in a value by a power of 2
   3
   4 SYNOPSIS
   5     scale(x, n)
   6
   7 TYPES
   8     If x is an xx-object, scale(x, n) requires xx_scale() to have been
   9     defined; conditions on x and n and the type of value returned are
  10     determined by the definition of xx_scale().
  11
  12     For other x:
  13
  14     x           number (real or complex) or matrix
  15     n           integer
  16
  17     return      same type as x
  18
  19 DESCRIPTION
  20     Returns the value of 2^n * x.
  21
  22     scale(x,n) returns the same as x << n and x >> -n if x is an integer
  23     for which 2^n * x is an integer.
  24
  25 EXAMPLE
  26     > print scale(3, 2), scale(3,1), scale(3,0), scale(3,-1), scale(3,-2)
  27     12 6 3 1.5 .75
  28
  29 LIMITS
  30     For non-object x, abs(n) < 2^31
  31
  32 LINK LIBRARY
  33     NUMBER *qscale(NUMBER *x, long n)
  34     COMPLEX *cscale(COMPLEX *x, long n)
  35     MATRIX *matscale(MATRIX *x, long n)
  36
  37 SEE ALSO
  38     XXX - fill in
  39