summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDavid Thompson <dthompson2@worcester.edu>2022-10-24 17:17:50 -0400
committerDavid Thompson <dthompson2@worcester.edu>2022-10-24 17:18:29 -0400
commit4047c0d0a92eae8a7394b4caa479d0cb6dd9017c (patch)
tree2c7a4e6a6b22120dcd9d74a282bbc1c1d12de809 /doc
parente8674680c41ae856b5b83b3904caca9728b57fce (diff)
math: matrix: Add copy procedures.
Diffstat (limited to 'doc')
-rw-r--r--doc/api.texi27
1 files changed, 27 insertions, 0 deletions
diff --git a/doc/api.texi b/doc/api.texi
index e51a81d..9d743b4 100644
--- a/doc/api.texi
+++ b/doc/api.texi
@@ -1023,6 +1023,14 @@ equivalent to the following code:
Return @code{#t} if @var{obj} is a 3x3 matrix.
@end deffn
+@deffn {Procedure} matrix3= m1 m2
+Return @code{#t} if @var{m1} is the same matrix as @var{m2}.
+@end deffn
+
+@deffn {Procedure} matrix3-copy matrix
+Return a new 3x3 matrix that is a copy of @var{matrix}.
+@end deffn
+
@deffn {Procedure} matrix3* . matrices
Return a new 3x3 matrix containing the product of multiplying all of
the given @var{matrices}.
@@ -1057,6 +1065,10 @@ Return the inverse of @var{matrix}.
The following procedures perform in-place, destructive updates to 3x3
matrix objects:
+@deffn {Procedure} matrix3-copy! src dest
+Copy the contents of matrix @var{src} to @var{dest}.
+@end deffn
+
@deffn {Procedure} matrix3-identity! matrix
Modify @var{matrix} in-place to contain the identity matrix.
@end deffn
@@ -1124,6 +1136,14 @@ equivalent to the following code:
Return @code{#t} if @var{obj} is a 4x4 matrix.
@end deffn
+@deffn {Procedure} matrix4= m1 m2
+Return @code{#t} if @var{m1} is the same matrix as @var{m2}.
+@end deffn
+
+@deffn {Procedure} matrix4-copy matrix
+Return a new 4x4 matrix that is a copy of @var{matrix}.
+@end deffn
+
@deffn {Procedure} matrix4* . matrices
Return a new 4x4 matrix containing the product of multiplying all of
the given @var{matrices}.
@@ -1175,6 +1195,13 @@ Return a new 4x4 matrix that represents a rotation about the Z axis by
@var{theta} radians.
@end deffn
+The following procedures perform in-place, destructive updates to 4x4
+matrix objects:
+
+@deffn {Procedure} matrix4-copy! src dest
+Copy the contents of matrix @var{src} to @var{dest}.
+@end deffn
+
@deffn {Procedure} matrix4-identity! matrix
Modify @var{matrix} in-place to contain the identity matrix.
@end deffn