Update documentation after 0.1.1 release

[clnl] / docs / DocsStrictMath.md

diff --git a/docs/DocsStrictMath.md b/docs/DocsStrictMath.md
new file mode 100644 (file)
index 0000000..184100e
--- /dev/null
+++ b/docs/DocsStrictMath.md
@@ -0,0 +1,56 @@
+# Package STRICTMATH
+
+Main strictmath package.
+
+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.
+
+## Contents
+
+* **function [cos](#function-cos)** - _cos_ returns the cos of the angle _x_.
+* **function [sin](#function-sin)** - _sin_ returns the sin of the angle _x_.
+* **function [to-radians](#function-to-radians)** - _to-radians_ returns the radians equivalent of the angle passed in, in degrees.
+
+## Function **COS**
+
+#### Syntax:
+
+**cos** _x_ => _result_
+
+#### Arguments and Values:
+
+_x_---A double representing the angle in radians bounded from [0, 2pi]  
+_result_---A double representing the cos of the angle  
+
+#### Description:
+
+_cos_ returns the cos of the angle _x_.
+
+## Function **SIN**
+
+#### Syntax:
+
+**sin** _x_ => _result_
+
+#### Arguments and Values:
+
+_x_---A double representing the angle in radians bounded from [0, 2pi]  
+_result_---A double representing the sin of the angle  
+
+#### Description:
+
+_sin_ returns the sin of the angle _x_.
+
+## Function **TO-RADIANS**
+
+#### Syntax:
+
+**to-radians** _deg_ => _rad_
+
+#### Arguments and Values:
+
+_deg_---A double representing the angle in degrees  
+_rad_---A double representing the angle in radians  
+
+#### Description:
+
+_to-radians_ returns the radians equivalent of the angle passed in, in degrees.