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

Timestamp:

Aug 10, 2004, 4:37:55 PM (22 years ago)

Author:

desonia

Message:

doxygen cleanup.

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.10 $ $Name: not supported by cvs2svn $
- *  @date $Date: 2004-08-09 23:40:55 $
+ *  @version $Revision: 1.11 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2004-08-11 02:35:58 $
  *
  *  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.
+);
 
 /** LU Solution of psImage matrix.
@@ -57 +58 @@
  *  @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
-                          // function.
-                         );
+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.
+);
 
 /** Invert psImage matrix.
@@ -73 +74 @@
  *  @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
+);
 
 /** Calculate psImage matrix determinant.
@@ -86 +88 @@
  *  @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.
+);
 
 /** Performs psImage matrix multiplication.
@@ -98 +101 @@
  *  @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.
+);
 
 /** Transpose matrix.
@@ -112 +116 @@
  *  @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
+);
 
 /** Calculate matrix eigenvectors.
@@ -124 +129 @@
  *  @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.
+);
 
 /** Convert matrix to vector.
@@ -137 +143 @@
  *  @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.
+);
 
 /** Convert vector to matrix.
@@ -150 +157 @@
  *  @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.
+);
 
 /// @}