src/dynoplibs/math.ops

   1 /*
   2  * $Id$
   3 ** math.ops
   4 */
   5
   6 BEGIN_OPS_PREAMBLE
   7
   8 #include <math.h>
   9
  10 END_OPS_PREAMBLE
  11
  12 =head1 NAME
  13
  14 math.ops - Mathematical Opcodes
  15
  16 =cut
  17
  18 =head1 DESCRIPTION
  19
  20 Parrot's library of mathematical ops.
  21
  22 To use this library of ops, add this directive to your PIR:
  23
  24  .loadlib 'math_ops'
  25
  26 =cut
  27
  28 =over
  29
  30 =item B<rand>(out NUM)
  31
  32 Set $1 to a random floating point number between 0 and 1, inclusive.
  33
  34 =cut
  35
  36 inline op rand(out NUM) {
  37   $1 = Parrot_float_rand(0);
  38 }
  39
  40 =item B<rand>(out INT)
  41
  42 Set $1 to a random integer between C<[-2^31, 2^31)> .
  43
  44 =cut
  45
  46 inline op rand(out INT) {
  47   $1 = Parrot_int_rand(0);
  48 }
  49
  50 =item B<rand>(out NUM, in NUM)
  51
  52 Set $1 to a random floating point number between 0 and and $2, inclusive.
  53
  54 =cut
  55
  56 inline op rand(out NUM, in NUM) {
  57   $1 = $2 * Parrot_float_rand(0);
  58 }
  59
  60 =item B<rand>(out INT, in INT)
  61
  62 Set $1 to a integer between 0 and and $2, inclusive.
  63
  64 =cut
  65
  66 inline op rand(out INT, in INT) {
  67   $1 = Parrot_range_rand(0, $2, 0);
  68 }
  69
  70 =item B<rand>(out NUM, in NUM, in NUM)
  71
  72 Set $1 to a random floating point number between $2 and and $3, inclusive.
  73
  74 =cut
  75
  76 inline op rand(out NUM, in NUM, in NUM) {
  77   $1 = $2 + ($3 - $2) * Parrot_float_rand(0);
  78 }
  79
  80 =item B<srand>(in NUM)
  81
  82 Set the random number seed to $1. $1 is casted to an INTVAL.
  83
  84 =cut
  85
  86 inline op srand(in NUM) {
  87     Parrot_srand((INTVAL)$1);
  88 }
  89
  90 =item B<srand>(in INT)
  91
  92 Set the random number seed to $1.
  93
  94 =cut
  95
  96 inline op srand(in INT) {
  97     Parrot_srand((INTVAL)$1);
  98 }
  99
 100 =item B<rand>(out INT, in INT, in INT)
 101
 102 Set $1 to a integer between $2 and and $3, inclusive.
 103
 104 =cut
 105
 106 inline op rand(out INT, in INT, in INT) {
 107   $1 = Parrot_range_rand($2, $3, 0);
 108 }
 109
 110 =back
 111
 112 =head1 COPYRIGHT
 113
 114 Copyright (C) 2001-2009, Parrot Foundation.
 115
 116 =head1 LICENSE
 117
 118 This program is free software. It is subject to the same license
 119 as the Parrot interpreter itself.
 120
 121 =cut
 122
 123
 124 /*
 125  * Local variables:
 126  *   c-file-style: "parrot"
 127  * End:
 128  * vim: expandtab shiftwidth=4:
 129  */