fix documentation

Signed-off-by: Steven Hahn <[email protected]>

Author: quantumsteve

resolve/matrix/MatrixHandlerCpu.cpp

@@ -421,7 +421,7 @@ namespace ReSolve
    */
   static int updateMatrix(matrix::Sparse* A, index_type* row_data, index_type* col_data, real_type* val_data, index_type nnz)
   {
-    if (A->destroyMatrixData(memory::HOST) == -1)
+    if (A->destroyMatrixData(memory::HOST) != 0)
     {
       return 1;
     }
@@ -502,7 +502,8 @@ namespace ReSolve
    */
   int MatrixHandlerCpu::scaleAddI(matrix::Csr* A, real_type alpha)
   {
-    if (index_type info = scaleConst(A, alpha), info == 1)
+    index_type info = scaleConst(A, alpha);
+    if (info == 1)
     {
       return info;
     }

resolve/workspace/LinAlgWorkspaceCpu.cpp

@@ -19,11 +19,21 @@ namespace ReSolve
   {
   }
 
+  /**
+   * @brief Retrieve row sparsity pattern
+   *
+   * @return precalculated row pointers
+   */
   index_type* ScaleAddIBuffer::getRowData()
   {
     return row_data_.data();
   }
 
+  /**
+   * @brief Retrieve column sparsity pattern
+   *
+   * @return precalculated column indices
+   */
   index_type* ScaleAddIBuffer::getColumnData()
   {
     return col_data_.data();

tests/unit/matrix/MatrixHandlerTests.hpp

@@ -705,9 +705,10 @@ namespace ReSolve
        * @pre A is a valid, allocated CSR matrix
        * @invariant A
        * @param[in] A matrix::Csr* pointer to the matrix to be verified
+       * @param[in] alpha matrix scale factor
        * @return bool true if the matrix is valid, false otherwise
        */
-      bool verifyScaleAddICsrMatrix(matrix::Csr* A, real_type scale)
+      bool verifyScaleAddICsrMatrix(matrix::Csr* A, real_type alpha)
       {
         // Check if the matrix is valid
         if (A == nullptr)
@@ -727,7 +728,7 @@ namespace ReSolve
         index_type* scaled_row_ptr  = A->getRowData(memory::HOST);
         real_type*  scaled_value    = A->getValues(memory::HOST);
 
-        const real_type expected = 30. * scale + 1.;
+        const real_type expected = 30. * alpha + 1.;
 
         // Verify values - each element scaled by scale. Diagonal elements should be  1.
         for (index_type i = 0; i < n; ++i)