Changeset 1426 for trunk/psLib/src/math/psMatrix.h

Timestamp:

Aug 9, 2004, 12:44:25 PM (22 years ago)

Author:

desonia

Message:

fixed some stupid indent-induced formating problems and added doxygen
comments.

File:

• trunk/psLib/src/math/psMatrix.h (modified) (10 diffs)

trunk/psLib/src/math/psMatrix.h

@@ -22 +22 @@
  *  @author Ross Harman, MHPCC
  *
- *  @version $Revision: 1.7 $ $Name: not supported by cvs2svn $
- *  @date $Date: 2004-08-07 00:06:06 $
+ *  @version $Revision: 1.8 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2004-08-09 22:44:25 $
  *
  *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
@@ -43 +43 @@
  *  @return  psImage*: Pointer to LU decomposed psImage.
  */
-psImage *psMatrixLUD(psImage * outImage,        // /< Image to return, or NULL.
-                     psVector * outPerm,        // /< Output permutation vector used by psMatrixLUSolve.
-                     psImage * inImage  // /< Image to decompose.
+psImage *psMatrixLUD(psImage * outImage,        ///< Image to return, or NULL.
+                     psVector * outPerm,        ///< Output permutation vector used by psMatrixLUSolve.
+                     psImage * inImage  ///< Image to decompose.
                     );
 
@@ -57 +57 @@
  *  @return  psVector*: Pointer to psVector solution of matrix equation.
  */
-psVector *psMatrixLUSolve(psVector * outVector, // /< Vector to return, or NULL.
-                          const psImage * luImage,      // /< LU-decomposed matrix.
-                          const psVector * inVector,    // /< Vector right-hand-side of equation.
-                          const psVector * inPerm       // /< Permutation vector resulting from psMatrixLUD
+psVector *psMatrixLUSolve(psVector * outVector, ///< Vector to return, or NULL.
+                          const psImage * luImage,      ///< LU-decomposed matrix.
+                          const psVector * inVector,    ///< Vector right-hand-side of equation.
+                          const psVector * inPerm       ///< Permutation vector resulting from psMatrixLUD
                           // function.
                          );
@@ -73 +73 @@
  *  @return  psImage*: Pointer to inverted psImage.
  */
-psImage *psMatrixInvert(psImage * outImage,     // /< Image to return, or NULL for in-place substitution.
-                        const psImage * inImage,        // /< Image to be inverted
-                        float *restrict det     // /< Determinant to return, or NULL
+psImage *psMatrixInvert(psImage * outImage,     ///< Image to return, or NULL for in-place substitution.
+                        const psImage * inImage,        ///< Image to be inverted
+                        float *restrict det     ///< Determinant to return, or NULL
                        );
 
@@ -86 +86 @@
  *  @return  float: Determinant from psImage.
  */
-float *psMatrixDeterminant(const psImage * restrict inMatrix    // /< Image used to calculate determinant.
+float *psMatrixDeterminant(const psImage * restrict inMatrix    ///< Image used to calculate determinant.
                           );
 
@@ -98 +98 @@
  *  @return  psImage*: Pointer to resulting psImage.
  */
-psImage *psMatrixMultiply(psImage * outImage,   // /< Matrix to return, or NULL.
-                          psImage * inImage1,   // /< First input image.
-                          psImage * inImage2    // /< Second input image.
+psImage *psMatrixMultiply(psImage * outImage,   ///< Matrix to return, or NULL.
+                          psImage * inImage1,   ///< First input image.
+                          psImage * inImage2    ///< Second input image.
                          );
 
@@ -112 +112 @@
  *  @return  psImage*: Pointer to transposed psImage.
  */
-psImage *psMatrixTranspose(psImage * outImage,  // /< Image to return, or NULL
-                           const psImage * inImage      // /< Image to transpose
+psImage *psMatrixTranspose(psImage * outImage,  ///< Image to return, or NULL
+                           const psImage * inImage      ///< Image to transpose
                           );
 
@@ -124 +124 @@
  *  @return  psImage*: Pointer to matrix of Eigenvectors.
  */
-psImage *psMatrixEigenvectors(psImage * outImage,       // /< Eigenvectors to return, or NULL.
-                              psImage * inImage // /< Input image.
+psImage *psMatrixEigenvectors(psImage * outImage,       ///< Eigenvectors to return, or NULL.
+                              psImage * inImage ///< Input image.
                              );
 
@@ -137 +137 @@
  *  @return  psVector*: Pointer to psVector.
  */
-psVector *psMatrixToVector(psVector * outVector,        // /< Vector to return, or NULL.
-                           psImage * inImage    // /< Image to convert.
+psVector *psMatrixToVector(psVector * outVector,        ///< Vector to return, or NULL.
+                           psImage * inImage    ///< Image to convert.
                           );
 
@@ -150 +150 @@
  *  @return  psVector*: Pointer to psIamge.
  */
-psImage *psVectorToMatrix(psImage * outImage,   // /< Matrix to return, or NULL.
-                          psVector * inVector   // /< Vector to convert.
+psImage *psVectorToMatrix(psImage * outImage,   ///< Matrix to return, or NULL.
+                          psVector * inVector   ///< Vector to convert.
                          );