IPP Software Navigation Tools IPP Links Communication Pan-STARRS Links

Ignore:
Timestamp:
May 28, 2004, 10:52:41 AM (22 years ago)
Author:
harman
Message:

Updated Doxygen comments to express GSL limitations

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/psLib/src/dataManip/psMatrix.h

    r799 r807  
    2121 *  @author Ross Harman, MHPCC
    2222 *   
    23  *  @version $Revision: 1.3 $ $Name: not supported by cvs2svn $
    24  *  @date $Date: 2004-05-28 02:53:27 $
     23 *  @version $Revision: 1.4 $ $Name: not supported by cvs2svn $
     24 *  @date $Date: 2004-05-28 20:52:41 $
    2525 *
    2626 *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
    … …  
    4848/** LU Decomposition of psImage matrix.
    4949 *
    50  *  Performs a LU decomposition on a psImage matrix and returns the LU matrix. If the user specifies NULL as the
    51  *  outImage argument, then the output argument will be created based on input values. The input image must
    52  *  be square. This function operates only with the psF32 data type.
     50 *  Performs a LU decomposition on a psImage matrix and returns the LU matrix. If the user specifies NULL for
     51 *  the outImage or outPerm arguments, then they will be automatically created. The input image must
     52 *  be square. This function operates only with the psF64 data type. Input and output arguments should not be
     53 *  the same. GSL indexes the top row as the zero row, not the bottom. 
    5354 *
    5455 *  @return  psImage*: Pointer to LU decomposed psImage.
    … …  
    6364 *
    6465 *  Solves for and returns the psVector, {x} in the equation [A]{x} = {b}. If the user specifies NULL as the
    65  *  outVector argument, then the solution for {x} is done in-place and inVector will hold the modified values.
    66  *  The input image must be square. This function operates only with psF32 and psF64 data types.
     66 *  outVector argument, then it will automatically be created. The input image must be square. This function
     67 *  operates only with the psF64 data type. Input and output arguments should not be the same. GSL indexes
     68 *  the top row as the zero row, not the bottom. 
    6769 *
    6870 *  @return  psVector*: Pointer to psVector solution of matrix equation.
    … …  
    7880 *
    7981 *  Inverts a psImage matrix and returns the determinant as an option through the argument list. If the user
    80  *  specifies NULL as the outImage argument, then the inversion is done in-place and inImage will hold the
    81  *  inverted image. The input image must be square. This function operates only with psF32 and psF64 data types.
     82 *  specifies NULL as the outImage argument, then it will automatically be created. The input image must be
     83 *  square. This function operates only with the psF64 data type. Input and output arguments should not be
     84 *  the same. GSL indexes the top row as the zero row, not the bottom. 
    8285 *
    8386 *  @return  psImage*: Pointer to inverted psImage.
    … …  
    9194/** Calculate psImage matrix determinant.
    9295 *
    93  *  Calculates the determinant of a psImage matrix and returns the floating point determinant. The input
    94  *  image must be square. This function operates only with psF32 and psF64 data types.
     96 *  Calculates the determinant of a psImage matrix and returns the single precision floating point result. The
     97 *  input image must be square. This function operates only with the psF64 data type. GSL indexes the top row
     98 *  as the zero row, not the bottom. 
    9599 *
    96100 *  @return  float: Determinant from psImage.
    … …  
    100104);
    101105
    102 /** Performs basic psImage matrix operations.
     106/** Performs psImage matrix multiplication.
    103107 *
    104  *  Performs a classical matrix multiplication involving row and column operations. This function assumes both
    105  *  matrices are the same size. If the user specifies NULL as the outImage argument, then a new psImage will be
    106  *  created and returned. This function operates only with the psF64 data type. GSL indexes the top row as the
     108 *  Performs a classical matrix multiplication involving row and column operations. Input images must be square
     109 *  and the same size. If the user specifies NULL as the outImage argument, then it will automatically be
     110 *  created. This function operates only with the psF64 data type. GSL indexes the top row as the
    107111 *  zero row, not the bottom. 
    108112 *
    … …  
    118122 *
    119123 *  Performs psImage matrix transpose by substituting existing rows for columns. The input image must be
    120  *  square. If the user specifies NULL as the outImage argument, then a new psImage will be created
    121  *  and returned. This function operates only with psF32 and psF64 data types.
     124 *  square. If the user specifies NULL as the outImage argument, then it will automaticallty be created.
     125 *  This function operates only with the psF64 data type. GSL indexes the top row as the zero
     126 *  row, not the bottom. 
    122127 *
    123128 *  @return  psImage*: Pointer to transposed psImage.
    … …  
    130135/** Calculate matrix eigenvectors.
    131136 *
    132  *  Calculates the eigenvectors for a matrix. The input image must be symmetric. If the user specifies NULL as
    133  *  the outImage argument, then a new psImage will be created and returned. This function operates only with
    134  *  the psF64 data type.
     137 *  Calculates the eigenvectors for a matrix. The input image must be symmetric and square. If the user
     138 *  specifies NULL as the outImage argument, then it will automatically be created. This function operates
     139 *  only with the psF64 data type. GSL indexes the top row as the zero row, not the bottom. 
    135140 *
    136141 *  @return  psImage*: Pointer to matrix of Eigenvectors.
    … …  
    143148/** Convert matrix to vector.
    144149 *
    145  *  Converts a 1-d psImage matrix into a vector. If the user specifies NULL as the outVector argument, then a
    146  *  new psVector will be created. The input matrix must be a 1-d column matrix. This function operates only with
    147  *  the psF64 data type
     150 *  Converts a 1-d psImage matrix into a vector. If the user specifies NULL as the outVector argument, then it
     151 *  will automatically be created. The input matrix must be a 1-d column matrix. This function operates only
     152 *  with the psF64 data type.
    148153 *
    149154 *  @return  psVector*: Pointer to psVector.
    … …  
    157162 *
    158163 *  Converts a vector into a 1-d column psImage matrix. If the user specifies NULL as the outImage argument,
    159  *  then a new psImage will be created. This function operates only with the psF64 data type. 
     164 *  then it will automatically be created. This function operates only with the psF64 data type. 
    160165 *
    161166 *  @return  psVector*: Pointer to psIamge.
Note: See TracChangeset for help on using the changeset viewer.