Changeset 402 for trunk/SRC/Documentation/idldoc_assistant_output/Matrix

Timestamp:

07/23/09 11:18:49 (15 years ago)

Author:

smasson

Message:

update documentation

Location:

trunk/SRC/Documentation/idldoc_assistant_output/Matrix

Files:

• cmset_op.html (modified) (1 diff)
• different.html (modified) (5 diffs)
• extrac2.html (modified) (8 diffs)
• inter.html (modified) (4 diffs)
• make_selection.html (modified) (1 diff)
• union.html (modified) (5 diffs)
• zero_one.html (modified) (4 diffs)

trunk/SRC/Documentation/idldoc_assistant_output/Matrix/cmset_op.html

@@ -360 +360 @@
     
     <h4>Version</h4>
- $Id: cmset_op.pro 325 2007-12-06 10:04:53Z pinsard $
+ $Id: cmset_op.pro 372 2008-08-08 12:31:53Z pinsard $
 
     <h4>History</h4>

trunk/SRC/Documentation/idldoc_assistant_output/Matrix/different.html

@@ -62 +62 @@
 
     
- calculate the different elements of 2 matrix of positive whole numbers.
+ find the different elements of 2 matrixes of positive whole numbers.
+
+ see also <a href="..//Matrix/union.html">union</a> and <a href="..//Matrix/inter.html">inter</a>.
 
 
@@ -80 +82 @@
 
     <h3>Return value</h3>
- tableau
+ an array containing the set of values in only a.
+
+ The empty set is denoted by an array with the first element equal to
+ -1.
 
 
@@ -101 +106 @@
     
  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
 
     
@@ -128 +133 @@
     <h3>Examples</h3><pre>
 
-  IDL> a = [2,4,6,8]
-  IDL> b = [6,1,3,2]
-  IDL> different(a,b) = [ 4, 8]         ; Elements in A but not in B
+   IDL> a = [2,4,6,8]
+   IDL> b = [6,1,3,2]
+
+   IDL> res=different(a,b) 
+              4           8
+ Right because 4 and 8 are in a but not in b !
+
+   IDL> res=different(b,a)
+   IDL> print,res
+              1           3
+
+ Right because 1 and 3 are in b but not in a !
 
     </pre><h3>Version history</h3>
     
     <h4>Version</h4>
- $Id: different.pro 325 2007-12-06 10:04:53Z pinsard $
+ $Id: different.pro 373 2008-08-08 14:11:31Z pinsard $
 
     <h4>History</h4>
@@ -147 +161 @@
     
     <h4>Restrictions</h4>
- The empty set is denoted by an array with the first element equal to
- -1.
-
-
  These functions will not be efficient on sparse sets with wide
  ranges, as they trade memory for efficiency. The HISTOGRAM function

trunk/SRC/Documentation/idldoc_assistant_output/Matrix/extrac2.html

@@ -66 +66 @@
  By default, IDL can make extractions of subdomain:
 
-      IDL> a=indgen(5,5)
-      IDL> print, a
+   IDL> a=indgen(5,5)
+   IDL> print, a
              0       1       2       3       4
              5       6       7       8       9
@@ -73 +73 @@
             15      16      17      18      19
             20      21      22      23      24
-      IDL> print, a[[0,2],3]
+   IDL> print, a[[0,2],3]
             15      17
-      IDL> print, a[[0,2],*]
+   IDL> print, a[[0,2],*]
              0       2
              5       7
@@ -82 +82 @@
             20      22
  but
-      IDL> print, a[[0,2],[3,4]]
+   IDL> print, a[[0,2],[3,4]]
             15      22
  while
-      IDL> print, extrac2(a,[0,2],[3,4])
+   IDL> print, extrac2(a,[0,2],[3,4])
             15      17
             20      22
@@ -105 +105 @@
 
     <h3>Return value</h3>
- 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
 
@@ -126 +126 @@
 
     
- a 1,2,3 or 4 dim input array
+ a 1d, 2d, 3d or 4d input array
 
     
@@ -144 +144 @@
     
  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.
 
     
@@ -204 +205 @@
 
     <h3>Examples</h3><pre>
- I have a dim 2 matrix named A. I want extract a small intersection
- matrix 2d of the line 2,3 and 7 and of the column 0 and 1:
-
- IDL> res=extrac2(A,[2,3,7],[0,1])
+ I have a 2d matrix named A. I want extract a small intersection
+ matrix 2d of the line 2, 3 and 7 and of the column 0 and 1:
+
+   IDL> res=extrac2(A,[2,3,7],[0,1])
 
  other ex:
- IDL> print, a
+   IDL> a=[['a','b','c'],['d','e','f'],['g','h','i']]
+   IDL> print, a
  a b c
  d e f
  g h i
- IDL> print, extrac2(a,[0,2],[0,2])
+   IDL> print, extrac2(a,[0,2],[0,2])
  a c
  g i
@@ -221 +223 @@
     
     <h4>Version</h4>
- $Id: extrac2.pro 325 2007-12-06 10:04:53Z pinsard $
+ $Id: extrac2.pro 373 2008-08-08 14:11:31Z pinsard $
 
     <h4>History</h4>
  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
 
     

trunk/SRC/Documentation/idldoc_assistant_output/Matrix/inter.html

@@ -62 +62 @@
 
     
- calculate the intersection between 2 matrices of whole numbers
+ find the intersection between 2 matrices of whole numbers
+
+ see also <a href="..//Matrix/different.html">different</a> and <a href="..//Matrix/union.html">union</a>
 
 
@@ -80 +82 @@
 
     <h3>Return value</h3>
- tableau
+ an array containing the set of values in both a and b.
+
+ The empty set is denoted by an array with the first element equal to
+ -1.
 
 
@@ -127 +132 @@
 
     <h3>Examples</h3><pre>
- IDL> a = [2,4,6,8]
- IDL> b = [6,1,3,2]
- IDL> inter(a,b) = [ 2, 6]       ; Common elements
+
+   IDL> a = [2,4,6,8]
+   IDL> b = [6,1,3,2]
+   IDL> res=inter(a,b)
+              2           6
+ Right because 2 and 6 are in a and B.
 
     </pre><h3>Version history</h3>
     
     <h4>Version</h4>
- $Id: inter.pro 325 2007-12-06 10:04:53Z pinsard $
+ $Id: inter.pro 378 2008-08-12 12:35:46Z pinsard $
 
     <h4>History</h4>
@@ -146 +154 @@
     
     <h4>Restrictions</h4> 
- The empty set is denoted by an array with the first element equal to
- -1.
-
- 
  These functions will not be efficient on sparse sets with wide
  ranges, as they trade memory for efficiency. 

trunk/SRC/Documentation/idldoc_assistant_output/Matrix/make_selection.html

@@ -190 +190 @@
 
     <h3>Examples</h3><pre>
-           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
-
-           index = MAKE_SELECTION(vals,[9,-5,8,7,7,8,9],/ONLY_VALID)
-           print,index
-           ; prints  9  8  7  7  8  9
-
-           index = MAKE_SELECTION(vals,[9,-5,8,7,7,8,9],/REQUIRED)
-           print,index
-           ; prints  -1
+
+   IDL> names = [ 'Alfred','Anton','Peter','John','Mary']
+   IDL> index = MAKE_SELECTION(names,['Peter','Mary'])
+   IDL> print,index
+   2  4
+
+   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
+
+   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
 
     </pre><h3>Version history</h3>
     
     <h4>Version</h4>
- $Id: make_selection.pro 325 2007-12-06 10:04:53Z pinsard $
+ $Id: make_selection.pro 372 2008-08-08 12:31:53Z pinsard $
 
     <h4>History</h4>

trunk/SRC/Documentation/idldoc_assistant_output/Matrix/union.html

@@ -62 +62 @@
 
     
- calculate the union between 2 matrices of whole numbers
+ find the union between 2 matrices of whole numbers
+
+ see also <a href="..//Matrix/different.html">different</a> and <a href="..//Matrix/inter.html">inter</a>.
 
 
@@ -80 +82 @@
 
     <h3>Return value</h3>
- tableau
+ an array containing the set of values in a and b.
 
 
@@ -101 +103 @@
     
  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
 
     
@@ -127 +129 @@
 
     <h3>Examples</h3><pre>
- IDL> a = [2,4,6,8]
- IDL> b = [6,1,3,2]
- IDL> union(a,b) = [ 1, 2, 3, 4, 6, 8]  ; Elements in either set
+
+   IDL> a = [2,4,6,8]
+   IDL> b = [6,1,3,2]
+   IDL> res=union(a,b) 
+   IDL> print, res
+           1           2           3           4           5           6
+           8
+ this is the list ao all elements in either sets.
 
     </pre><h3>Version history</h3>
     
     <h4>Version</h4>
- $Id: union.pro 325 2007-12-06 10:04:53Z pinsard $
+ $Id: union.pro 378 2008-08-12 12:35:46Z pinsard $
 
     <h4>History</h4>
@@ -145 +152 @@
     
     
-    <h4>Restrictions</h4>
- The empty set is denoted by an array with the first element equal to -1.
-
- 
+    <h4>Restrictions</h4> 
  These functions will not be efficient on sparse sets with wide
  ranges, as they trade memory for efficiency. 

trunk/SRC/Documentation/idldoc_assistant_output/Matrix/zero_one.html

@@ -79 +79 @@
 
     <h3>Return value</h3>
- result
+ an array of n1 dimension or n1xn2 dimensions
 
 
@@ -93 +93 @@
       <font size="-1" color="#006633">required</font>
       
-      
+      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>integer</i></font>
       
       
@@ -108 +108 @@
       
       
-      <font size="-1" color="#006633">required</font>
       
       
+      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>integer</i></font>
       
       
@@ -123 +123 @@
     
 
-    
+    <h3>Examples</h3><pre>
+
+   IDL> a=zero_one(3)   
+   IDL> help,a
+   A               FLOAT     = Array[3]
+   IDL> print,a
+         0.00000      1.00000      0.00000
+
+   IDL> a=zero_one(2,3)   
+   IDL> help,a
+   A               FLOAT     = Array[2, 3]
+   IDL> print,a
+      0.00000      1.00000
+      1.00000      0.00000
+      0.00000      1.00000
+
     </pre><h3>Version history</h3>
     
     <h4>Version</h4>
- $Id: zero_one.pro 325 2007-12-06 10:04:53Z pinsard $
+ $Id: zero_one.pro 373 2008-08-08 14:11:31Z pinsard $
 
     <h4>History</h4>