Update JavaDoc.

jacobdwatters · Aug 9, 2024 · 81573b7 · 81573b7
1 parent 7a7c1ca
commit 81573b7
Show file tree

Hide file tree

Showing 373 changed files with 1,332 additions and 1,023 deletions.
diff --git a/docs/allclasses-index.html b/docs/allclasses-index.html
@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
 <html lang="en">
 <head>
-<!-- Generated by javadoc (22) on Thu Aug 08 15:37:02 MDT 2024 -->
+<!-- Generated by javadoc (22) on Fri Aug 09 16:30:31 MDT 2024 -->
 <title>All Classes and Interfaces</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<meta name="dc.created" content="2024-08-08">
+<meta name="dc.created" content="2024-08-09">
 <meta name="description" content="class index">
 <meta name="generator" content="javadoc/AllClassesIndexWriter">
 <link rel="stylesheet" type="text/css" href="resource-files/jquery-ui.min.css" title="Style">
@@ -998,35 +998,41 @@ <h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces<
 <div class="col-last even-row-color all-classes-table all-classes-table-tab2">
 <div class="block">Utility class for computing "norms" of tensors.</div>
 </div>
-<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="org/flag4j/core/TensorOperationsMixin.html" title="interface in org.flag4j.core">TensorOperationsMixin&lt;T,<wbr>U,<wbr>W,<wbr>Z,<wbr>Y,<wbr>X&gt;</a></div>
+<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="org/flag4j/concurrency/TensorOperation.html" title="interface in org.flag4j.concurrency">TensorOperation</a></div>
 <div class="col-last odd-row-color all-classes-table all-classes-table-tab1">
+<div class="block">Functional interface for general tensor operation.</div>
+</div>
+<div class="col-first even-row-color all-classes-table all-classes-table-tab1"><a href="org/flag4j/core/TensorOperationsMixin.html" title="interface in org.flag4j.core">TensorOperationsMixin&lt;T,<wbr>U,<wbr>W,<wbr>Z,<wbr>Y,<wbr>X&gt;</a></div>
+<div class="col-last even-row-color all-classes-table all-classes-table-tab1">
 <div class="block">This interface specifies operations which all tensors (i.e.</div>
 </div>
-<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/flag4j/io/TensorOutputStream.html" title="class in org.flag4j.io">TensorOutputStream</a></div>
-<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
+<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/flag4j/io/TensorOutputStream.html" title="class in org.flag4j.io">TensorOutputStream</a></div>
+<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
 <div class="block">A class for writing tensors to a file in various formats.</div>
 </div>
-<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="org/flag4j/core/TensorPropertiesMixin.html" title="interface in org.flag4j.core">TensorPropertiesMixin</a></div>
-<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">
+<div class="col-first even-row-color all-classes-table all-classes-table-tab1"><a href="org/flag4j/core/TensorPropertiesMixin.html" title="interface in org.flag4j.core">TensorPropertiesMixin</a></div>
+<div class="col-last even-row-color all-classes-table all-classes-table-tab1">
 <div class="block">This interface specifies methods which provide properties of a tensor.</div>
 </div>
-<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/flag4j/io/TensorReader.html" title="class in org.flag4j.io">TensorReader</a></div>
-<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
+<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/flag4j/io/TensorReader.html" title="class in org.flag4j.io">TensorReader</a></div>
+<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
 <div class="block">The TensorReader class provides several static methods for reading serialized
  tensors, matrices, and vectors from a file.</div>
 </div>
-<div class="col-first odd-row-color all-classes-table all-classes-table-tab5"><a href="org/flag4j/util/exceptions/TensorShapeException.html" title="class in org.flag4j.util.exceptions">TensorShapeException</a></div>
-<div class="col-last odd-row-color all-classes-table all-classes-table-tab5">&nbsp;</div>
-<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/flag4j/io/TensorWriter.html" title="class in org.flag4j.io">TensorWriter</a></div>
-<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
+<div class="col-first even-row-color all-classes-table all-classes-table-tab5"><a href="org/flag4j/util/exceptions/TensorShapeException.html" title="class in org.flag4j.util.exceptions">TensorShapeException</a></div>
+<div class="col-last even-row-color all-classes-table all-classes-table-tab5">&nbsp;</div>
+<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/flag4j/io/TensorWriter.html" title="class in org.flag4j.io">TensorWriter</a></div>
+<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
 <div class="block">The TensorWriter class provides several static methods for writing serialized
  tensors, matrices, and vectors to a file.</div>
 </div>
-<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/flag4j/concurrency/ThreadManager.html" title="class in org.flag4j.concurrency">ThreadManager</a></div>
-<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
+<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/flag4j/concurrency/ThreadManager.html" title="class in org.flag4j.concurrency">ThreadManager</a></div>
+<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
 <div class="block">This class contains the base thread pool for all concurrent operations and several methods for managing the
  pool.</div>
 </div>
+<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="org/flag4j/concurrency/ThreadManager.TriConsumer.html" title="interface in org.flag4j.concurrency">ThreadManager.TriConsumer&lt;T,<wbr>U,<wbr>V&gt;</a></div>
+<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">&nbsp;</div>
 <div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/flag4j/operations/TransposeDispatcher.html" title="class in org.flag4j.operations">TransposeDispatcher</a></div>
 <div class="col-last even-row-color all-classes-table all-classes-table-tab2">
 <div class="block">Provides a dispatch method for dynamically choosing the best matrix transpose algorithm.</div>

diff --git a/docs/allpackages-index.html b/docs/allpackages-index.html
@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
 <html lang="en">
 <head>
-<!-- Generated by javadoc (22) on Thu Aug 08 15:37:02 MDT 2024 -->
+<!-- Generated by javadoc (22) on Fri Aug 09 16:30:31 MDT 2024 -->
 <title>All Packages</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<meta name="dc.created" content="2024-08-08">
+<meta name="dc.created" content="2024-08-09">
 <meta name="description" content="package index">
 <meta name="generator" content="javadoc/AllPackagesIndexWriter">
 <link rel="stylesheet" type="text/css" href="resource-files/jquery-ui.min.css" title="Style">

diff --git a/docs/constant-values.html b/docs/constant-values.html
@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
 <html lang="en">
 <head>
-<!-- Generated by javadoc (22) on Thu Aug 08 15:37:02 MDT 2024 -->
+<!-- Generated by javadoc (22) on Fri Aug 09 16:30:31 MDT 2024 -->
 <title>Constant Field Values</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<meta name="dc.created" content="2024-08-08">
+<meta name="dc.created" content="2024-08-09">
 <meta name="description" content="summary of constants">
 <meta name="generator" content="javadoc/ConstantsSummaryWriter">
 <link rel="stylesheet" type="text/css" href="resource-files/jquery-ui.min.css" title="Style">
@@ -76,10 +76,10 @@ <h2 title="org.flag4j.*">org.flag4j.*</h2>
 <div class="table-header col-first">Modifier and Type</div>
 <div class="table-header col-second">Constant Field</div>
 <div class="table-header col-last">Value</div>
-<div class="col-first even-row-color"><code id="org.flag4j.concurrency.Configurations.DEFAULT_BLOCK_SIZE">private&nbsp;static&nbsp;final&nbsp;int</code></div>
+<div class="col-first even-row-color"><code id="org.flag4j.concurrency.Configurations.DEFAULT_BLOCK_SIZE">public&nbsp;static&nbsp;final&nbsp;int</code></div>
 <div class="col-second even-row-color"><code><a href="org/flag4j/concurrency/Configurations.html#DEFAULT_BLOCK_SIZE">DEFAULT_BLOCK_SIZE</a></code></div>
 <div class="col-last even-row-color"><code>64</code></div>
-<div class="col-first odd-row-color"><code id="org.flag4j.concurrency.Configurations.DEFAULT_MIN_RECURSIVE_SIZE">private&nbsp;static&nbsp;final&nbsp;int</code></div>
+<div class="col-first odd-row-color"><code id="org.flag4j.concurrency.Configurations.DEFAULT_MIN_RECURSIVE_SIZE">public&nbsp;static&nbsp;final&nbsp;int</code></div>
 <div class="col-second odd-row-color"><code><a href="org/flag4j/concurrency/Configurations.html#DEFAULT_MIN_RECURSIVE_SIZE">DEFAULT_MIN_RECURSIVE_SIZE</a></code></div>
 <div class="col-last odd-row-color"><code>128</code></div>
 </div>
@@ -241,7 +241,7 @@ <h2 title="org.flag4j.*">org.flag4j.*</h2>
 <div class="table-header col-last">Value</div>
 <div class="col-first even-row-color"><code id="org.flag4j.operations.dense.complex.ComplexDenseElemMult.CONCURRENT_THRESHOLD">private&nbsp;static&nbsp;final&nbsp;int</code></div>
 <div class="col-second even-row-color"><code><a href="org/flag4j/operations/dense/complex/ComplexDenseElemMult.html#CONCURRENT_THRESHOLD">CONCURRENT_THRESHOLD</a></code></div>
-<div class="col-last even-row-color"><code>50625</code></div>
+<div class="col-last even-row-color"><code>50000</code></div>
 </div>
 </li>
 </ul>

diff --git a/docs/help-doc.html b/docs/help-doc.html
@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
 <html lang="en">
 <head>
-<!-- Generated by javadoc (22) on Thu Aug 08 15:37:02 MDT 2024 -->
+<!-- Generated by javadoc (22) on Fri Aug 09 16:30:31 MDT 2024 -->
 <title>API Help</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<meta name="dc.created" content="2024-08-08">
+<meta name="dc.created" content="2024-08-09">
 <meta name="description" content="help">
 <meta name="generator" content="javadoc/HelpWriter">
 <link rel="stylesheet" type="text/css" href="resource-files/jquery-ui.min.css" title="Style">

diff --git a/docs/index-files/index-1.html b/docs/index-files/index-1.html
@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
 <html lang="en">
 <head>
-<!-- Generated by javadoc (22) on Thu Aug 08 15:37:02 MDT 2024 -->
+<!-- Generated by javadoc (22) on Fri Aug 09 16:30:31 MDT 2024 -->
 <title>A-Index</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<meta name="dc.created" content="2024-08-08">
+<meta name="dc.created" content="2024-08-09">
 <meta name="description" content="index: A">
 <meta name="generator" content="javadoc/IndexWriter">
 <link rel="stylesheet" type="text/css" href="../resource-files/jquery-ui.min.css" title="Style">
@@ -81,6 +81,8 @@ <h2 class="title" id="I:A">A</h2>
 <dd>
 <div class="block">Computes the element-wise absolute value of a tensor.</div>
 </dd>
+<dt><a href="../org/flag4j/concurrency/ThreadManager.TriConsumer.html#accept(T,U,V)" class="member-name-link">accept(T, U, V)</a> - Method in interface org.flag4j.concurrency.<a href="../org/flag4j/concurrency/ThreadManager.TriConsumer.html" title="interface in org.flag4j.concurrency">ThreadManager.TriConsumer</a></dt>
+<dd>&nbsp;</dd>
 <dt><a href="../org/flag4j/complex_numbers/CNumber.html#acos(double)" class="member-name-link">acos(double)</a> - Static method in class org.flag4j.complex_numbers.<a href="../org/flag4j/complex_numbers/CNumber.html" title="class in org.flag4j.complex_numbers">CNumber</a></dt>
 <dd>
 <div class="block">Computes the inverse cosine of a value.</div>
@@ -1330,6 +1332,10 @@ <h2 class="title" id="I:A">A</h2>
 <dd>
 <div class="block">Applies the specified binary operation on the two tensors.</div>
 </dd>
+<dt><a href="../org/flag4j/concurrency/TensorOperation.html#apply(int,int)" class="member-name-link">apply(int, int)</a> - Method in interface org.flag4j.concurrency.<a href="../org/flag4j/concurrency/TensorOperation.html" title="interface in org.flag4j.concurrency">TensorOperation</a></dt>
+<dd>
+<div class="block">Applies a tensor operation over the specified index range.</div>
+</dd>
 <dt><a href="../org/flag4j/operations/dense_sparse/csr/complex/ComplexCsrDenseOperations.html#applyBinOpp(org.flag4j.arrays.dense.CMatrix,org.flag4j.arrays.sparse.CsrCMatrix,java.util.function.BinaryOperator)" class="member-name-link">applyBinOpp(CMatrix, CsrCMatrix, BinaryOperator&lt;CNumber&gt;)</a> - Static method in class org.flag4j.operations.dense_sparse.csr.complex.<a href="../org/flag4j/operations/dense_sparse/csr/complex/ComplexCsrDenseOperations.html" title="class in org.flag4j.operations.dense_sparse.csr.complex">ComplexCsrDenseOperations</a></dt>
 <dd>
 <div class="block">Applies the specified binary operator element-wise to the two matrices.</div>

diff --git a/docs/index-files/index-10.html b/docs/index-files/index-10.html
@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
 <html lang="en">
 <head>
-<!-- Generated by javadoc (22) on Thu Aug 08 15:37:02 MDT 2024 -->
+<!-- Generated by javadoc (22) on Fri Aug 09 16:30:31 MDT 2024 -->
 <title>J-Index</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<meta name="dc.created" content="2024-08-08">
+<meta name="dc.created" content="2024-08-09">
 <meta name="description" content="index: J">
 <meta name="generator" content="javadoc/IndexWriter">
 <link rel="stylesheet" type="text/css" href="../resource-files/jquery-ui.min.css" title="Style">

diff --git a/docs/index-files/index-11.html b/docs/index-files/index-11.html
@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
 <html lang="en">
 <head>
-<!-- Generated by javadoc (22) on Thu Aug 08 15:37:02 MDT 2024 -->
+<!-- Generated by javadoc (22) on Fri Aug 09 16:30:31 MDT 2024 -->
 <title>K-Index</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<meta name="dc.created" content="2024-08-08">
+<meta name="dc.created" content="2024-08-09">
 <meta name="description" content="index: K">
 <meta name="generator" content="javadoc/IndexWriter">
 <link rel="stylesheet" type="text/css" href="../resource-files/jquery-ui.min.css" title="Style">

diff --git a/docs/index-files/index-12.html b/docs/index-files/index-12.html
@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
 <html lang="en">
 <head>
-<!-- Generated by javadoc (22) on Thu Aug 08 15:37:02 MDT 2024 -->
+<!-- Generated by javadoc (22) on Fri Aug 09 16:30:31 MDT 2024 -->
 <title>L-Index</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<meta name="dc.created" content="2024-08-08">
+<meta name="dc.created" content="2024-08-09">
 <meta name="description" content="index: L">
 <meta name="generator" content="javadoc/IndexWriter">
 <link rel="stylesheet" type="text/css" href="../resource-files/jquery-ui.min.css" title="Style">

diff --git a/docs/index-files/index-13.html b/docs/index-files/index-13.html
@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
 <html lang="en">
 <head>
-<!-- Generated by javadoc (22) on Thu Aug 08 15:37:02 MDT 2024 -->
+<!-- Generated by javadoc (22) on Fri Aug 09 16:30:31 MDT 2024 -->
 <title>M-Index</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<meta name="dc.created" content="2024-08-08">
+<meta name="dc.created" content="2024-08-09">
 <meta name="description" content="index: M">
 <meta name="generator" content="javadoc/IndexWriter">
 <link rel="stylesheet" type="text/css" href="../resource-files/jquery-ui.min.css" title="Style">
@@ -59,9 +59,7 @@ <h2 class="title" id="I:M">M</h2>
 <dd>
 <div class="block">Squares this magnitude of this complex number.</div>
 </dd>
-<dt><a href="../org/flag4j/core/Shape.html#main(java.lang.String%5B%5D)" class="member-name-link">main(String[])</a> - Static method in class org.flag4j.core.<a href="../org/flag4j/core/Shape.html" title="class in org.flag4j.core">Shape</a></dt>
-<dd>&nbsp;</dd>
-<dt><a href="../org/flag4j/operations/dense/real/RealDenseTranspose.html#main(java.lang.String%5B%5D)" class="member-name-link">main(String[])</a> - Static method in class org.flag4j.operations.dense.real.<a href="../org/flag4j/operations/dense/real/RealDenseTranspose.html" title="class in org.flag4j.operations.dense.real">RealDenseTranspose</a></dt>
+<dt><a href="../org/flag4j/operations/dense/real/RealDenseMatrixMultiplication.html#main(java.lang.String%5B%5D)" class="member-name-link">main(String[])</a> - Static method in class org.flag4j.operations.dense.real.<a href="../org/flag4j/operations/dense/real/RealDenseMatrixMultiplication.html" title="class in org.flag4j.operations.dense.real">RealDenseMatrixMultiplication</a></dt>
 <dd>&nbsp;</dd>
 <dt><a href="../org/flag4j/arrays/dense/Matrix.html#makeComplexTensor(org.flag4j.core.Shape,double%5B%5D)" class="member-name-link">makeComplexTensor(Shape, double[])</a> - Method in class org.flag4j.arrays.dense.<a href="../org/flag4j/arrays/dense/Matrix.html" title="class in org.flag4j.arrays.dense">Matrix</a></dt>
 <dd>
@@ -747,10 +745,6 @@ <h2 class="title" id="I:M">M</h2>
 <dd>
 <div class="block">Computes the minimum real component from an array of complex numbers.</div>
 </dd>
-<dt><a href="../org/flag4j/concurrency/Configurations.html#minRecursiveSize" class="member-name-link">minRecursiveSize</a> - Static variable in class org.flag4j.concurrency.<a href="../org/flag4j/concurrency/Configurations.html" title="class in org.flag4j.concurrency">Configurations</a></dt>
-<dd>
-<div class="block">The minimum size of tensor/matrix/vector to make recursive calls on in recursive algorithms.</div>
-</dd>
 <dt><a href="../org/flag4j/operations/sparse/csr/complex/ComplexCsrManipulations.html#moveAndShiftLeft(org.flag4j.arrays.sparse.CsrCMatrix,int,int,int)" class="member-name-link">moveAndShiftLeft(CsrCMatrix, int, int, int)</a> - Static method in class org.flag4j.operations.sparse.csr.complex.<a href="../org/flag4j/operations/sparse/csr/complex/ComplexCsrManipulations.html" title="class in org.flag4j.operations.sparse.csr.complex">ComplexCsrManipulations</a></dt>
 <dd>
 <div class="block">Moves a non-zero value in a row of a CSR matrix to a new column to the right of its current column.</div>

diff --git a/docs/index-files/index-14.html b/docs/index-files/index-14.html
@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
 <html lang="en">
 <head>
-<!-- Generated by javadoc (22) on Thu Aug 08 15:37:02 MDT 2024 -->
+<!-- Generated by javadoc (22) on Fri Aug 09 16:30:31 MDT 2024 -->
 <title>N-Index</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<meta name="dc.created" content="2024-08-08">
+<meta name="dc.created" content="2024-08-09">
 <meta name="description" content="index: N">
 <meta name="generator" content="javadoc/IndexWriter">
 <link rel="stylesheet" type="text/css" href="../resource-files/jquery-ui.min.css" title="Style">

diff --git a/docs/index-files/index-15.html b/docs/index-files/index-15.html
@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
 <html lang="en">
 <head>
-<!-- Generated by javadoc (22) on Thu Aug 08 15:37:02 MDT 2024 -->
+<!-- Generated by javadoc (22) on Fri Aug 09 16:30:31 MDT 2024 -->
 <title>O-Index</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<meta name="dc.created" content="2024-08-08">
+<meta name="dc.created" content="2024-08-09">
 <meta name="description" content="index: O">
 <meta name="generator" content="javadoc/IndexWriter">
 <link rel="stylesheet" type="text/css" href="../resource-files/jquery-ui.min.css" title="Style">