Browse Source

sparse/*.c, rename `eMatrix' --> `Matrix' (comments)

pre-master-46
rlar 13 years ago
parent
commit
075b30d686
  1. 10
      src/maths/sparse/spalloc.c
  2. 24
      src/maths/sparse/sputils.c

10
src/maths/sparse/spalloc.c

@ -701,7 +701,7 @@ spDestroy(MatrixPtr Matrix)
* The error status of the given matrix. * The error status of the given matrix.
* *
* >>> Arguments: * >>> Arguments:
* eMatrix <input> (void *)
* Matrix <input> (void *)
* The matrix for which the error status is desired. */ * The matrix for which the error status is desired. */
int int
spError(MatrixPtr Matrix ) spError(MatrixPtr Matrix )
@ -732,7 +732,7 @@ spError(MatrixPtr Matrix )
* detected as singular or where a zero was detected on the diagonal. * detected as singular or where a zero was detected on the diagonal.
* *
* >>> Arguments: * >>> Arguments:
* eMatrix <input> (void *)
* Matrix <input> (void *)
* The matrix for which the error status is desired. * The matrix for which the error status is desired.
* pRow <output> (int *) * pRow <output> (int *)
* The row number. * The row number.
@ -769,7 +769,7 @@ spWhereSingular(MatrixPtr Matrix, int *pRow, int *pCol)
* the matrix is returned. * the matrix is returned.
* *
* >>> Arguments: * >>> Arguments:
* eMatrix <input> (void *)
* Matrix <input> (void *)
* Pointer to matrix. * Pointer to matrix.
* External <input> (int) * External <input> (int)
* If External is set TRUE, the external size , i.e., the value of the * If External is set TRUE, the external size , i.e., the value of the
@ -809,7 +809,7 @@ spGetSize(MatrixPtr Matrix, int External)
* Forces matrix to be either real or complex. * Forces matrix to be either real or complex.
* *
* >>> Arguments: * >>> Arguments:
* eMatrix <input> (void *)
* Matrix <input> (void *)
* Pointer to matrix. * Pointer to matrix.
*/ */
@ -850,7 +850,7 @@ spSetComplex(MatrixPtr Matrix)
* of original elements can be returned. * of original elements can be returned.
* *
* >>> Arguments: * >>> Arguments:
* eMatrix <input> (void *)
* Matrix <input> (void *)
* Pointer to matrix. * Pointer to matrix.
*/ */

24
src/maths/sparse/sputils.c

@ -151,7 +151,7 @@ static void ComplexTransposedMatrixMultiply( MatrixPtr, RealVector, RealVector,
* Tom Quarles. * Tom Quarles.
* *
* >>> Arguments: * >>> Arguments:
* eMatrix <input> (char *)
* Matrix <input> (char *)
* Pointer to the matrix to be preordered. * Pointer to the matrix to be preordered.
* *
* >>> Local variables; * >>> Local variables;
@ -346,7 +346,7 @@ SwapCols( MatrixPtr Matrix, ElementPtr pTwin1, ElementPtr pTwin2 )
* should not be executed before the function spMNA_Preorder. * should not be executed before the function spMNA_Preorder.
* *
* >>> Arguments: * >>> Arguments:
* eMatrix <input> (char *)
* Matrix <input> (char *)
* Pointer to the matrix to be scaled. * Pointer to the matrix to be scaled.
* SolutionScaleFactors <input> (RealVector) * SolutionScaleFactors <input> (RealVector)
* The array of Solution scale factors. These factors scale the columns. * The array of Solution scale factors. These factors scale the columns.
@ -556,7 +556,7 @@ MatrixPtr Matrix;
* before spMNA_Preorder(). * before spMNA_Preorder().
* *
* >>> Arguments: * >>> Arguments:
* eMatrix <input> (char *)
* Matrix <input> (char *)
* Pointer to the matrix. * Pointer to the matrix.
* RHS <output> (RealVector) * RHS <output> (RealVector)
* RHS is the right hand side. This is what is being solved for. * RHS is the right hand side. This is what is being solved for.
@ -702,7 +702,7 @@ ComplexMatrixMultiply( MatrixPtr Matrix, RealVector RHS, RealVector Solution , R
* before spMNA_Preorder(). * before spMNA_Preorder().
* *
* >>> Arguments: * >>> Arguments:
* eMatrix <input> (char *)
* Matrix <input> (char *)
* Pointer to the matrix. * Pointer to the matrix.
* RHS <output> (RealVector) * RHS <output> (RealVector)
* RHS is the right hand side. This is what is being solved for. * RHS is the right hand side. This is what is being solved for.
@ -854,7 +854,7 @@ ComplexTransposedMatrixMultiply( MatrixPtr Matrix, RealVector RHS, RealVector So
* reasonable value and the logarithm of the scale factor is returned. * reasonable value and the logarithm of the scale factor is returned.
* *
* >>> Arguments: * >>> Arguments:
* eMatrix <input> (char *)
* Matrix <input> (char *)
* A pointer to the matrix for which the determinant is desired. * A pointer to the matrix for which the determinant is desired.
* pExponent <output> (int *) * pExponent <output> (int *)
* The logarithm base 10 of the scale factor for the determinant. To find * The logarithm base 10 of the scale factor for the determinant. To find
@ -1171,7 +1171,7 @@ spStripMatrix(MatrixPtr Matrix)
* doesn't exist. * doesn't exist.
* *
* >>> Arguments: * >>> Arguments:
* eMatrix <input> (char *)
* Matrix <input> (char *)
* Pointer to the matrix in which the row and column are to be deleted. * Pointer to the matrix in which the row and column are to be deleted.
* Row <input> (int) * Row <input> (int)
* Row to be deleted. * Row to be deleted.
@ -1306,7 +1306,7 @@ spDeleteRowAndCol(MatrixPtr Matrix, int Row, int Col)
* previous factorization. If the matrix was singular, zero is returned. * previous factorization. If the matrix was singular, zero is returned.
* *
* >>> Arguments: * >>> Arguments:
* eMatrix <input> (char *)
* Matrix <input> (char *)
* Pointer to the matrix. */ * Pointer to the matrix. */
RealNumber RealNumber
@ -1388,7 +1388,7 @@ spPseudoCondition(MatrixPtr Matrix)
* zero is returned. * zero is returned.
* *
* >>> Arguments: * >>> Arguments:
* eMatrix <input> (char *)
* Matrix <input> (char *)
* Pointer to the matrix. * Pointer to the matrix.
* NormOfMatrix <input> (RealNumber) * NormOfMatrix <input> (RealNumber)
* The L-infinity norm of the unfactored matrix as computed by * The L-infinity norm of the unfactored matrix as computed by
@ -1824,7 +1824,7 @@ int *pError;
* The largest absolute row sum of matrix. * The largest absolute row sum of matrix.
* *
* >>> Arguments: * >>> Arguments:
* eMatrix <input> (char *)
* Matrix <input> (char *)
* Pointer to the matrix. * Pointer to the matrix.
*/ */
@ -1942,7 +1942,7 @@ spNorm(MatrixPtr Matrix)
* largest element in any of the reduced submatrices is returned. * largest element in any of the reduced submatrices is returned.
* *
* >>> Arguments: * >>> Arguments:
* eMatrix <input> (char *)
* Matrix <input> (char *)
* Pointer to the matrix. * Pointer to the matrix.
*/ */
@ -2066,7 +2066,7 @@ spLargestElement(MatrixPtr Matrix)
* Returns a bound on the magnitude of the largest element in E = A - LU. * Returns a bound on the magnitude of the largest element in E = A - LU.
* *
* >>> Arguments: * >>> Arguments:
* eMatrix <input> (char *)
* Matrix <input> (char *)
* Pointer to the matrix. * Pointer to the matrix.
* Rho <input> (RealNumber) * Rho <input> (RealNumber)
* The bound on the magnitude of the largest element in any of the * The bound on the magnitude of the largest element in any of the
@ -2133,7 +2133,7 @@ spRoundoff(MatrixPtr Matrix, RealNumber Rho)
* error state of sparse. No message is produced if there is no error. * error state of sparse. No message is produced if there is no error.
* *
* >>> Arguments: * >>> Arguments:
* eMatrix <input> (char *)
* Matrix <input> (char *)
* Matrix for which the error message is to be printed. * Matrix for which the error message is to be printed.
* Stream <input> (FILE *) * Stream <input> (FILE *)
* Stream to which the error message is to be printed. * Stream to which the error message is to be printed.

Loading…
Cancel
Save