summaryrefslogtreecommitdiff
path: root/manuals/chickadee/Vectors.html
diff options
context:
space:
mode:
authorDavid Thompson <dthompson@vistahigherlearning.com>2020-04-08 17:10:29 -0400
committerDavid Thompson <dthompson@vistahigherlearning.com>2020-04-08 17:10:29 -0400
commite7d470e954d0a17ab1b2fe0065f46f78475272f9 (patch)
treeca4d9c00789f41dbbdbac33151824812dad879f7 /manuals/chickadee/Vectors.html
parentb660cbb5287f7cdcb6cebaba72afe8fc7d512616 (diff)
Add chickade 0.5.0 stuff.
Diffstat (limited to 'manuals/chickadee/Vectors.html')
-rw-r--r--manuals/chickadee/Vectors.html118
1 files changed, 58 insertions, 60 deletions
diff --git a/manuals/chickadee/Vectors.html b/manuals/chickadee/Vectors.html
index 20632cd..9dff143 100644
--- a/manuals/chickadee/Vectors.html
+++ b/manuals/chickadee/Vectors.html
@@ -1,6 +1,6 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
-<!-- Copyright (C) 2017, 2018, 2019 David Thompson davet@gnu.org
+<!-- Copyright (C) 2017-2020 David Thompson davet@gnu.org
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3
@@ -18,7 +18,7 @@ Foundation Web site at http://www.gnu.org/licenses/fdl.html.
The document was typeset with
http://www.texinfo.org/ (GNU Texinfo).
-->
-<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
+<!-- Created by GNU Texinfo 6.6, http://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Vectors (The Chickadee Game Toolkit)</title>
@@ -38,23 +38,14 @@ http://www.texinfo.org/ (GNU Texinfo).
<!--
a.summary-letter {text-decoration: none}
blockquote.indentedblock {margin-right: 0em}
-blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
-blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
-div.smalldisplay {margin-left: 3.2em}
-div.smallexample {margin-left: 3.2em}
-div.smalllisp {margin-left: 3.2em}
kbd {font-style: oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
-pre.smalldisplay {font-family: inherit; font-size: smaller}
-pre.smallexample {font-size: smaller}
-pre.smallformat {font-family: inherit; font-size: smaller}
-pre.smalllisp {font-size: smaller}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
@@ -89,14 +80,12 @@ ul.no-bullet {list-style: none}
</head>
<body lang="en">
-<a name="Vectors"></a>
-<div class="header">
+<span id="Vectors"></span><div class="header">
<p>
Next: <a href="Rectangles.html#Rectangles" accesskey="n" rel="next">Rectangles</a>, Previous: <a href="Basics.html#Basics" accesskey="p" rel="prev">Basics</a>, Up: <a href="Math.html#Math" accesskey="u" rel="up">Math</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Index.html#Index" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
-<a name="Vectors-1"></a>
-<h4 class="subsection">2.2.2 Vectors</h4>
+<span id="Vectors-1"></span><h4 class="subsection">2.2.2 Vectors</h4>
<p>Unlike Scheme&rsquo;s vector data type, which is a sequence of arbitrary
Scheme objects, Chickadee&rsquo;s <code>(chickadee math vector)</code> module
@@ -118,8 +107,7 @@ used to cut down on typing:
<pre class="example">(define v (vec2+ #v(1 2) #v(3 4)))
</pre></div>
-<a name="A-Note-About-Performance"></a>
-<h4 class="subsubsection">2.2.2.1 A Note About Performance</h4>
+<span id="A-Note-About-Performance"></span><h4 class="subsubsection">2.2.2.1 A Note About Performance</h4>
<p>A lot of time has been spent making Chickadee&rsquo;s vector operations
perform relatively efficiently in critical code paths where excessive
@@ -131,223 +119,233 @@ order to take advantage of optimizations relating to floating point
math operations. The downside is that since these are not pure
functions, they do not compose well and create more verbose code.
</p>
-<a name="g_t2D-Vectors"></a>
-<h4 class="subsubsection">2.2.2.2 2D Vectors</h4>
+<span id="g_t2D-Vectors"></span><h4 class="subsubsection">2.2.2.2 2D Vectors</h4>
<dl>
-<dt><a name="index-vec2"></a>Procedure: <strong>vec2</strong> <em>x y</em></dt>
+<dt id="index-vec2">Procedure: <strong>vec2</strong> <em>x y</em></dt>
<dd><p>Return a new 2D vector with coordinates (<var>x</var>, <var>y</var>).
</p></dd></dl>
<dl>
-<dt><a name="index-vec2_002fpolar"></a>Procedure: <strong>vec2/polar</strong> <em>r theta</em></dt>
+<dt id="index-vec2_002fpolar">Procedure: <strong>vec2/polar</strong> <em>r theta</em></dt>
<dd><p>Return a new 2D vector containing the Cartesian representation of the
polar coordinate (<var>r</var>, <var>theta</var>). The angle <var>theta</var> is
measured in radians.
</p></dd></dl>
<dl>
-<dt><a name="index-vec2_003f"></a>Procedure: <strong>vec2?</strong> <em>obj</em></dt>
+<dt id="index-vec2_003f">Procedure: <strong>vec2?</strong> <em>obj</em></dt>
<dd><p>Return <code>#t</code> if <var>obj</var> is a 2D vector.
</p></dd></dl>
<dl>
-<dt><a name="index-vec2_002dx"></a>Procedure: <strong>vec2-x</strong> <em>v</em></dt>
+<dt id="index-vec2_002dx">Procedure: <strong>vec2-x</strong> <em>v</em></dt>
<dd><p>Return the X coordinate of the 2D vector <var>v</var>.
</p></dd></dl>
<dl>
-<dt><a name="index-vec2_002dy"></a>Procedure: <strong>vec2-y</strong> <em>v</em></dt>
+<dt id="index-vec2_002dy">Procedure: <strong>vec2-y</strong> <em>v</em></dt>
<dd><p>Return the Y coordinate of the 2D vector <var>v</var>.
</p></dd></dl>
<dl>
-<dt><a name="index-vec2_002dcopy"></a>Procedure: <strong>vec2-copy</strong> <em>v</em></dt>
+<dt id="index-vec2_002dcopy">Procedure: <strong>vec2-copy</strong> <em>v</em></dt>
<dd><p>Return a fresh copy of the 2D vector <var>v</var>.
</p></dd></dl>
<dl>
-<dt><a name="index-vec2_002dmagnitude"></a>Procedure: <strong>vec2-magnitude</strong> <em>v</em></dt>
+<dt id="index-vec2_002dmagnitude">Procedure: <strong>vec2-magnitude</strong> <em>v</em></dt>
<dd><p>Return the magnitude of the 2D vector <var>v</var>.
</p></dd></dl>
<dl>
-<dt><a name="index-vec2_002ddot_002dproduct"></a>Procedure: <strong>vec2-dot-product</strong> <em>v1 v2</em></dt>
+<dt id="index-vec2_002ddot_002dproduct">Procedure: <strong>vec2-dot-product</strong> <em>v1 v2</em></dt>
<dd><p>Return the dot product of the 2D vectors <var>v1</var> and <var>v2</var>.
</p></dd></dl>
<dl>
-<dt><a name="index-vec2_002dnormalize"></a>Procedure: <strong>vec2-normalize</strong> <em>v</em></dt>
+<dt id="index-vec2_002dnormalize">Procedure: <strong>vec2-normalize</strong> <em>v</em></dt>
<dd><p>Return the normalized form of the 2D vector <var>v</var>.
</p></dd></dl>
<dl>
-<dt><a name="index-vec2_002b"></a>Procedure: <strong>vec2+</strong> <em>v x</em></dt>
+<dt id="index-vec2_002b">Procedure: <strong>vec2+</strong> <em>v x</em></dt>
<dd><p>Add <var>x</var>, either a 2D vector or a scalar (i.e. a real number), to
the 2D vector <var>v</var> and return a new vector containing the sum.
</p></dd></dl>
<dl>
-<dt><a name="index-vec2_002d"></a>Procedure: <strong>vec2-</strong> <em>v x</em></dt>
+<dt id="index-vec2_002d">Procedure: <strong>vec2-</strong> <em>v x</em></dt>
<dd><p>Subtract <var>x</var>, either a 2D vector or a scalar, from the 2D vector
<var>v</var> and return a new vector containing the difference.
</p></dd></dl>
<dl>
-<dt><a name="index-vec2_002a"></a>Procedure: <strong>vec2*</strong> <em>v x</em></dt>
+<dt id="index-vec2_002a">Procedure: <strong>vec2*</strong> <em>v x</em></dt>
<dd><p>Multiply the 2D vector <var>v</var> by <var>x</var>, a 2D vector or a scalar,
and return a new vector containing the product.
</p></dd></dl>
<dl>
-<dt><a name="index-set_002dvec2_002dx_0021"></a>Procedure: <strong>set-vec2-x!</strong> <em>v x</em></dt>
+<dt id="index-set_002dvec2_002dx_0021">Procedure: <strong>set-vec2-x!</strong> <em>v x</em></dt>
<dd><p>Set the X coordinate of the 2D vector <var>v</var> to <var>x</var>.
</p></dd></dl>
<dl>
-<dt><a name="index-set_002dvec2_002dy_0021"></a>Procedure: <strong>set-vec2-y!</strong> <em>v y</em></dt>
+<dt id="index-set_002dvec2_002dy_0021">Procedure: <strong>set-vec2-y!</strong> <em>v y</em></dt>
<dd><p>Set the Y coordinate of the 2D vector <var>v</var> to <var>y</var>.
</p></dd></dl>
<dl>
-<dt><a name="index-set_002dvec2_0021"></a>Procedure: <strong>set-vec2!</strong> <em>v x y</em></dt>
+<dt id="index-set_002dvec2_0021">Procedure: <strong>set-vec2!</strong> <em>v x y</em></dt>
<dd><p>Set the X and Y coordinates of the 2D vector <var>v</var> to <var>x</var> and
<var>y</var>, respectively.
</p></dd></dl>
<dl>
-<dt><a name="index-vec2_002dcopy_0021"></a>Procedure: <strong>vec2-copy!</strong> <em>source target</em></dt>
+<dt id="index-vec2_002dcopy_0021">Procedure: <strong>vec2-copy!</strong> <em>source target</em></dt>
<dd><p>Copy the 2D vector <var>source</var> into the 2D vector <var>target</var>.
</p></dd></dl>
<dl>
-<dt><a name="index-vec2_002dadd_0021"></a>Procedure: <strong>vec2-add!</strong> <em>v x</em></dt>
+<dt id="index-vec2_002dadd_0021">Procedure: <strong>vec2-add!</strong> <em>v x</em></dt>
<dd><p>Perform an in-place modification of the 2D vector <var>v</var> by adding
<var>x</var>, a 2D vector or a scalar.
</p></dd></dl>
<dl>
-<dt><a name="index-vec2_002dsub_0021"></a>Procedure: <strong>vec2-sub!</strong> <em>v x</em></dt>
+<dt id="index-vec2_002dsub_0021">Procedure: <strong>vec2-sub!</strong> <em>v x</em></dt>
<dd><p>Perform an in-place modification of the 2D vector <var>v</var> by
subtracting <var>x</var>, a 2D vector or a scalar.
</p></dd></dl>
<dl>
-<dt><a name="index-vec2_002dmult_0021"></a>Procedure: <strong>vec2-mult!</strong> <em>v x</em></dt>
+<dt id="index-vec2_002dmult_0021">Procedure: <strong>vec2-mult!</strong> <em>v x</em></dt>
<dd><p>Perform an in-place modification of the 2D vector <var>v</var> by
multiplying it by <var>x</var>, a 2D vector or a scalar.
</p></dd></dl>
-<a name="g_t3D-Vectors"></a>
-<h4 class="subsubsection">2.2.2.3 3D Vectors</h4>
+<span id="g_t3D-Vectors"></span><h4 class="subsubsection">2.2.2.3 3D Vectors</h4>
<dl>
-<dt><a name="index-vec3"></a>Procedure: <strong>vec3</strong> <em>x y</em></dt>
+<dt id="index-vec3">Procedure: <strong>vec3</strong> <em>x y</em></dt>
<dd><p>Return a new 2D vector with coordinates (<var>x</var>, <var>y</var>).
</p></dd></dl>
<dl>
-<dt><a name="index-vec3_003f"></a>Procedure: <strong>vec3?</strong> <em>obj</em></dt>
+<dt id="index-vec3_003f">Procedure: <strong>vec3?</strong> <em>obj</em></dt>
<dd><p>Return <code>#t</code> if <var>obj</var> is a 3D vector.
</p></dd></dl>
<dl>
-<dt><a name="index-vec3_002dx"></a>Procedure: <strong>vec3-x</strong> <em>v</em></dt>
+<dt id="index-vec3_002dx">Procedure: <strong>vec3-x</strong> <em>v</em></dt>
<dd><p>Return the X coordinate of the 3D vector <var>v</var>.
</p></dd></dl>
<dl>
-<dt><a name="index-vec3_002dy"></a>Procedure: <strong>vec3-y</strong> <em>v</em></dt>
+<dt id="index-vec3_002dy">Procedure: <strong>vec3-y</strong> <em>v</em></dt>
<dd><p>Return the Y coordinate of the 3D vector <var>v</var>.
</p></dd></dl>
<dl>
-<dt><a name="index-vec3_002dz"></a>Procedure: <strong>vec3-z</strong> <em>v</em></dt>
+<dt id="index-vec3_002dz">Procedure: <strong>vec3-z</strong> <em>v</em></dt>
<dd><p>Return the Z coordinate of the 3D vector <var>v</var>.
</p></dd></dl>
<dl>
-<dt><a name="index-vec3_002dcopy"></a>Procedure: <strong>vec3-copy</strong> <em>v</em></dt>
+<dt id="index-vec3_002dcopy">Procedure: <strong>vec3-copy</strong> <em>v</em></dt>
<dd><p>Return a fresh copy of the 3D vector <var>v</var>.
</p></dd></dl>
<dl>
-<dt><a name="index-vec3_002dmagnitude"></a>Procedure: <strong>vec3-magnitude</strong> <em>v</em></dt>
+<dt id="index-vec3_002dmagnitude">Procedure: <strong>vec3-magnitude</strong> <em>v</em></dt>
<dd><p>Return the magnitude of the 3D vector <var>v</var>.
</p></dd></dl>
<dl>
-<dt><a name="index-vec3_002ddot_002dproduct"></a>Procedure: <strong>vec3-dot-product</strong> <em>v1 v2</em></dt>
+<dt id="index-vec3_002ddot_002dproduct">Procedure: <strong>vec3-dot-product</strong> <em>v1 v2</em></dt>
<dd><p>Return the dot product of the 3D vectors <var>v1</var> and <var>v2</var>.
</p></dd></dl>
<dl>
-<dt><a name="index-vec3_002dnormalize"></a>Procedure: <strong>vec3-normalize</strong> <em>v</em></dt>
+<dt id="index-vec3_002dcross">Procedure: <strong>vec3-cross</strong> <em>v1 v2</em></dt>
+<dd><p>Return a new 3D vector containing the cross product of <var>v1</var> and
+<var>v2</var>.
+</p></dd></dl>
+
+<dl>
+<dt id="index-vec3_002dnormalize">Procedure: <strong>vec3-normalize</strong> <em>v</em></dt>
<dd><p>Return the normalized form of the 3D vector <var>v</var>.
</p></dd></dl>
<dl>
-<dt><a name="index-vec3_002b"></a>Procedure: <strong>vec3+</strong> <em>v x</em></dt>
+<dt id="index-vec3_002b">Procedure: <strong>vec3+</strong> <em>v x</em></dt>
<dd><p>Add <var>x</var>, either a 3D vector or a scalar (i.e. a real number), to
the 3D vector <var>v</var> and return a new vector containing the sum.
</p></dd></dl>
<dl>
-<dt><a name="index-vec3_002d"></a>Procedure: <strong>vec3-</strong> <em>v x</em></dt>
+<dt id="index-vec3_002d">Procedure: <strong>vec3-</strong> <em>v x</em></dt>
<dd><p>Subtract <var>x</var>, either a 3D vector or a scalar, from the 3D vector
<var>v</var> and return a new vector containing the difference.
</p></dd></dl>
<dl>
-<dt><a name="index-vec3_002a"></a>Procedure: <strong>vec3*</strong> <em>v x</em></dt>
+<dt id="index-vec3_002a">Procedure: <strong>vec3*</strong> <em>v x</em></dt>
<dd><p>Multiply the 3D vector <var>v</var> by <var>x</var>, a 3D vector or a scalar,
and return a new vector containing the product.
</p></dd></dl>
<dl>
-<dt><a name="index-set_002dvec3_002dx_0021"></a>Procedure: <strong>set-vec3-x!</strong> <em>v x</em></dt>
+<dt id="index-set_002dvec3_002dx_0021">Procedure: <strong>set-vec3-x!</strong> <em>v x</em></dt>
<dd><p>Set the X coordinate of the 3D vector <var>v</var> to <var>x</var>.
</p></dd></dl>
<dl>
-<dt><a name="index-set_002dvec3_002dy_0021"></a>Procedure: <strong>set-vec3-y!</strong> <em>v y</em></dt>
+<dt id="index-set_002dvec3_002dy_0021">Procedure: <strong>set-vec3-y!</strong> <em>v y</em></dt>
<dd><p>Set the Y coordinate of the 3D vector <var>v</var> to <var>y</var>.
</p></dd></dl>
<dl>
-<dt><a name="index-set_002dvec3_002dz_0021"></a>Procedure: <strong>set-vec3-z!</strong> <em>v z</em></dt>
+<dt id="index-set_002dvec3_002dz_0021">Procedure: <strong>set-vec3-z!</strong> <em>v z</em></dt>
<dd><p>Set the Z coordinate of the 3D vector <var>v</var> to <var>z</var>.
</p></dd></dl>
<dl>
-<dt><a name="index-set_002dvec3_0021"></a>Procedure: <strong>set-vec3!</strong> <em>v x y z</em></dt>
+<dt id="index-set_002dvec3_0021">Procedure: <strong>set-vec3!</strong> <em>v x y z</em></dt>
<dd><p>Set the X, Y, and Z coordinates of the 3D vector <var>v</var> to <var>x</var>,
<var>y</var>, and <var>z</var>, respectively.
</p></dd></dl>
<dl>
-<dt><a name="index-vec3_002dcopy_0021"></a>Procedure: <strong>vec3-copy!</strong> <em>source target</em></dt>
+<dt id="index-vec3_002dcopy_0021">Procedure: <strong>vec3-copy!</strong> <em>source target</em></dt>
<dd><p>Copy the 3D vector <var>source</var> into the 3D vector <var>target</var>.
</p></dd></dl>
<dl>
-<dt><a name="index-vec3_002dadd_0021"></a>Procedure: <strong>vec3-add!</strong> <em>v x</em></dt>
+<dt id="index-vec3_002dadd_0021">Procedure: <strong>vec3-add!</strong> <em>v x</em></dt>
<dd><p>Perform an in-place modification of the 3D vector <var>v</var> by adding
<var>x</var>, a 3D vector or a scalar.
</p></dd></dl>
<dl>
-<dt><a name="index-vec3_002dsub_0021"></a>Procedure: <strong>vec3-sub!</strong> <em>v x</em></dt>
+<dt id="index-vec3_002dsub_0021">Procedure: <strong>vec3-sub!</strong> <em>v x</em></dt>
<dd><p>Perform an in-place modification of the 3D vector <var>v</var> by
subtracting <var>x</var>, a 3D vector or a scalar.
</p></dd></dl>
<dl>
-<dt><a name="index-vec3_002dmult_0021"></a>Procedure: <strong>vec3-mult!</strong> <em>v x</em></dt>
+<dt id="index-vec3_002dmult_0021">Procedure: <strong>vec3-mult!</strong> <em>v x</em></dt>
<dd><p>Perform an in-place modification of the 3D vector <var>v</var> by
multiplying it by <var>x</var>, a 3D vector or a scalar.
</p></dd></dl>
+<dl>
+<dt id="index-vec3_002dcross_0021">Procedure: <strong>vec3-cross!</strong> <em>dest v1 v2</em></dt>
+<dd><p>Compute the cross product of the 3D vectors <var>v1</var> and <var>v2</var> and
+store the result in <var>dest</var>.
+</p></dd></dl>
+
<hr>
<div class="header">
<p>
generated by cgit v1.2.3 (git 2.25.4) at 2024-11-21 23:31:22 +0000