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_html_output/Matrix
Files:
8 edited

Legend:

Unmodified
Added
Removed

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

    r200 r234  
    154154           
    155155          <dt><p><a href="#_cmapply_product"><span class="result">result = </span>cmapply_product(<span class="result">x</span>)</a></p><dt> 
    156           <dd></dd>      
     156          <dd> </dd>     
    157157           
    158158          <dt><p><a href="#_cmapply_redim">cmapply_redim<span class="result">, newarr, dimapply, dimkeep, nkeep, totcol, totkeep</span></a></p><dt> 
    … …  
    176176            <span class="result">result = </span>cmapply_product(<span class="result"><a href="#_cmapply_product_param_x">x</a></span>)</p> 
    177177         
    178           <div class="comments"></div> 
     178          <div class="comments"> 
     179</div> 
    179180 
    180181           
    … …  
    207208          <h3>Version history</h3> 
    208209           
    209           <h4>Version</h4><div class="preformat"> $Id: cmapply.pro 163 2006-08-29 12:59:46Z navarro $ 
     210          <h4>Version</h4><div class="preformat"> $Id: cmapply.pro 232 2007-03-20 16:59:36Z pinsard $ 
    210211</div> 
    211212           
    … …  
    579580          <h3>Version history</h3> 
    580581           
    581           <h4>Version</h4><div class="preformat"> $Id: cmapply.pro 163 2006-08-29 12:59:46Z navarro $ 
    582 </div> 
    583           <h4>History</h4><div class="preformat"> Mar 1998, Written, CM 
     582          <h4>Version</h4><div class="preformat">  
     583 $Id: cmapply.pro 232 2007-03-20 16:59:36Z pinsard $ 
     584</div> 
     585          <h4>History</h4><div class="preformat">  
     586 Mar 1998, Written, CM 
    584587   Changed usage message to not bomb, 24 Mar 2000, CM 
    585588   Significant rewrite for *, MIN and MAX (inspired by Todd Clements 

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

    r200 r234  
    8787      </div> 
    8888 
    89       <div id="file_comments">  
     89      <div id="file_comments"> 
    9090 calculate the different elements of 2 matrix of positive whole numbers. 
    9191</div> 
    … …  
    114114</div> 
    115115 
    116           <h3>Return value</h3><div class="preformat"> tableau 
     116          <h3>Return value</h3><div class="preformat"> 
     117 tableau 
    117118</div> 
    118119 
    … …  
    132133            </h4> 
    133134         
    134           <div class="comments"> arrays of positive integers, which need 
     135          <div class="comments"> 
     136 arrays of positive integers, which need 
    135137               not be sorted. Duplicate elements are ignored, as they have no 
    136138               effect on the result 
    … …  
    148150            </h4> 
    149151         
    150           <div class="comments"> see a 
     152          <div class="comments"> 
     153 see a 
    151154</div> 
    152155             
    … …  
    158161          <h3>Examples</h3><div class="preformat"> 
    159162 
    160   a = [2,4,6,8] 
    161   b = [6,1,3,2] 
    162   different(a,b) = [ 4, 8]         ; Elements in A but not in B 
     163  IDL> a = [2,4,6,8] 
     164  IDL> b = [6,1,3,2] 
     165  IDL> different(a,b) = [ 4, 8]         ; Elements in A but not in B 
    163166</div> 
    164167          <h3>Version history</h3> 
    165168           
    166           <h4>Version</h4><div class="preformat"> $Id: different.pro 163 2006-08-29 12:59:46Z navarro $ 
    167 </div> 
    168           <h4>History</h4><div class="preformat"> http://www.dfanning.com/tips/set_operations.html 
     169          <h4>Version</h4><div class="preformat"> 
     170 $Id: different.pro 232 2007-03-20 16:59:36Z pinsard $ 
     171</div> 
     172          <h4>History</h4><div class="preformat"> 
     173 <a href="http://www.dfanning.com/tips/set_operations.html"/> 
    169174</div> 
    170175           
    … …  
    174179           
    175180           
    176           <h4>Restrictions</h4><div class="preformat"> The empty set is denoted by an array with the first element equal to 
     181          <h4>Restrictions</h4><div class="preformat"> 
     182 The empty set is denoted by an array with the first element equal to 
    177183 -1. 
     184 
    178185 
    179186 These functions will not be efficient on sparse sets with wide 

  • trunk/SRC/Documentation/idldoc_html_output/Matrix/directory-overview.html

    r200 r234  
    9696       
    9797        <dt><a href="different.html">different.pro</a></dt> 
    98         <dd>   calculate the different elements of 2 matrix of positive whole numbers.</dd> 
     98        <dd>  calculate the different elements of 2 matrix of positive whole numbers.</dd> 
    9999       
    100100        <dt><a href="extrac2.html">extrac2.pro</a></dt> 
    … …  
    102102       
    103103        <dt><a href="inter.html">inter.pro</a></dt> 
    104         <dd>   calculate the intersection between 2 matrices of whole numbers </dd> 
     104        <dd>  calculate the intersection between 2 matrices of whole numbers </dd> 
    105105       
    106106        <dt><a href="make_selection.html">make_selection.pro</a></dt> 
    107         <dd></dd> 
     107        <dd>  Convert an array of selected values to an index  array that identifies the selected values in a list or data array.</dd> 
    108108       
    109109        <dt><a href="union.html">union.pro</a></dt> 
    110         <dd>   calculate the union between 2 matrices of whole numbers </dd> 
     110        <dd>  calculate the union between 2 matrices of whole numbers </dd> 
    111111       
    112112        <dt><a href="zero_one.html">zero_one.pro</a></dt> 

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

    r200 r234  
    141141          <h3>Return value</h3><div class="preformat"> 
    142142 a matrix 1,2,3 or 4d extract from input array 
     143 -1 in case of mistake 
    143144</div> 
    144145 
    … …  
    246247          <h3>Version history</h3> 
    247248           
    248           <h4>Version</h4><div class="preformat"> $Id: extrac2.pro 163 2006-08-29 12:59:46Z navarro $ 
     249          <h4>Version</h4><div class="preformat"> $Id: extrac2.pro 231 2007-03-19 17:15:51Z pinsard $ 
    249250</div> 
    250251          <h4>History</h4><div class="preformat"> Sebastien Masson (smasson@lodyc.jussieu.fr) 
    … …  
    259260           
    260261          <h4>Restrictions</h4><div class="preformat"> 
    261  -1 in case of mistake 
    262262</div> 
    263263         

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

    r200 r234  
    8787      </div> 
    8888 
    89       <div id="file_comments">  
     89      <div id="file_comments"> 
    9090 calculate the intersection between 2 matrices of whole numbers 
    9191</div> 
    … …  
    104104        <div class="routine_details" id="_inter"> 
    105105 
    106           <h2><a class="top" href="#container">top</a>inter <span class="categories">  
     106          <h2><a class="top" href="#container">top</a>inter <span class="categories"> 
    107107 Calculation 
    108108</span></h2> 
    … …  
    156156           
    157157 
    158           <h3>Examples</h3><div class="preformat">  a = [2,4,6,8] 
    159    b = [6,1,3,2] 
    160    inter(a,b) = [ 2, 6]       ; Common elements  
     158          <h3>Examples</h3><div class="preformat"> 
     159 IDL> a = [2,4,6,8] 
     160 IDL> b = [6,1,3,2] 
     161 IDL> inter(a,b) = [ 2, 6]       ; Common elements 
    161162</div> 
    162163          <h3>Version history</h3> 
    163164           
    164           <h4>Version</h4><div class="preformat"> $Id: inter.pro 163 2006-08-29 12:59:46Z navarro $ 
    165 </div> 
    166           <h4>History</h4><div class="preformat">  http://www.dfanning.com/tips/set_operations.html 
     165          <h4>Version</h4><div class="preformat"> 
     166 $Id: inter.pro 232 2007-03-20 16:59:36Z pinsard $ 
     167</div> 
     168          <h4>History</h4><div class="preformat"> 
     169 <a href="http://www.dfanning.com/tips/set_operations.html"/> 
    167170</div> 
    168171           

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

    r200 r234  
    8787      </div> 
    8888 
    89       <div id="file_comments"></div> 
     89      <div id="file_comments"> 
     90 Convert an array of selected values to an index 
     91 array that identifies the selected values in a list or data array. 
     92</div> 
    9093 
    9194       
    … …  
    102105        <div class="routine_details" id="_make_selection"> 
    103106 
    104           <h2><a class="top" href="#container">top</a>make_selection </h2> 
     107          <h2><a class="top" href="#container">top</a>make_selection <span class="categories"> 
     108 tools 
     109</span></h2> 
    105110         
    106111          <p class="header"> 
    … …  
    108113         
    109114          <div class="comments"> 
    110  
    111  file_comments  
    112  Convert an array of selected values to an index 
    113         array that identifies the selected values in a list 
    114         or data array.  
    115  
    116  categories tools 
    117  </div> 
    118  
    119           <h3>Return value</h3><div class="preformat"> A (long) array with indexes to reference the selected values 
    120         in the NAMES array. 
     115</div> 
     116 
     117          <h3>Return value</h3><div class="preformat"> 
     118 A (long) array with indexes to reference the selected values 
     119 in the NAMES array. 
    121120</div> 
    122121 
    … …  
    136135            </h4> 
    137136         
    138           <div class="comments"> A list or array of values to choose from  
     137          <div class="comments"> 
     138 A list or array of values to choose from 
    139139</div> 
    140140             
    … …  
    150150            </h4> 
    151151         
    152           <div class="comments"> A list of selected values 
     152          <div class="comments"> 
     153 A list of selected values 
    153154</div> 
    154155             
    … …  
    171172            </h4> 
    172173         
    173             <div class="comments"> Return only indexes of found values. Values not 
    174             found are skipped. Default is to return 1 index value for 
    175             each SELNAME, which is -1 if SELNAME is not contained in  
    176             NAMES. If ONLY_VALID is set, the -1 values will be deleted, 
    177             and a value of -1 indicates that no SELNAME has been found 
    178             at all. 
     174            <div class="comments"> 
     175 Return only indexes of found values. Values not 
     176 found are skipped. Default is to return 1 index value for 
     177 each SELNAME, which is -1 if SELNAME is not contained in 
     178 NAMES. If ONLY_VALID is set, the -1 values will be deleted, 
     179 and a value of -1 indicates that no SELNAME has been found 
     180 at all. 
    179181</div> 
    180182             
    … …  
    190192            </h4> 
    191193         
    192             <div class="comments"> Normally, MAKE_SELECTION will return indexes for 
    193             all values that are found, simply ignoring the selected 
    194             values that are not in the NAMES array (although an error 
    195             message is displayed). Set this keyword to return with 
    196             -1 as soon as a selected value is not found. 
     194            <div class="comments"> 
     195 Normally, MAKE_SELECTION will return indexes for 
     196 all values that are found, simply ignoring the selected 
     197 values that are not in the NAMES array (although an error 
     198 message is displayed). Set this keyword to return with 
     199 -1 as soon as a selected value is not found. 
    197200</div> 
    198201             
    … …  
    208211            </h4> 
    209212         
    210             <div class="comments"> Suppress printing of the error message if a 
    211             selected value is not found (the error condition will 
    212             still be set). 
    213 </div> 
    214              
    215            
    216  
    217           <h3>Examples</h3><div class="preformat"> names = [ 'Alfred','Anton','Peter','John','Mary'] 
     213            <div class="comments"> 
     214 Suppress printing of the error message if a 
     215 selected value is not found (the error condition will 
     216 still be set). 
     217</div> 
     218             
     219           
     220 
     221          <h3>Examples</h3><div class="preformat"> 
     222           names = [ 'Alfred','Anton','Peter','John','Mary'] 
    218223           index = MAKE_SELECTION(names,['Peter','Mary']) 
    219224           print,index 
    … …  
    235240          <h3>Version history</h3> 
    236241           
    237           <h4>Version</h4><div class="preformat"> $Id: make_selection.pro 163 2006-08-29 12:59:46Z navarro $ 
    238 </div> 
    239           <h4>History</h4><div class="preformat"> mgs, 28 Aug 1998: VERSION 1.00 
    240           mgs, 29 Aug 1998: - changed behavior and added ONLY_VALID keyword 
     242          <h4>Version</h4><div class="preformat"> 
     243 $Id: make_selection.pro 232 2007-03-20 16:59:36Z pinsard $ 
     244</div> 
     245          <h4>History</h4><div class="preformat"> 
     246 mgs, 28 Aug 1998: VERSION 1.00 
     247 mgs, 29 Aug 1998: - changed behavior and added ONLY_VALID keyword 
     248 Copyright (C) 1998, Martin Schultz, Harvard University 
     249 This software is provided as is without any warranty 
     250 whatsoever. It may be freely used, copied or distributed 
     251 for non-commercial purposes. This copyright notice must be 
     252 kept with any copy of this software. If this software shall 
     253 be used commercially or sold as part of a larger package, 
     254 please contact the author to arrange payment. 
     255 Bugs and comments should be directed to mgs@io.harvard.edu 
     256 with subject "IDL routine make_selection" 
    241257</div> 
    242258           
    … …  
    246262           
    247263           
    248           <h4>Restrictions</h4><div class="preformat"> If the NAMES array contains multiple entries of the same value, 
    249         only the index to the first entry will be returned. 
    250  
    251         A selection can contain multiple instances of the same value. 
    252         The index array will contain one entry per selected item 
    253         (See example below) 
     264          <h4>Restrictions</h4><div class="preformat"> 
     265 If the NAMES array contains multiple entries of the same value, 
     266 only the index to the first entry will be returned. 
     267 
     268 A selection can contain multiple instances of the same value. 
     269 The index array will contain one entry per selected item 
     270 (See example below) 
    254271</div> 
    255272         

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

    r200 r234  
    8787      </div> 
    8888 
    89       <div id="file_comments">  
     89      <div id="file_comments"> 
    9090 calculate the union between 2 matrices of whole numbers 
    9191</div> 
    … …  
    104104        <div class="routine_details" id="_union"> 
    105105 
    106           <h2><a class="top" href="#container">top</a>union <span class="categories">  
     106          <h2><a class="top" href="#container">top</a>union <span class="categories"> 
    107107 Calculation 
    108108</span></h2> 
    … …  
    114114</div> 
    115115 
    116           <h3>Return value</h3><div class="preformat"> tableau 
     116          <h3>Return value</h3><div class="preformat"> 
     117 tableau 
    117118</div> 
    118119 
    … …  
    132133            </h4> 
    133134         
    134           <div class="comments"> arrays of positive integers, which need 
     135          <div class="comments"> 
     136 arrays of positive integers, which need 
    135137               not be sorted. Duplicate elements are ignored, as they have no 
    136138               effect on the result 
    … …  
    156158           
    157159 
    158           <h3>Examples</h3><div class="preformat"> a = [2,4,6,8] 
    159            b = [6,1,3,2] 
    160            union(a,b) = [ 1, 2, 3, 4, 6, 8]  ; Elements in either set 
     160          <h3>Examples</h3><div class="preformat"> 
     161 IDL> a = [2,4,6,8] 
     162 IDL> b = [6,1,3,2] 
     163 IDL> union(a,b) = [ 1, 2, 3, 4, 6, 8]  ; Elements in either set 
    161164</div> 
    162165          <h3>Version history</h3> 
    163166           
    164           <h4>Version</h4><div class="preformat"> $Id: union.pro 163 2006-08-29 12:59:46Z navarro $ 
    165 </div> 
    166           <h4>History</h4><div class="preformat">  http://www.dfanning.com/tips/set_operations.html 
     167          <h4>Version</h4><div class="preformat"> 
     168 $Id: union.pro 232 2007-03-20 16:59:36Z pinsard $ 
     169</div> 
     170          <h4>History</h4><div class="preformat"> 
     171 <a href="http://www.dfanning.com/tips/set_operations.html"/> 
    167172</div> 
    168173           
    … …  
    172177           
    173178           
    174           <h4>Restrictions</h4><div class="preformat"> The empty set is denoted by an array with the first element equal to 
    175  -1. 
     179          <h4>Restrictions</h4><div class="preformat"> 
     180 The empty set is denoted by an array with the first element equal to -1. 
    176181 
    177182 These functions will not be efficient on sparse sets with wide 

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

    r200 r234  
    155155          <h3>Version history</h3> 
    156156           
    157           <h4>Version</h4><div class="preformat"> $Id: zero_one.pro 163 2006-08-29 12:59:46Z navarro $ 
     157          <h4>Version</h4><div class="preformat"> $Id: zero_one.pro 231 2007-03-19 17:15:51Z pinsard $ 
    158158</div> 
    159159          <h4>History</h4><div class="preformat"> Sebastien Masson (smasson@lodyc.jussieu.fr) 
Note: See TracChangeset for help on using the changeset viewer.