Changeset 136 for trunk/SRC/Matrix/cmapply.pro

Timestamp:

07/10/06 17:20:19 (18 years ago)

Author:

pinsard

Message:

some improvements and corrections in some .pro file according to
aspell and idldoc log file

File:

• trunk/SRC/Matrix/cmapply.pro (modified) (12 diffs)

trunk/SRC/Matrix/cmapply.pro

@@ -1 @@
-;; Utility function, adapted from CMPRODUCT
 ;+
+; @file_comments
+; Utility function, adapted from CMPRODUCT
+;
+; @version $Id$
+;
 ; @todo seb
 ;-
@@ -20 +24 @@
 end
 
-;; Utility function, used to collect collaped dimensions
 ;+
+; @file_comments
+; cmapply_redim : Utility function, used to collect collaped dimensions
+;
 ; @todo seb
 ;-
@@ -53 +59 @@
 ;+
 ;
-; @file_comments 
+; @file_comments
 ; Applies a function to specified dimensions of an array
 ;
-;   Description:
-;
-;      CMAPPLY will apply one of a few select functions to specified 
-;   dimensions of an array.  Unlike some IDL functions, you *do* have
-;   a choice of which dimensions that are to be "collapsed" by this
-;   function.  Iterative loops are avoided where possible, for 
-;   performance reasons.
+; Description:
+;
+; CMAPPLY will apply one of a few select functions to specified
+; dimensions of an array.  Unlike some IDL functions, you *do* have
+; a choice of which dimensions that are to be "collapsed" by this
+; function.  Iterative loops are avoided where possible, for
+; performance reasons.
 ;
 ;   The possible functions are:             (and number of loop iterations:)
@@ -102 +108 @@
 ; @categories Arrays
 ;
-; @param OP {in}{required} The operation to perform, as a string.  May be upper or lower
-;        case.
-;
-;        If a user-defined operation is to be passed, then OP is of
-;        the form, 'USER:FUNCTNAME', where FUNCTNAME is the name of
-;        the user-defined function.
-;
-; @param ARRAY {in}{required} An array of values to be operated on.  Must not be of type
-;           STRING (7) or STRUCTURE (8).
-;
-; @param DIMS {in}{optional}{default=1 (ie, first dimension)} 
-;          An array of dimensions that are to be "collapsed", where
-;          the the first dimension starts with 1 (ie, same convention
-;          as IDL function TOTAL).  Whereas TOTAL only allows one
-;          dimension to be added, you can specify multiple dimensions
-;          to CMAPPLY.  Order does not matter, since all operations
-;          are associative and transitive.  NOTE: the dimensions refer
-;          to the *input* array, not the output array.  IDL allows a 
-;          maximum of 8 dimensions.
-;          DEFAULT: 1 (ie, first dimension)
-;
-; @keyword DOUBLE Set this if you wish the internal computations to be done
-;            in double precision if necessary.  If ARRAY is double 
-;            precision (real or complex) then DOUBLE=1 is implied.
-;            DEFAULT: not set
-;
-; @keyword TYPE Set this to the IDL code of the desired output type (refer
-;          to documentation of SIZE()).  Internal results will be
-;          rounded to the nearest integer if the output type is an
-;          integer type.
-;          DEFAULT: same is input type
-;
-; @keyword FUNCTARGS If OP is 'USER:...', then the contents of this keyword
-;               are passed to the user function using the _EXTRA
-;               mechanism.  This way you can pass additional data to
-;               your user-supplied function, via keywords, without
-;               using common blocks.
-;               DEFAULT: undefined (i.e., no keywords passed by _EXTRA)
-;
-; @returns An array of the required TYPE, whose elements are the result of
-;   the requested operation.  Depending on the operation and number of
-;   elements in the input array, the result may be vulnerable to
-;   overflow or underflow.
-;
-; @examples 
-;   
+; @param OP {in}{required}
+; The operation to perform, as a string.  May be upper or lower case.
+;
+; If a user-defined operation is to be passed, then OP is of
+; the form, 'USER:FUNCTNAME', where FUNCTNAME is the name of
+; the user-defined function.
+;
+; @param ARRAY {in}{required}
+; An array of values to be operated on.
+; Must not be of type STRING (7) or STRUCTURE (8).
+;
+; @param dimapply {in}{optional}{default=1 (ie, first dimension)}
+; An array of dimensions that are to be "collapsed", where
+; the the first dimension starts with 1 (ie, same convention
+; as IDL function TOTAL).  Whereas TOTAL only allows one
+; dimension to be added, you can specify multiple dimensions
+; to CMAPPLY.  Order does not matter, since all operations
+; are associative and transitive.  NOTE: the dimensions refer
+; to the *input* array, not the output array.  IDL allows a
+; maximum of 8 dimensions.
+;
+; @keyword DOUBLE {default=not set}
+; Set this if you wish the internal computations to be done
+; in double precision if necessary.  If ARRAY is double
+; precision (real or complex) then DOUBLE=1 is implied.
+;
+; @keyword TYPE
+; Set this to the IDL code of the desired output type (refer
+; to documentation of SIZE()).  Internal results will be
+; rounded to the nearest integer if the output type is an
+; integer type.
+; DEFAULT: same is input type
+;
+; @keyword FUNCTARGS
+; If OP is 'USER:...', then the contents of this keyword
+; are passed to the user function using the _EXTRA
+; mechanism.  This way you can pass additional data to
+; your user-supplied function, via keywords, without
+; using common blocks.
+; DEFAULT: undefined (i.e., no keywords passed by _EXTRA)
+;
+; @returns
+; An array of the required TYPE, whose elements are the result of
+; the requested operation.  Depending on the operation and number of
+; elements in the input array, the result may be vulnerable to
+; overflow or underflow.
+;
+; @examples
+;
 ;   First example:  Shows how CMAPPLY can be used to total the second dimension of the
 ;   array called IN.  This is equivalent to OUT = TOTAL(IN, 2)
@@ -190 +199 @@
 ;   Changed usage message to not bomb, 24 Mar 2000, CM
 ;   Signficant rewrite for *, MIN and MAX (inspired by Todd Clements
-;     <Todd_Clements@alumni.hmc.edu>); FOR loop indices are now type
+;     <Todd_Clements\@alumni.hmc.edu>); FOR loop indices are now type
 ;     LONG; copying terms are liberalized, CM, 22, Aug 2000
 ;   More efficient MAX/MIN (inspired by Alex Schuster), CM, 25 Jan
@@ -199 +208 @@
 ;
 ;  Author: Craig B. Markwardt, NASA/GSFC Code 662, Greenbelt, MD 20770
-;  craigm@lheamail.gsfc.nasa.gov
+;  craigm\@lheamail.gsfc.nasa.gov
 ;
 ; @version $Id$
@@ -293 +302 @@
               if newop EQ 'MIN' then return, min(newarr)
           endif
-          
+
           ;; Next task: create result array
           result = make_array(totkeep, type=type)
-          
+
           ;; Now either iterate over the number of output elements, or
           ;; the number of collapsed elements, whichever is smaller.
@@ -302 +311 @@
               ;; Iterate over the number of collapsed elements
               result[0] = reform(newarr[0,*],totkeep,/overwrite)
-              case newop of 
+              case newop of
                   'MAX': for i = 1L, totcol-1 do $
                     result[0] = result > newarr[i,*]
@@ -310 +319 @@
           endif else begin
               ;; Iterate over the number of output elements
-              case newop of 
+              case newop of
                   'MAX': for i = 0L, totkeep-1 do result[i] = max(newarr[*,i])
                   'MIN': for i = 0L, totkeep-1 do result[i] = min(newarr[*,i])
@@ -332 +341 @@
               return, call_function(functname, newarr)
           endif
-          
+
           ;; Next task: create result array
           result = make_array(totkeep, type=type)
-          
+
           ;; Iterate over the number of output elements
           if n_elements(functargs) GT 0 then begin
@@ -349 +358 @@
       end
 
-              
+
   endcase
 
@@ -363 +372 @@
     return, call_function(castfns[type], newarr)
 end
-