code.consxy.com Git - clnl/blob - docs/DocsStrictMath.md

   1 # Package STRICTMATH
   2
   3 Main strictmath package.
   4
   5 Strictmath is a pure common lisp implementation of Java's StrictMath class, for only those functions as needed by CLNL to match NetLogo's output, and only for doubles.  It should provide portable results for those functions that it supports.
   6
   7 ## Contents
   8
   9 * **function [cos](#function-cos)** - _cos_ returns the cos of the angle _x_.
  10 * **function [sin](#function-sin)** - _sin_ returns the sin of the angle _x_.
  11 * **function [to-radians](#function-to-radians)** - _to-radians_ returns the radians equivalent of the angle passed in, in degrees.
  12
  13 ## Function **COS**
  14
  15 #### Syntax:
  16
  17 **cos** _x_ => _result_
  18
  19 #### Arguments and Values:
  20
  21 _x_---A double representing the angle in radians bounded from [0, 2pi]
  22 _result_---A double representing the cos of the angle
  23
  24 #### Description:
  25
  26 _cos_ returns the cos of the angle _x_.
  27
  28 ## Function **SIN**
  29
  30 #### Syntax:
  31
  32 **sin** _x_ => _result_
  33
  34 #### Arguments and Values:
  35
  36 _x_---A double representing the angle in radians bounded from [0, 2pi]
  37 _result_---A double representing the sin of the angle
  38
  39 #### Description:
  40
  41 _sin_ returns the sin of the angle _x_.
  42
  43 ## Function **TO-RADIANS**
  44
  45 #### Syntax:
  46
  47 **to-radians** _deg_ => _rad_
  48
  49 #### Arguments and Values:
  50
  51 _deg_---A double representing the angle in degrees
  52 _rad_---A double representing the angle in radians
  53
  54 #### Description:
  55
  56 _to-radians_ returns the radians equivalent of the angle passed in, in degrees.