Changeset 372 for trunk/SRC/Matrix

Timestamp:

08/08/08 14:31:53 (16 years ago)

Author:

pinsard

Message:

improvements of headers (alignments)

Location:

trunk/SRC/Matrix

Files:

• cmset_op.pro (modified) (1 diff)
• different.pro (modified) (1 diff)
• extrac2.pro (modified) (4 diffs)
• make_selection.pro (modified) (1 diff)
• union.pro (modified) (1 diff)

trunk/SRC/Matrix/cmset_op.pro

@@ -7 +7 @@
 ; "first" value, whatever that may mean.
 ;
-; @todo seb
+; @todo
+; seb
 ;
 ;-

trunk/SRC/Matrix/different.pro

@@ -9 +9 @@
 ; @param a {in}{required}
 ; arrays of positive integers, which need
-;               not be sorted. Duplicate elements are ignored, as they have no
-;               effect on the result
+; not be sorted. Duplicate elements are ignored, as they have no
+; effect on the result
 ;
 ; @param b {in}{required}

trunk/SRC/Matrix/extrac2.pro

@@ -37 +37 @@
 ; @param index1 {in}{required}
 ; can have 2 forms:
-; 1)a vector containing indexes of lines we want to keep
-; 2)the string '*' if we want to keep all lines.
+;
+;  1) a vector containing indexes of lines we want to keep
+;  2) the string '*' if we want to keep all lines.
 ;
 ; @param index2 {in}{required}
@@ -50 +51 @@
 ;
 ; @returns
-; a matrix 1,2,3 or 4d extract from input array
+; a matrix 1d, 2d, 3d or 4d extract from input array
 ; -1 in case of mistake
 ;
@@ -62 +63 @@
 ;
 ; other ex:
+;   IDL> a=[['a','b','c'],['d','e','f'],['g','h','i']]
 ;   IDL> print, a
 ; a b c
@@ -72 +74 @@
 ; @history
 ; Sebastien Masson (smasson\@lodyc.jussieu.fr)
-;                       12/1/1999
-;                       29/4/1999: correction of a bug and complement of the heading
+;  - 12/1/1999
+;  - 29/4/1999: correction of a bug and complement of the heading
 ;
 ; @version

trunk/SRC/Matrix/make_selection.pro

@@ -47 +47 @@
 ;
 ; @examples
-;           names = [ 'Alfred','Anton','Peter','John','Mary']
-;           index = MAKE_SELECTION(names,['Peter','Mary'])
-;           print,index
-;           ; prints  2  4
 ;
-;           vals = indgen(20)
-;           index = MAKE_SELECTION(vals,[9,-5,8,7,7,8,9])
-;           print,index
-;           ; prints  9  -1  8  7  7  8  9
+;   IDL> names = [ 'Alfred','Anton','Peter','John','Mary']
+;   IDL> index = MAKE_SELECTION(names,['Peter','Mary'])
+;   IDL> print,index
+;   2  4
 ;
-;           index = MAKE_SELECTION(vals,[9,-5,8,7,7,8,9],/ONLY_VALID)
-;           print,index
-;           ; prints  9  8  7  7  8  9
+;   IDL> vals = indgen(20)
+;   IDL> index = MAKE_SELECTION(vals,[9,-5,8,7,7,8,9])
+;   IDL> print,index
+;   9  -1  8  7  7  8  9
 ;
-;           index = MAKE_SELECTION(vals,[9,-5,8,7,7,8,9],/REQUIRED)
-;           print,index
-;           ; prints  -1
+;   IDL> index = MAKE_SELECTION(vals,[9,-5,8,7,7,8,9],/ONLY_VALID)
+;   IDL> print,index
+;   9  8  7  7  8  9
+;
+;   IDL> index = MAKE_SELECTION(vals,[9,-5,8,7,7,8,9],/REQUIRED)
+;   IDL> print,index
+;   -1
+;
+;   IDL> index = MAKE_SELECTION(vals,[9,-5,8,7,7,8,9],/REQUIRED,/QUIET)
+;   % MAKE_SELECTION: Selected name not found in names array (-5)!
+;   IDL> print,index
+;   -1
 ;
 ; @history

trunk/SRC/Matrix/union.pro

@@ -9 +9 @@
 ; @param a {in}{required}
 ; arrays of positive integers, which need
-;               not be sorted. Duplicate elements are ignored, as they have no
-;               effect on the result
+; not be sorted. Duplicate elements are ignored, as they have no
+; effect on the result
 ;
 ; @param b {in}{required}