source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/MATRICE/colle.html @ 89

Last change on this file since 89 was 89, checked in by pinsard, 18 years ago

add idldoc html output. see Documentation/idldoc_html_output/index.html

File size: 10.7 KB
Line 
1
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4
5<!-- Generated by IDLdoc 2.0 -->
6
7<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
8  <head>
9    <title>colle.pro (IDLdoc API documentation)</title>
10
11   
12    <link rel="stylesheet" type="text/css" media="all" href="./../../main_files.css" />
13    <link rel="stylesheet" type="text/css" media="print" href="./../../main_files_print.css" />
14   
15
16    <script type="text/javascript">
17      function setTitle() {
18        parent.document.title="colle.pro (IDLdoc API documentation)";
19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
26  <h1>IDLdoc API documentation</h1>
27</div>
28
29
30<div id="main_navbar">
31
32  <table cellspacing="0">
33    <tr>
34     
35      <td><a href="./../../overview.html?format=raw" title="Overview of library">Overview</a></td>
36     
37
38     
39      <td >Directory</td>
40     
41
42     
43      <td><a href="./../../idldoc-categories.html?format=raw" title="Browse library by category">Categories</a></td>
44     
45
46     
47      <td><a href="./../../idldoc-index.html?format=raw" title="Index of files, routines, and parameters">Index</a></td>
48     
49
50     
51      <td><a href="./../../search-page.html?format=raw" title="Search library">Search</a></td>
52     
53
54      <td id="selected">File</td>
55
56     
57      <td >Source</td>
58     
59
60     
61      <td><a href="./../../idldoc-help.html?format=raw" title="Help on IDLdoc">Help</a></td>
62     
63
64      <td >Etc</td>
65
66      <td id="flexible">Developer&nbsp;documentation</td>
67    </tr>
68  </table>
69
70</div>
71
72<div id="secondary_navbar">
73
74<a href="cmset_op.html">&lt;&lt;prev file</a> | <a href="congridseb.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="colle.html" target="_TOP">view single page</a> | <a href="./../../index.html?format=raw" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | <a href="#routine_summary">routine</a>&nbsp;&nbsp;&nbsp;&nbsp;details: <a href="#routine_details">routine</a>
75
76</div>
77
78
79    <div id="container">
80
81      <h1 class="directory"><a href="directory-overview.html?format=raw">ToBeReviewed/MATRICE/</a></h1>
82      <h2 class="pro_file">colle.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments"></div>
90
91     
92
93     
94
95     
96
97     
98      <div id="routine_summary">               
99        <h2>Routine summary</h2>
100       
101        <dl>
102         
103          <dt><p><a href="#_UNDEFINE">UNDEFINE<span class="result">, varname</span></a></p><dt>
104          <dd>  NAME:colle   PURPOSE: Cette fonction de concatenation existe ds IDL (avec [] cf  ds le programme ds le case pour direc egale 1,2,3) tant que l''on ne  cherche pas a coller suivant une dimensionsuperieure ou egale a 4.</dd> 
105         
106          <dt><p><a href="#_colle"><span class="result">result = </span>colle(<span class="result">a0, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15, a16, a17, a18, a19, a20</span>, SAUVE=<span class="result">SAUVE</span>)</a></p><dt>
107          <dd></dd>     
108               
109        </dl>
110      </div>
111     
112
113      <div id="routine_details">
114       
115
116        <div class="routine_details" id="_UNDEFINE">
117
118          <h2><a class="top" href="#container">top</a>UNDEFINE </h2>
119       
120          <p class="header">
121            UNDEFINE<span class="result">, <a href="#_UNDEFINE_param_varname">varname</a></span></p>
122       
123          <div class="comments">
124 NAME:colle
125
126 PURPOSE: Cette fonction de concatenation existe ds IDL (avec [] cf
127 ds le programme ds le case pour direc egale 1,2,3) tant que l''on ne
128 cherche pas a coller suivant une dimensionsuperieure ou egale a 4. 
129
130 CATEGORY:bidouillage de matrice
131
132 CALLING SEQUENCE:res=colle(bableau_de_pointeur,direc) ou bien
133                  res=colle(tab1,tab2,tab3,tab4,.....,direc)
134
135 INPUTS:
136         
137        CAS 1:
138        tableau_de_pointeur:comme son nom l''indique c'est un tableau
139        de pointeur, dont chaque elements pointe sur tableau a coller
140
141        par ex ds un programme, on veut coller n tableaux entre eux
142
143          tab=ptrarr(n,/allocate_heap)
144          for i=0,n-1 do begin
145             *tab[n]=replicate(n,2,3)
146          endfor
147          res=colle(tab,1)
148
149        CAS 2:
150        on donne directement les tableaux a coller
151        rq: ds ce cas on peut au plus donner 20 tableaux en entree.
152
153        ATTENTION : sans le mot cle /SAUVE les arguments en entree
154        sont detruits lorsque l''on construit res. ds le cas 1 on
155        detruit le tableau de pointeurs et les variables sur
156        lesquelles on pointe.
157
158        direc: la direction suivant laquelle les coller, 1,2,3...
159
160 KEYWORD PARAMETERS:
161
162         /SAUVE: mot cle qui force a sauvegarder le tableau de
163         pointeur et les tableaux a coller.
164
165 OUTPUTS:res=matrice resultat
166
167 RESTRICTIONS:
168
169 EXAMPLE:
170 
171         IDL> print, colle(replicate(1,2,2,2),indgen(2,2,2),2)   
172                1       1
173                1       1
174                0       1
175                2       3
176
177                1       1
178                1       1
179                4       5
180                6       7
181</div>
182
183         
184
185         
186            <h3>Parameters</h3>
187       
188           
189            <h4 id="_UNDEFINE_param_varname">varname&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
190             
191             
192             
193             
194             
195             
196             
197             
198            </h4>
199       
200          <div class="comments"></div>
201           
202
203         
204
205         
206
207         
208         
209         
210         
211         
212         
213         
214         
215         
216         
217         
218         
219       
220         
221         
222         
223         
224         
225         
226         
227       
228         
229       
230        </div>
231       
232
233        <div class="routine_details" id="_colle">
234
235          <h2><a class="top" href="#container">top</a>colle </h2>
236       
237          <p class="header">
238            <span class="result">result = </span>colle(<span class="result"><a href="#_colle_param_a0">a0</a>, <a href="#_colle_param_a1">a1</a>, <a href="#_colle_param_a2">a2</a>, <a href="#_colle_param_a3">a3</a>, <a href="#_colle_param_a4">a4</a>, <a href="#_colle_param_a5">a5</a>, <a href="#_colle_param_a6">a6</a>, <a href="#_colle_param_a7">a7</a>, <a href="#_colle_param_a8">a8</a>, <a href="#_colle_param_a9">a9</a>, <a href="#_colle_param_a10">a10</a>, <a href="#_colle_param_a11">a11</a>, <a href="#_colle_param_a12">a12</a>, <a href="#_colle_param_a13">a13</a>, <a href="#_colle_param_a14">a14</a>, <a href="#_colle_param_a15">a15</a>, <a href="#_colle_param_a16">a16</a>, <a href="#_colle_param_a17">a17</a>, <a href="#_colle_param_a18">a18</a>, <a href="#_colle_param_a19">a19</a>, <a href="#_colle_param_a20">a20</a></span>, <a href="#_colle_keyword_SAUVE">SAUVE</a>=<span class="result">SAUVE</span>)</p>
239       
240          <div class="comments"></div>
241
242         
243
244         
245            <h3>Parameters</h3>
246       
247           
248            <h4 id="_colle_param_a0">a0&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
249             
250             
251             
252             
253             
254             
255             
256             
257            </h4>
258       
259          <div class="comments"></div>
260           
261            <h4 id="_colle_param_a1">a1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
262             
263             
264             
265             
266             
267             
268             
269             
270            </h4>
271       
272          <div class="comments"></div>
273           
274            <h4 id="_colle_param_a2">a2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
275             
276             
277             
278             
279             
280             
281             
282             
283            </h4>
284       
285          <div class="comments"></div>
286           
287            <h4 id="_colle_param_a3">a3&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
288             
289             
290             
291             
292             
293             
294             
295             
296            </h4>
297       
298          <div class="comments"></div>
299           
300            <h4 id="_colle_param_a4">a4&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
301             
302             
303             
304             
305             
306             
307             
308             
309            </h4>
310       
311          <div class="comments"></div>
312           
313            <h4 id="_colle_param_a5">a5&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
314             
315             
316             
317             
318             
319             
320             
321             
322            </h4>
323       
324          <div class="comments"></div>
325           
326            <h4 id="_colle_param_a6">a6&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
327             
328             
329             
330             
331             
332             
333             
334             
335            </h4>
336       
337          <div class="comments"></div>
338           
339            <h4 id="_colle_param_a7">a7&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
340             
341             
342             
343             
344             
345             
346             
347             
348            </h4>
349       
350          <div class="comments"></div>
351           
352            <h4 id="_colle_param_a8">a8&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
353             
354             
355             
356             
357             
358             
359             
360             
361            </h4>
362       
363          <div class="comments"></div>
364           
365            <h4 id="_colle_param_a9">a9&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
366             
367             
368             
369             
370             
371             
372             
373             
374            </h4>
375       
376          <div class="comments"></div>
377           
378            <h4 id="_colle_param_a10">a10&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
379             
380             
381             
382             
383             
384             
385             
386             
387            </h4>
388       
389          <div class="comments"></div>
390           
391            <h4 id="_colle_param_a11">a11&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
392             
393             
394             
395             
396             
397             
398             
399             
400            </h4>
401       
402          <div class="comments"></div>
403           
404            <h4 id="_colle_param_a12">a12&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
405             
406             
407             
408             
409             
410             
411             
412             
413            </h4>
414       
415          <div class="comments"></div>
416           
417            <h4 id="_colle_param_a13">a13&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
418             
419             
420             
421             
422             
423             
424             
425             
426            </h4>
427       
428          <div class="comments"></div>
429           
430            <h4 id="_colle_param_a14">a14&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
431             
432             
433             
434             
435             
436             
437             
438             
439            </h4>
440       
441          <div class="comments"></div>
442           
443            <h4 id="_colle_param_a15">a15&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
444             
445             
446             
447             
448             
449             
450             
451             
452            </h4>
453       
454          <div class="comments"></div>
455           
456            <h4 id="_colle_param_a16">a16&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
457             
458             
459             
460             
461             
462             
463             
464             
465            </h4>
466       
467          <div class="comments"></div>
468           
469            <h4 id="_colle_param_a17">a17&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
470             
471             
472             
473             
474             
475             
476             
477             
478            </h4>
479       
480          <div class="comments"></div>
481           
482            <h4 id="_colle_param_a18">a18&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
483             
484             
485             
486             
487             
488             
489             
490             
491            </h4>
492       
493          <div class="comments"></div>
494           
495            <h4 id="_colle_param_a19">a19&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
496             
497             
498             
499             
500             
501             
502             
503             
504            </h4>
505       
506          <div class="comments"></div>
507           
508            <h4 id="_colle_param_a20">a20&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
509             
510             
511             
512             
513             
514             
515             
516             
517            </h4>
518       
519          <div class="comments"></div>
520           
521
522         
523
524         
525
526            <h3>Keywords</h3>
527           
528            <h4 id="_colle_keyword_SAUVE">SAUVE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
529             
530             
531             
532             
533             
534             
535             
536             
537            </h4>
538       
539            <div class="comments"></div>
540           
541         
542
543         
544         
545         
546         
547         
548         
549         
550         
551         
552         
553         
554         
555       
556         
557         
558         
559         
560         
561         
562         
563       
564         
565       
566        </div>
567       
568      </div>
569
570     
571
572      <div id="tagline">Produced by IDLdoc 2.0.</div>
573
574    </div>
575
576  </body>
577</html>
Note: See TracBrowser for help on using the repository browser.