Changeset 799 for trunk/psLib/src/dataManip/psMatrix.h

Timestamp:

May 27, 2004, 4:53:27 PM (22 years ago)

Author:

harman

Message:

Added to psMatrix functionality

File:

• trunk/psLib/src/dataManip/psMatrix.h (modified) (6 diffs)

trunk/psLib/src/dataManip/psMatrix.h

@@ -21 +21 @@
  *  @author Ross Harman, MHPCC
  *   
- *  @version $Revision: 1.2 $ $Name: not supported by cvs2svn $
- *  @date $Date: 2004-05-24 21:10:03 $
+ *  @version $Revision: 1.3 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2004-05-28 02:53:27 $
  *
  *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
@@ -49 +49 @@
  *
  *  Performs a LU decomposition on a psImage matrix and returns the LU matrix. If the user specifies NULL as the 
- *  outImage argument, then the decomposition is done in-place and inImage will hold the inverted image. The input
- *  image must be square. This function operates only with psF32 and psF64 data types.
+ *  outImage argument, then the output argument will be created based on input values. The input image must 
+ *  be square. This function operates only with the psF32 data type.
  *
  *  @return  psImage*: Pointer to LU decomposed psImage.
@@ -102 +102 @@
 /** Performs basic psImage matrix operations.
  *
- *  Performs psImage matrix operations for: addition, subtraction, multiplication. For addition, each element
- *  of the input image is added to the corresponding element of the output matrix. Subtraction works in a 
- *  similar manner. For multiplication, the function performs a classical matrix multiplication involving row 
- *  and column operations. For matrix multiplication, the number of columns must match the number of rows for
- *  inImage1 and inImage2, respectively. Matrix division is not defined for this function. If the user 
- *  specifies NULL as the outImage argument, then a new psImage will be created and returned. This function 
- *  operates only with psF32 and psF64 data types.  
+ *  Performs a classical matrix multiplication involving row and column operations. This function assumes both
+ *  matrices are the same size. If the user specifies NULL as the outImage argument, then a new psImage will be 
+ *  created and returned. This function operates only with the psF64 data type. GSL indexes the top row as the
+ *  zero row, not the bottom.  
  *
  *  @return  psImage*: Pointer to resulting psImage.
  */
-psImage *psMatrixOp(
+psImage *psMatrixMultiply(
     psImage *outImage,  ///< Matrix to return, or NULL.
     psImage *inImage1,  ///< First input image.
-    const char op,      ///< Operation to perform: "+", "-", "*".
     psImage *inImage2   ///< Second input image.
 );
@@ -134 +130 @@
 /** Calculate matrix eigenvectors.
  *
- *  Calculates the eigenvectors for a matrix. The input image must be square. If the user specifies NULL as 
+ *  Calculates the eigenvectors for a matrix. The input image must be symmetric. If the user specifies NULL as
  *  the outImage argument, then a new psImage will be created and returned. This function operates only with 
- *  psF32 and psF64 data types.
+ *  the psF64 data type.
  *
  *  @return  psImage*: Pointer to matrix of Eigenvectors.
  */
 psImage *psMatrixEigenvectors(
-    psImage *outImage, ///< Eigenvectors to return, or NULL.
+    psImage *outImage,  ///< Eigenvectors to return, or NULL.
     psImage *inImage    ///< Input image.
 );
@@ -147 +143 @@
 /** Convert matrix to vector.
  *
- *  Converts a 1-d matrix into a vector. If the user specifies NULL as the outVector argument, then a new psImage will be created
- *  and returned. This function operates only with psF32 and psF64 data types.  
+ *  Converts a 1-d psImage matrix into a vector. If the user specifies NULL as the outVector argument, then a 
+ *  new psVector will be created. The input matrix must be a 1-d column matrix. This function operates only with
+ *  the psF64 data type
  *
  *  @return  psVector*: Pointer to psVector.
@@ -159 +156 @@
 /** Convert vector to matrix.
  *
- *  Converts a vector to a 1-d psImage matrix into a vector. If the user specifies NULL as the outImage 
- *  argument, then a new psImage will be created and returned. This function operates only with psF32 and 
- *  psF64 data types.  
+ *  Converts a vector into a 1-d column psImage matrix. If the user specifies NULL as the outImage argument, 
+ *  then a new psImage will be created. This function operates only with the psF64 data type.  
  *
  *  @return  psVector*: Pointer to psIamge.