Ignore:
Timestamp:
04/06/07 10:35:17 (17 years ago)
Author:
pinsard
Message:

improvements/corrections of some *.pro headers + replace some message by some report

Location:
trunk/SRC/Documentation/idldoc_html_output/Matrix
Files:
7 edited

Legend:

Unmodified
Added
Removed

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

    r234 r242  
    136136 
    137137   It's worth noting however, that the implementation of user-defined 
    138    functions is not particularly optimized for speed.  Users are 
     138   functions is not particularly optimized for speed. Users are 
    139139   encouraged to implement their own array if the number of output 
    140140   elements is large. 
    … …  
    157157           
    158158          <dt><p><a href="#_cmapply_redim">cmapply_redim<span class="result">, newarr, dimapply, dimkeep, nkeep, totcol, totkeep</span></a></p><dt> 
    159           <dd></dd>      
     159          <dd> </dd>     
    160160           
    161161          <dt><p><a href="#_cmapply"><span class="result">result = </span>cmapply(<span class="result">op, array[, dimapply]</span>, double=<span class="result">double</span>, type=<span class="result">type</span>, functargs=<span class="result">functargs</span>, nocatch=<span class="result">nocatch</span>)</a></p><dt> 
    … …  
    197197         
    198198          <div class="comments"> 
    199  
    200199</div> 
    201200             
    … …  
    208207          <h3>Version history</h3> 
    209208           
    210           <h4>Version</h4><div class="preformat"> $Id: cmapply.pro 232 2007-03-20 16:59:36Z pinsard $ 
     209          <h4>Version</h4><div class="preformat"> 
     210 $Id: cmapply.pro 238 2007-03-27 13:43:18Z pinsard $ 
    211211</div> 
    212212           
    … …  
    245245            cmapply_redim<span class="result">, <a href="#_cmapply_redim_param_newarr">newarr</a>, <a href="#_cmapply_redim_param_dimapply">dimapply</a>, <a href="#_cmapply_redim_param_dimkeep">dimkeep</a>, <a href="#_cmapply_redim_param_nkeep">nkeep</a>, <a href="#_cmapply_redim_param_totcol">totcol</a>, <a href="#_cmapply_redim_param_totkeep">totkeep</a></span></p> 
    246246         
    247           <div class="comments"></div> 
     247          <div class="comments"> 
     248</div> 
    248249 
    249250           
    … …  
    265266         
    266267          <div class="comments"> 
    267  
    268268</div> 
    269269             
    … …  
    280280         
    281281          <div class="comments"> 
    282  
    283282</div> 
    284283             
    … …  
    295294         
    296295          <div class="comments"> 
    297  
    298296</div> 
    299297             
    … …  
    310308         
    311309          <div class="comments"> 
    312  
    313310</div> 
    314311             
    … …  
    325322         
    326323          <div class="comments"> 
    327  
    328324</div> 
    329325             
    … …  
    340336         
    341337          <div class="comments"> 
    342  
    343338</div> 
    344339             
    … …  
    358353           
    359354           
    360           <h4>Todo items</h4><div class="preformat"> seb</div> 
     355          <h4>Todo items</h4><div class="preformat"> seb 
     356</div> 
    361357           
    362358         
    … …  
    382378        <div class="routine_details" id="_cmapply"> 
    383379 
    384           <h2><a class="top" href="#container">top</a>cmapply <span class="categories">  
     380          <h2><a class="top" href="#container">top</a>cmapply <span class="categories"> 
    385381 Array 
    386382</span></h2> 
    … …  
    433429            </h4> 
    434430         
    435           <div class="comments">  
     431          <div class="comments"> 
    436432 An array of values to be operated on. 
    437433 Must not be of type STRING (7) or STRUCTURE (8). 
    … …  
    451447          <div class="comments"> 
    452448 An array of dimensions that are to be "collapsed", where 
    453  the the first dimension starts with 1 (ie, same convention 
     449 the first dimension starts with 1 (ie, same convention 
    454450 as IDL function TOTAL).  Whereas TOTAL only allows one 
    455451 dimension to be added, you can specify multiple dimensions 
    … …  
    497493            <div class="comments"> 
    498494 Set this to the IDL code of the desired output type (refer 
    499  to documentation of SIZE()).  Internal results will be 
     495 to documentation of <proidl>SIZE</proidl>()).  Internal results will be 
    500496 rounded to the nearest integer if the output type is an 
    501497 integer type. 
    … …  
    580576          <h3>Version history</h3> 
    581577           
    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">  
     578          <h4>Version</h4><div class="preformat"> 
     579 $Id: cmapply.pro 238 2007-03-27 13:43:18Z pinsard $ 
     580</div> 
     581          <h4>History</h4><div class="preformat"> 
    586582 Mar 1998, Written, CM 
    587583   Changed usage message to not bomb, 24 Mar 2000, CM 

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

    r234 r242  
    148148        <div class="routine_details" id="_cmset_op"> 
    149149 
    150           <h2><a class="top" href="#container">top</a>cmset_op <span class="categories">  
     150          <h2><a class="top" href="#container">top</a>cmset_op <span class="categories"> 
    151151 Array 
    152152</span></h2> 
    … …  
    383383          <h3>Version history</h3> 
    384384           
    385           <h4>Version</h4><div class="preformat"> $Id: cmset_op.pro 163 2006-08-29 12:59:46Z navarro $ 
    386 </div> 
    387           <h4>History</h4><div class="preformat"> Written, CM, 23 Feb 2000 
     385          <h4>Version</h4><div class="preformat"> 
     386 $Id: cmset_op.pro 238 2007-03-27 13:43:18Z pinsard $ 
     387</div> 
     388          <h4>History</h4><div class="preformat"> 
     389 Written, CM, 23 Feb 2000 
    388390   Added empty set capability, CM, 25 Feb 2000 
    389391   Documentation clarification, CM 02 Mar 2000 

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

    r234 r242  
    111111       
    112112        <dt><a href="zero_one.html">zero_one.pro</a></dt> 
    113         <dd>   Send back a vector or a matrix constituted of 0 and 1 in alternation </dd> 
     113        <dd>  Send back a vector or a matrix constituted of 0 and 1 in alternation </dd> 
    114114       
    115115      </dl> 

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

    r234 r242  
    129129        <div class="routine_details" id="_extrac2"> 
    130130 
    131           <h2><a class="top" href="#container">top</a>extrac2 <span class="categories">  
     131          <h2><a class="top" href="#container">top</a>extrac2 <span class="categories"> 
    132132 Utilities 
    133133</span></h2> 
    … …  
    233233 I have a dim 2 matrix named A. I want extract a small intersection 
    234234 matrix 2d of the line 2,3 and 7 and of the column 0 and 1: 
    235   
     235 
    236236 IDL> res=extrac2(A,[2,3,7],[0,1]) 
    237237 
    … …  
    247247          <h3>Version history</h3> 
    248248           
    249           <h4>Version</h4><div class="preformat"> $Id: extrac2.pro 231 2007-03-19 17:15:51Z pinsard $ 
    250 </div> 
    251           <h4>History</h4><div class="preformat"> Sebastien Masson (smasson@lodyc.jussieu.fr) 
     249          <h4>Version</h4><div class="preformat"> 
     250 $Id: extrac2.pro 238 2007-03-27 13:43:18Z pinsard $ 
     251</div> 
     252          <h4>History</h4><div class="preformat"> 
     253 Sebastien Masson (smasson@lodyc.jussieu.fr) 
    252254                       12/1/1999 
    253255                       29/4/1999: correction of a bug and complement of the heading 

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

    r234 r242  
    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 not to be 
     135          <div class="comments">  
     136 arrays of positive integers, which need not to be 
    135137 sorted. Duplicate elements are ignored, as they have no effect on the 
    136138 result 
    … …  
    148150            </h4> 
    149151         
    150           <div class="comments"> see a 
     152          <div class="comments">  
     153 see a 
    151154</div> 
    152155             
    … …  
    164167           
    165168          <h4>Version</h4><div class="preformat"> 
    166  $Id: inter.pro 232 2007-03-20 16:59:36Z pinsard $ 
     169 $Id: inter.pro 237 2007-03-26 15:37:03Z pinsard $ 
    167170</div> 
    168171          <h4>History</h4><div class="preformat"> 
    … …  
    175178           
    176179           
    177           <h4>Restrictions</h4><div class="preformat"> The empty set is denoted by an array with the first element equal to 
     180          <h4>Restrictions</h4><div class="preformat">  
     181 The empty set is denoted by an array with the first element equal to 
    178182 -1. 
    179183 
     184  
    180185 These functions will not be efficient on sparse sets with wide 
    181  ranges, as they trade memory for efficiency. The HISTOGRAM function 
     186 ranges, as they trade memory for efficiency.  
     187 The <proidl>HISTOGRAM</proidl> function 
    182188 is used, which creates arrays of size equal to the range of the 
    183189 resulting set. 

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

    r234 r242  
    150150            </h4> 
    151151         
    152           <div class="comments"> see a 
     152          <div class="comments">  
     153 see a 
    153154</div> 
    154155             
    … …  
    166167           
    167168          <h4>Version</h4><div class="preformat"> 
    168  $Id: union.pro 232 2007-03-20 16:59:36Z pinsard $ 
     169 $Id: union.pro 237 2007-03-26 15:37:03Z pinsard $ 
    169170</div> 
    170171          <h4>History</h4><div class="preformat"> 
    … …  
    180181 The empty set is denoted by an array with the first element equal to -1. 
    181182 
     183  
    182184 These functions will not be efficient on sparse sets with wide 
    183  ranges, as they trade memory for efficiency. The HISTOGRAM function 
     185 ranges, as they trade memory for efficiency.  
     186 The <proidl>HISTOGRAM</proidl> function 
    184187 is used, which creates arrays of size equal to the range of the 
    185188 resulting set. 

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

    r234 r242  
    8787      </div> 
    8888 
    89       <div id="file_comments">  
     89      <div id="file_comments"> 
    9090 Send back a vector or a matrix constituted of 0 and 1 in alternation 
    9191</div> 
    … …  
    104104        <div class="routine_details" id="_zero_one"> 
    105105 
    106           <h2><a class="top" href="#container">top</a>zero_one <span class="categories">  
     106          <h2><a class="top" href="#container">top</a>zero_one <span class="categories"> 
    107107 Function, Matrix 
    108108</span></h2> 
    … …  
    113113          <div class="comments"></div> 
    114114 
    115           <h3>Return value</h3><div class="preformat"> result 
    116  </div> 
     115          <h3>Return value</h3><div class="preformat"> 
     116 result 
     117</div> 
    117118 
    118119           
    … …  
    131132            </h4> 
    132133         
    133           <div class="comments"> number of elements in the first dimension</div> 
     134          <div class="comments"> 
     135 number of elements in the first dimension 
     136</div> 
    134137             
    135138            <h4 id="_zero_one_param_n2">n2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    … …  
    144147            </h4> 
    145148         
    146           <div class="comments"> number of elements in the second dimension 
     149          <div class="comments"> 
     150 number of elements in the second dimension 
    147151</div> 
    148152             
    … …  
    155159          <h3>Version history</h3> 
    156160           
    157           <h4>Version</h4><div class="preformat"> $Id: zero_one.pro 231 2007-03-19 17:15:51Z pinsard $ 
    158 </div> 
    159           <h4>History</h4><div class="preformat"> Sebastien Masson (smasson@lodyc.jussieu.fr) 
     161          <h4>Version</h4><div class="preformat"> 
     162 $Id: zero_one.pro 237 2007-03-26 15:37:03Z pinsard $ 
     163</div> 
     164          <h4>History</h4><div class="preformat"> 
     165 Sebastien Masson (smasson@lodyc.jussieu.fr) 
    160166                       1/12/98 
    161167</div> 
Note: See TracChangeset for help on using the changeset viewer.