Markus Mottl avatar Markus Mottl committed f8f15de

Improved documentation of some matrix trace operations related to the Frobenius norm/product

Comments (0)

Files changed (1)

   mat ->
   num_type
 (** [gemm_trace ?n ?k ?transa ?ar ?ac a ?transb ?br ?bc b] computes
-    the trace of the product of the (sub-)matrices [a] and [b]
-    (taking into account potential transposing).  [n] is the number
-    of rows (columns) to consider in [a], and [k] the number of
-    columns (rows) in [b].
+    the trace of the product of the (sub-)matrices [a] and [b] (taking into
+    account potential transposing).  This is also sometimes referred to as
+    the Frobenius product.  [n] is the number of rows (columns) to consider in
+    [a], and [k] the number of columns (rows) in [b].
 
     @param n default = number of rows of [a] (or tr [a]) and
                        number of columns of [b] (or tr [b])
   mat ->
   num_type
 (** [syrk_trace ?n ?k ?ar ?ac a] computes the trace of either [a' * a]
-    or [a * a'], whichever is more efficient (results are identical),
-    of the (sub-)matrix [a] multiplied by its own transpose.  [n]
-    is the number of rows to consider in [a], and [k] the number
-    of columns to consider.
+    or [a * a'], whichever is more efficient (results are identical), of the
+    (sub-)matrix [a] multiplied by its own transpose.  This is the same as
+    the square of the Frobenius norm of a matrix.  [n] is the number of rows
+    to consider in [a], and [k] the number of columns to consider.
 
     @param n default = number of rows of [a]
     @param k default = number of columns of [a]
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.