Fix error in description of contents of matrix contructed from GrB_Matrix_diag

sei-smcmillan · sei-smcmillan · commit bc9fc27aaf23 · 2021-12-09T14:25:21.000-08:00
diff --git a/graph-api-c/GraphBLAS_API_C.tex b/graph-api-c/GraphBLAS_API_C.tex
@@ -95,17 +95,17 @@
 \newcommand{\bDin}[1]{\mbox{$\mathbf{D}_{in_{#1}}$}}
 \newcommand{\bDout}{\mbox{$\mathbf{D}_{out}$}}
 
-%\newcommand{\aydin}[1]{{{\color{orange}[Aydin: #1]}}}
-%\newcommand{\scott}[1]{{{\color{violet}[Scott: #1]}}}
-%\newcommand{\tim}[1]{{{\color{teal}[Tim: #1]}}}
-%\newcommand{\jose}[1]{{{\color{red}[Jose: #1]}}}
-%\newcommand{\ben}[1]{{{\color{blue}[Ben: #1]}}}
-
-\newcommand{\aydin}[1]{}
-\newcommand{\scott}[1]{}
-\newcommand{\tim}[1]{}
-\newcommand{\jose}[1]{}
-\newcommand{\ben}[1]{}
+\newcommand{\aydin}[1]{{{\color{orange}[Aydin: #1]}}}
+\newcommand{\scott}[1]{{{\color{violet}[Scott: #1]}}}
+\newcommand{\tim}[1]{{{\color{teal}[Tim: #1]}}}
+\newcommand{\jose}[1]{{{\color{red}[Jose: #1]}}}
+\newcommand{\ben}[1]{{{\color{blue}[Ben: #1]}}}
+
+%\newcommand{\aydin}[1]{}
+%\newcommand{\scott}[1]{}
+%\newcommand{\tim}[1]{}
+%\newcommand{\jose}[1]{}
+%\newcommand{\ben}[1]{}
 
 %\aydin{testing}
 %\scott{testing}
@@ -133,8 +133,8 @@
 \title{
 The GraphBLAS C API Specification
 \footnote{Based on \emph{GraphBLAS Mathematics} by Jeremy Kepner}: \\ 
-{\large Version 2.0.0} \\
-{\normalsize \scott{Remember to update acknowledgements and remove DRAFT}}
+{\large Version 2.0.1} \\
+{\normalsize \scott{THIS IS A DRAFT VERION. Update acks and remove DRAFT before release.}}
 }
 
 \author{Benjamin Brock, Ayd\i n Bulu\c{c}, Timothy Mattson, Scott McMillan, Jos\'e Moreira}
diff --git a/graph-api-c/appendices.tex b/graph-api-c/appendices.tex
@@ -2,7 +2,14 @@ \chapter{Revision history}
 \label{Chp:RevHistory}
 %--------------------------------------------------------------
 
-Changes in 2.0.0 (Released: \#\#-Xxxxx-2021:
+Changes in 2.0.1 (Released: \#\# Xxxxx 2022:
+\begin{itemize}
+\item (Issue GH-69) Fix error in description of contents of matrix constructed from {\sf GrB\_Matrix\_diag}.
+\end{itemize}
+ 
+%--------------------------------------------------------------
+
+Changes in 2.0.0 (Released: 15 November 2021:
 \begin{itemize}
 \item Reorganized Chapters 2 and 3: Chapter 2 contains prose regarding the basic concepts captured in the API; Chapter 3 presents all of the enumeratiosn, literals, data types, and predefined objects required by the API.  Made short captions for the List of Tables.
 \item (Issue BB-49, BB-50) Updated and corrected language regarding multithreading and completion, and requirements regarding acquire-release memory orders.  Methods that used to force complete no longer do.
diff --git a/graph-api-c/vector_matrix_methods.tex b/graph-api-c/vector_matrix_methods.tex
@@ -307,7 +307,7 @@ \subsubsection{{\sf Vector\_nvals}: Number of stored elements in a vector}
 
 %-----------------------------------------------------------------------------
 
-\subsubsection{{\sf Vector\_build}: Store elements from tuples into a vector \scott{NEW CONTENT}}
+\subsubsection{{\sf Vector\_build}: Store elements from tuples into a vector}
 \label{Sec:Vector_build}
 
 \paragraph{\syntax}
@@ -332,7 +332,7 @@ \subsubsection{{\sf Vector\_build}: Store elements from tuples into a vector \sc
     to apply when duplicate values for the same location are present in the input
     arrays. All three domains of {\sf dup} must be the same; hence
 	    $dup=\langle D_{dup},D_{dup},D_{dup},\oplus \rangle$.
-    If {\sf dup} is {\sf GrB\_NULL}, then duplicate locations will result in an error.  \scott{NEW CONTENT}
+    If {\sf dup} is {\sf GrB\_NULL}, then duplicate locations will result in an error.
 \end{itemize}
 
 \paragraph{Return Values}
@@ -371,10 +371,10 @@ \subsubsection{{\sf Vector\_build}: Store elements from tuples into a vector \sc
 	In other words, {\sf GrB\_Vector\_nvals(C)} returns a positive value.
     
     \item[{\sf GrB\_INVALID\_VALUE}] {\sf indices} contains a duplicate location
-    and {\sf dup} is {\sf GrB\_NULL}. \scott{NEW CONTENT}
+    and {\sf dup} is {\sf GrB\_NULL}.
 \end{itemize}
 
-\paragraph{Description \scott{NEW CONTENT}}
+\paragraph{Description}
 
 If {\sf dup} is not {\sf GrB\_NULL}, an internal vector 
 $\vector{\widetilde{w}} = \langle D_{dup},\mathbf{size}({\sf w}),\emptyset \rangle$ 
@@ -413,7 +413,7 @@ \subsubsection{{\sf Vector\_build}: Store elements from tuples into a vector \sc
 
 
 %-----------------------------------------------------------------------------
-\subsubsection{{\sf Vector\_setElement}: Set a single element in a vector\scott{NEW CONTENT}}
+\subsubsection{{\sf Vector\_setElement}: Set a single element in a vector}
 
 Set one element of a vector to a given value.
 
@@ -584,7 +584,7 @@ \subsubsection{{\sf Vector\_removeElement}: Remove an element from a vector}
 
 %-----------------------------------------------------------------------------
 
-\subsubsection{{\sf Vector\_extractElement}: Extract a single element from a vector.\scott{NEW CONTENT}}
+\subsubsection{{\sf Vector\_extractElement}: Extract a single element from a vector.}
 \label{Sec:Vector_extractElement}
 \label{Sec:extract_single_element_vec}
 
@@ -910,7 +910,7 @@ \subsubsection{{\sf Matrix\_dup}: Construct a copy of a GraphBLAS matrix}
 
 %-----------------------------------------------------------------------------
 
-\subsubsection{{\sf Matrix\_diag}: Construct a diagonal GraphBLAS matrix \scott{NEW CONTENT}}
+\subsubsection{{\sf Matrix\_diag}: Construct a diagonal GraphBLAS matrix}
 
 Creates a new matrix with the same domain and contents as a {\sf GrB\_Vector}, 
 and square dimensions appropriate for placing the contents of the vector along the 
@@ -969,7 +969,7 @@ \subsubsection{{\sf Matrix\_diag}: Construct a diagonal GraphBLAS matrix \scott{
 \begin{eqnarray*}
 \mathbf{L}({\sf C}) & = & \{ (i, i + k, v_i) ~:~ (i, v_i) \in \mathbf{L}({\sf v})\} \mbox{~if~} k \ge 0
 \mbox{~or} \\
-\mathbf{L}({\sf C}) & = & \{ (i - k, i, v_i) ~:~ (i, v_i) \in \mathbf{L}({\sf v})\} \mbox{~if~} k \ge 0.
+\mathbf{L}({\sf C}) & = & \{ (i - k, i, v_i) ~:~ (i, v_i) \in \mathbf{L}({\sf v})\} \mbox{~if~} k < 0.
 \end{eqnarray*}
 It returns a handle to it in {\sf C}.  It is not an error to call this method 
 more than once on the same variable; however, the handle to the previously 
@@ -1213,7 +1213,7 @@ \subsubsection{{\sf Matrix\_nvals}: Number of stored elements in a matrix}
 
 %-----------------------------------------------------------------------------
 
-\subsubsection{{\sf Matrix\_build}: Store elements from tuples into a matrix \scott{NEW CONTENT}}
+\subsubsection{{\sf Matrix\_build}: Store elements from tuples into a matrix}
 \label{Sec:Matrix_build}
 
 \paragraph{\syntax}
@@ -1241,7 +1241,7 @@ \subsubsection{{\sf Matrix\_build}: Store elements from tuples into a matrix \sc
     to apply when duplicate values for the same location are present in the input
     arrays. All three domains of {\sf dup} must be the same; hence
 	    $dup=\langle D_{dup},D_{dup},D_{dup},\oplus \rangle$.
-    If {\sf dup} is {\sf GrB\_NULL}, then duplicate locations will result in an error. \scott{NEW CONTENT}
+    If {\sf dup} is {\sf GrB\_NULL}, then duplicate locations will result in an error.
 \end{itemize}    
 
 \paragraph{Return Values}
@@ -1279,10 +1279,10 @@ \subsubsection{{\sf Matrix\_build}: Store elements from tuples into a matrix \sc
 	In other words, {\sf GrB\_Matrix\_nvals(C)} returns a positive value.
     
     \item[{\sf GrB\_INVALID\_VALUE}] {\sf indices} contains a duplicate location
-    and {\sf dup} is {\sf GrB\_NULL}. \scott{NEW CONTENT}
+    and {\sf dup} is {\sf GrB\_NULL}.
 \end{itemize}
 
-\paragraph{Description \scott{NEW CONTENT}}
+\paragraph{Description}
 
 If {\sf dup} is not {\sf GrB\_NULL}, an internal matrix 
 $\matrix{\widetilde{C}} = \langle D_{dup}, \mathbf{nrows}({\sf C}),
@@ -1321,7 +1321,7 @@ \subsubsection{{\sf Matrix\_build}: Store elements from tuples into a matrix \sc
 modify or delete the arrays {\sf row\_indices}, {\sf col\_indices}, or {\sf values}.
 
 %-----------------------------------------------------------------------------
-\subsubsection{{\sf Matrix\_setElement}: Set a single element in matrix\scott{NEW CONTENT}}
+\subsubsection{{\sf Matrix\_setElement}: Set a single element in matrix}
 
 Set one element of a matrix to a given value.
 
@@ -1509,7 +1509,7 @@ \subsubsection{{\sf Matrix\_removeElement}: Remove an element from a matrix}
 
 %-----------------------------------------------------------------------------
 
-\subsubsection{{\sf Matrix\_extractElement}: Extract a single element from a matrix\scott{NEW CONTENT}}
+\subsubsection{{\sf Matrix\_extractElement}: Extract a single element from a matrix}
 \label{Sec:Matrix_extractElement}
 \label{Sec:extract_single_element_mat}
 
@@ -1730,7 +1730,7 @@ \subsubsection{{\sf Matrix\_extractTuples}: Extract tuples from a matrix}
 
 %-----------------------------------------------------------------------------
 
-\subsubsection{{\sf Matrix\_exportHint}: Provide a hint as to which storage format might be most efficient for exporting a matrix \ben{NEW CONTENT}}
+\subsubsection{{\sf Matrix\_exportHint}: Provide a hint as to which storage format might be most efficient for exporting a matrix}
 \label{Sec:Matrix_exportHint}
 
 \paragraph{\syntax}
@@ -1783,7 +1783,7 @@ \subsubsection{{\sf Matrix\_exportHint}: Provide a hint as to which storage form
 
 %-----------------------------------------------------------------------------
 
-\subsubsection{{\sf Matrix\_exportSize}: Return the array sizes necessary to export a GraphBLAS matrix object \ben{NEW CONTENT}}
+\subsubsection{{\sf Matrix\_exportSize}: Return the array sizes necessary to export a GraphBLAS matrix object}
 \label{Sec:Matrix_exportSize}
 
 \paragraph{\syntax}
@@ -1843,7 +1843,7 @@ \subsubsection{{\sf Matrix\_exportSize}: Return the array sizes necessary to exp
 
 %-----------------------------------------------------------------------------
 
-\subsubsection{{\sf Matrix\_export}: Export a GraphBLAS matrix to a pre-defined format \ben{NEW CONTENT}}
+\subsubsection{{\sf Matrix\_export}: Export a GraphBLAS matrix to a pre-defined format}
 \label{Sec:Matrix_export}
 
 \paragraph{\syntax}
@@ -1948,7 +1948,7 @@ \subsubsection{{\sf Matrix\_export}: Export a GraphBLAS matrix to a pre-defined
 
 %-----------------------------------------------------------------------------
 
-\subsubsection{{\sf Matrix\_import}: Import a matrix into a GraphBLAS object \ben{NEW CONTENT}}
+\subsubsection{{\sf Matrix\_import}: Import a matrix into a GraphBLAS object}
 \label{Sec:Matrix_import}
 
 \paragraph{\syntax}
@@ -2038,7 +2038,7 @@ \subsubsection{{\sf Matrix\_import}: Import a matrix into a GraphBLAS object \be
 
 %-----------------------------------------------------------------------------
 
-\subsubsection{{\sf Matrix\_serializeSize}: Compute the serialize buffer size\ben{NEW CONTENT}}
+\subsubsection{{\sf Matrix\_serializeSize}: Compute the serialize buffer size}
 \label{Sec:Matrix_serializeSize}
 
 Compute the buffer size (in bytes) necessary to serialize a {\sf GrB\_Matrix} using {\sf GrB\_Matrix\_serialize}.
@@ -2078,7 +2078,7 @@ \subsubsection{{\sf Matrix\_serializeSize}: Compute the serialize buffer size\be
 
 %-----------------------------------------------------------------------------
 
-\subsubsection{{\sf Matrix\_serialize}: Serialize a GraphBLAS matrix. \ben{NEW CONTENT}}
+\subsubsection{{\sf Matrix\_serialize}: Serialize a GraphBLAS matrix.}
 \label{Sec:Matrix_serialize}
 
 Serialize a GraphBLAS Matrix object into an opaque stream of bytes.
@@ -2140,7 +2140,7 @@ \subsubsection{{\sf Matrix\_serialize}: Serialize a GraphBLAS matrix. \ben{NEW C
 
 %-----------------------------------------------------------------------------
 
-\subsubsection{{\sf Matrix\_deserialize}: Deserialize a GraphBLAS matrix. \ben{NEW CONTENT}}
+\subsubsection{{\sf Matrix\_deserialize}: Deserialize a GraphBLAS matrix.}
 \label{Sec:Matrix_deserialize}
 
 Construct a new GraphBLAS matrix from a serialized object.
