Ignore:
Timestamp:
03/21/07 10:14:37 (17 years ago)
Author:
pinsard
Message:

new idldoc html and assistant outputs

Location:
trunk/SRC/Documentation/idldoc_assistant_output/Matrix
Files:
8 edited

Legend:

Unmodified
Added
Removed

  • trunk/SRC/Documentation/idldoc_assistant_output/Matrix/cmapply.html

    r200 r234  
    121121       
    122122      <dt><a href="#_cmapply_product"><i>result = </i>cmapply_product(<i>x</i>)</a><dt> 
    123       <dd><font size="-1"></font></dd> 
     123      <dd><font size="-1"> </font></dd> 
    124124       
    125125      <dt><a href="#_cmapply_redim">cmapply_redim<i>, newarr, dimapply, dimkeep, nkeep, totcol, totkeep</i></a><dt> 
    … …  
    143143     
    144144 
     145 
    145146     
    146147 
    … …  
    170171 
    171172     
    172     <h3>Version history</h3> 
    173      
    174     <h4>Version</h4> $Id: cmapply.pro 163 2006-08-29 12:59:46Z navarro $ 
     173    </pre><h3>Version history</h3> 
     174     
     175    <h4>Version</h4> $Id: cmapply.pro 232 2007-03-20 16:59:36Z pinsard $ 
    175176 
    176177     
    … …  
    501502     
    502503 
    503     <h3>Examples</h3> 
     504    <h3>Examples</h3><pre> 
    504505 
    505506   First example:  Shows how CMAPPLY can be used to total the second dimension of the 
    … …  
    542543   (OUT[i,j] is the median value of IN[i,j,*]) 
    543544 
    544     <h3>Version history</h3> 
    545      
    546     <h4>Version</h4> $Id: cmapply.pro 163 2006-08-29 12:59:46Z navarro $ 
    547  
    548     <h4>History</h4> Mar 1998, Written, CM 
     545    </pre><h3>Version history</h3> 
     546     
     547    <h4>Version</h4>  
     548 $Id: cmapply.pro 232 2007-03-20 16:59:36Z pinsard $ 
     549 
     550    <h4>History</h4>  
     551 Mar 1998, Written, CM 
    549552   Changed usage message to not bomb, 24 Mar 2000, CM 
    550553   Significant rewrite for *, MIN and MAX (inspired by Todd Clements 

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

    r200 r234  
    328328     
    329329 
    330     <h3>Examples</h3> 
     330    <h3>Examples</h3><pre> 
    331331 Utility function, similar to UNIQ, but allowing choice of taking 
    332332 first or last unique element, or non-unique elements. 
    … …  
    357357 "first" value, whatever that may mean. 
    358358 
    359     <h3>Version history</h3> 
     359    </pre><h3>Version history</h3> 
    360360     
    361361    <h4>Version</h4> $Id: cmset_op.pro 163 2006-08-29 12:59:46Z navarro $ 

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

    r200 r234  
    6161    </dl> 
    6262 
    63       
     63     
    6464 calculate the different elements of 2 matrix of positive whole numbers. 
    6565 
    … …  
    7979 
    8080 
    81     <h3>Return value</h3> tableau 
     81    <h3>Return value</h3> 
     82 tableau 
    8283 
    8384 
    … …  
    9899    </h4> 
    99100 
    100      arrays of positive integers, which need 
     101     
     102 arrays of positive integers, which need 
    101103               not be sorted. Duplicate elements are ignored, as they have no 
    102104               effect on the result 
    … …  
    116118    </h4> 
    117119 
    118      see a 
     120     
     121 see a 
    119122 
    120123     
    … …  
    123126     
    124127 
    125     <h3>Examples</h3> 
     128    <h3>Examples</h3><pre> 
    126129 
    127   a = [2,4,6,8] 
    128   b = [6,1,3,2] 
    129   different(a,b) = [ 4, 8]         ; Elements in A but not in B 
     130  IDL> a = [2,4,6,8] 
     131  IDL> b = [6,1,3,2] 
     132  IDL> different(a,b) = [ 4, 8]         ; Elements in A but not in B 
    130133 
    131     <h3>Version history</h3> 
     134    </pre><h3>Version history</h3> 
    132135     
    133     <h4>Version</h4> $Id: different.pro 163 2006-08-29 12:59:46Z navarro $ 
     136    <h4>Version</h4> 
     137 $Id: different.pro 232 2007-03-20 16:59:36Z pinsard $ 
    134138 
    135     <h4>History</h4> http://www.dfanning.com/tips/set_operations.html 
     139    <h4>History</h4> 
     140 <a href="http://www.dfanning.com/tips/set_operations.html"/> 
    136141 
    137142     
    … …  
    141146     
    142147     
    143     <h4>Restrictions</h4> The empty set is denoted by an array with the first element equal to 
     148    <h4>Restrictions</h4> 
     149 The empty set is denoted by an array with the first element equal to 
    144150 -1. 
     151 
    145152 
    146153 These functions will not be efficient on sparse sets with wide 

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

    r200 r234  
    106106    <h3>Return value</h3> 
    107107 a matrix 1,2,3 or 4d extract from input array 
     108 -1 in case of mistake 
    108109 
    109110 
    … …  
    202203     
    203204 
    204     <h3>Examples</h3> 
     205    <h3>Examples</h3><pre> 
    205206 I have a dim 2 matrix named A. I want extract a small intersection 
    206207 matrix 2d of the line 2,3 and 7 and of the column 0 and 1: 
    … …  
    217218 g i 
    218219 
    219     <h3>Version history</h3> 
    220      
    221     <h4>Version</h4> $Id: extrac2.pro 163 2006-08-29 12:59:46Z navarro $ 
     220    </pre><h3>Version history</h3> 
     221     
     222    <h4>Version</h4> $Id: extrac2.pro 231 2007-03-19 17:15:51Z pinsard $ 
    222223 
    223224    <h4>History</h4> Sebastien Masson (smasson@lodyc.jussieu.fr) 
    … …  
    232233     
    233234    <h4>Restrictions</h4> 
    234  -1 in case of mistake 
    235235 
    236236 

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

    r200 r234  
    6161    </dl> 
    6262 
    63       
     63     
    6464 calculate the intersection between 2 matrices of whole numbers 
    6565 
    … …  
    7070      <a name="#_inter"></a> 
    7171 
    72       <h2>inter  <font size="-1" color="#006633">  
     72      <h2>inter  <font size="-1" color="#006633"> 
    7373 Calculation 
    7474</font></h2> 
    … …  
    123123     
    124124 
    125     <h3>Examples</h3>  a = [2,4,6,8] 
    126    b = [6,1,3,2] 
    127    inter(a,b) = [ 2, 6]       ; Common elements  
     125    <h3>Examples</h3><pre> 
     126 IDL> a = [2,4,6,8] 
     127 IDL> b = [6,1,3,2] 
     128 IDL> inter(a,b) = [ 2, 6]       ; Common elements 
    128129 
    129     <h3>Version history</h3> 
     130    </pre><h3>Version history</h3> 
    130131     
    131     <h4>Version</h4> $Id: inter.pro 163 2006-08-29 12:59:46Z navarro $ 
     132    <h4>Version</h4> 
     133 $Id: inter.pro 232 2007-03-20 16:59:36Z pinsard $ 
    132134 
    133     <h4>History</h4>  http://www.dfanning.com/tips/set_operations.html 
     135    <h4>History</h4> 
     136 <a href="http://www.dfanning.com/tips/set_operations.html"/> 
    134137 
    135138     

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

    r200 r234  
    6262 
    6363     
     64 Convert an array of selected values to an index 
     65 array that identifies the selected values in a list or data array. 
     66 
    6467 
    6568     
    … …  
    6871      <a name="#_make_selection"></a> 
    6972 
    70       <h2>make_selection  </h2> 
     73      <h2>make_selection  <font size="-1" color="#006633"> 
     74 tools 
     75</font></h2> 
    7176 
    7277      <p><font face="Courier"><i>result = </i>make_selection(<i><a href="#_make_selection_keyword_names">names</a>, <a href="#_make_selection_keyword_selnames">selnames</a></i>, <a href="#_make_selection_keyword_only_valid">only_valid</a>=<i>only_valid</i>, <a href="#_make_selection_keyword_required">required</a>=<i>required</i>, <a href="#_make_selection_keyword_quiet">quiet</a>=<i>quiet</i>)</font></p> 
    … …  
    7479     
    7580 
    76  file_comments  
    77  Convert an array of selected values to an index 
    78         array that identifies the selected values in a list 
    79         or data array.  
    80  
    81  categories tools 
    82   
    83  
    84     <h3>Return value</h3> A (long) array with indexes to reference the selected values 
    85         in the NAMES array. 
     81 
     82    <h3>Return value</h3> 
     83 A (long) array with indexes to reference the selected values 
     84 in the NAMES array. 
    8685 
    8786 
    … …  
    102101    </h4> 
    103102 
    104      A list or array of values to choose from  
     103     
     104 A list or array of values to choose from 
    105105 
    106106     
    … …  
    118118    </h4> 
    119119 
    120      A list of selected values 
     120     
     121 A list of selected values 
    121122 
    122123     
    … …  
    139140    </h4> 
    140141 
    141      Return only indexes of found values. Values not 
    142             found are skipped. Default is to return 1 index value for 
    143             each SELNAME, which is -1 if SELNAME is not contained in  
    144             NAMES. If ONLY_VALID is set, the -1 values will be deleted, 
    145             and a value of -1 indicates that no SELNAME has been found 
    146             at all. 
     142     
     143 Return only indexes of found values. Values not 
     144 found are skipped. Default is to return 1 index value for 
     145 each SELNAME, which is -1 if SELNAME is not contained in 
     146 NAMES. If ONLY_VALID is set, the -1 values will be deleted, 
     147 and a value of -1 indicates that no SELNAME has been found 
     148 at all. 
    147149 
    148150     
    … …  
    159161    </h4> 
    160162 
    161      Normally, MAKE_SELECTION will return indexes for 
    162             all values that are found, simply ignoring the selected 
    163             values that are not in the NAMES array (although an error 
    164             message is displayed). Set this keyword to return with 
    165             -1 as soon as a selected value is not found. 
     163     
     164 Normally, MAKE_SELECTION will return indexes for 
     165 all values that are found, simply ignoring the selected 
     166 values that are not in the NAMES array (although an error 
     167 message is displayed). Set this keyword to return with 
     168 -1 as soon as a selected value is not found. 
    166169 
    167170     
    … …  
    178181    </h4> 
    179182 
    180      Suppress printing of the error message if a 
    181             selected value is not found (the error condition will 
    182             still be set). 
    183  
    184      
    185      
    186  
    187     <h3>Examples</h3> names = [ 'Alfred','Anton','Peter','John','Mary'] 
     183     
     184 Suppress printing of the error message if a 
     185 selected value is not found (the error condition will 
     186 still be set). 
     187 
     188     
     189     
     190 
     191    <h3>Examples</h3><pre> 
     192           names = [ 'Alfred','Anton','Peter','John','Mary'] 
    188193           index = MAKE_SELECTION(names,['Peter','Mary']) 
    189194           print,index 
    … …  
    203208           ; prints  -1 
    204209 
    205     <h3>Version history</h3> 
    206      
    207     <h4>Version</h4> $Id: make_selection.pro 163 2006-08-29 12:59:46Z navarro $ 
    208  
    209     <h4>History</h4> mgs, 28 Aug 1998: VERSION 1.00 
    210           mgs, 29 Aug 1998: - changed behavior and added ONLY_VALID keyword 
     210    </pre><h3>Version history</h3> 
     211     
     212    <h4>Version</h4> 
     213 $Id: make_selection.pro 232 2007-03-20 16:59:36Z pinsard $ 
     214 
     215    <h4>History</h4> 
     216 mgs, 28 Aug 1998: VERSION 1.00 
     217 mgs, 29 Aug 1998: - changed behavior and added ONLY_VALID keyword 
     218 Copyright (C) 1998, Martin Schultz, Harvard University 
     219 This software is provided as is without any warranty 
     220 whatsoever. It may be freely used, copied or distributed 
     221 for non-commercial purposes. This copyright notice must be 
     222 kept with any copy of this software. If this software shall 
     223 be used commercially or sold as part of a larger package, 
     224 please contact the author to arrange payment. 
     225 Bugs and comments should be directed to mgs@io.harvard.edu 
     226 with subject "IDL routine make_selection" 
    211227 
    212228     
    … …  
    216232     
    217233     
    218     <h4>Restrictions</h4> If the NAMES array contains multiple entries of the same value, 
    219         only the index to the first entry will be returned. 
    220  
    221         A selection can contain multiple instances of the same value. 
    222         The index array will contain one entry per selected item 
    223         (See example below) 
     234    <h4>Restrictions</h4> 
     235 If the NAMES array contains multiple entries of the same value, 
     236 only the index to the first entry will be returned. 
     237 
     238 A selection can contain multiple instances of the same value. 
     239 The index array will contain one entry per selected item 
     240 (See example below) 
    224241 
    225242 

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

    r200 r234  
    6161    </dl> 
    6262 
    63       
     63     
    6464 calculate the union between 2 matrices of whole numbers 
    6565 
    … …  
    7070      <a name="#_union"></a> 
    7171 
    72       <h2>union  <font size="-1" color="#006633">  
     72      <h2>union  <font size="-1" color="#006633"> 
    7373 Calculation 
    7474</font></h2> 
    … …  
    7979 
    8080 
    81     <h3>Return value</h3> tableau 
     81    <h3>Return value</h3> 
     82 tableau 
    8283 
    8384 
    … …  
    9899    </h4> 
    99100 
    100      arrays of positive integers, which need 
     101     
     102 arrays of positive integers, which need 
    101103               not be sorted. Duplicate elements are ignored, as they have no 
    102104               effect on the result 
    … …  
    123125     
    124126 
    125     <h3>Examples</h3> a = [2,4,6,8] 
    126            b = [6,1,3,2] 
    127            union(a,b) = [ 1, 2, 3, 4, 6, 8]  ; Elements in either set 
     127    <h3>Examples</h3><pre> 
     128 IDL> a = [2,4,6,8] 
     129 IDL> b = [6,1,3,2] 
     130 IDL> union(a,b) = [ 1, 2, 3, 4, 6, 8]  ; Elements in either set 
    128131 
    129     <h3>Version history</h3> 
     132    </pre><h3>Version history</h3> 
    130133     
    131     <h4>Version</h4> $Id: union.pro 163 2006-08-29 12:59:46Z navarro $ 
     134    <h4>Version</h4> 
     135 $Id: union.pro 232 2007-03-20 16:59:36Z pinsard $ 
    132136 
    133     <h4>History</h4>  http://www.dfanning.com/tips/set_operations.html 
     137    <h4>History</h4> 
     138 <a href="http://www.dfanning.com/tips/set_operations.html"/> 
    134139 
    135140     
    … …  
    139144     
    140145     
    141     <h4>Restrictions</h4> The empty set is denoted by an array with the first element equal to 
    142  -1. 
     146    <h4>Restrictions</h4> 
     147 The empty set is denoted by an array with the first element equal to -1. 
    143148 
    144149 These functions will not be efficient on sparse sets with wide 

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

    r200 r234  
    120120 
    121121     
    122     <h3>Version history</h3> 
     122    </pre><h3>Version history</h3> 
    123123     
    124     <h4>Version</h4> $Id: zero_one.pro 163 2006-08-29 12:59:46Z navarro $ 
     124    <h4>Version</h4> $Id: zero_one.pro 231 2007-03-19 17:15:51Z pinsard $ 
    125125 
    126126    <h4>History</h4> Sebastien Masson (smasson@lodyc.jussieu.fr) 
Note: See TracChangeset for help on using the changeset viewer.