summaryrefslogtreecommitdiff
path: root/doc/api.texi
diff options
context:
space:
mode:
authorDavid Thompson <dthompson2@worcester.edu>2017-04-06 10:29:32 -0400
committerDavid Thompson <dthompson2@worcester.edu>2017-04-25 20:36:46 -0400
commit78a0e2a289a076814cb404190a3ae6556b9f5a1a (patch)
tree9a1a83c3ce360038e2301960061eb3e27d5feb54 /doc/api.texi
parent6a182194d6bf70dac37e18d4c63c56314018147c (diff)
math: Add pi constant.
* chickadee/math.scm (pi): New variable. * doc/api.texi (Math): Add "Basics" subsection.
Diffstat (limited to 'doc/api.texi')
-rw-r--r--doc/api.texi15
1 files changed, 15 insertions, 0 deletions
diff --git a/doc/api.texi b/doc/api.texi
index 9c568d5..e1f6acc 100644
--- a/doc/api.texi
+++ b/doc/api.texi
@@ -406,11 +406,26 @@ with vectors and matrices and axis-aligned bounding box collision
detection.
@menu
+* Basics:: Commonly used, miscellaneous things.
* Vectors:: Euclidean vectors.
* Matrices:: Transformation matrices.
* Rectangles:: Axis-aligned bounding boxes.
@end menu
+@node Basics
+@subsection Basics
+
+@defvar {Scheme Variable} pi
+An essential constant for all trigonometry. @code{@U{03C0}} is the ratio
+of a circle's circumferences to its diameter. Since @code{@U{03C0}} is an
+irrational number, the @var{pi} in Chickadee is a mere floating point
+approximation that is ``good enough.''
+@end defvar
+
+@defvar {Scheme Variable} pi/2
+Half of @var{pi}.
+@end defvar
+
@node Vectors
@subsection Vectors