source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/STRING/strsed.html @ 402

Last change on this file since 402 was 402, checked in by smasson, 15 years ago

update documentation
File size: 5.6 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>strsed.pro (SAXO 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="strsed.pro (SAXO Documentation)";
19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
26  <h1>SAXO 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" title="Overview of library">Overview</a></td>
36     
37
38     
39      <td >Directory</td>
40     
41
42     
43      <td><a href="./../../idldoc-categories.html" title="Browse library by category">Categories</a></td>
44     
45
46     
47      <td><a href="./../../idldoc-index.html" title="Index of files, routines, and parameters">Index</a></td>
48     
49
50     
51      <td><a href="./../../search-page.html" title="Search library">Search</a></td>
52     
53
54      <td id="selected">File</td>
55
56     
57      <td><a href="../../../../ToBeReviewed/STRING//strsed.pro" title="Source code of a file">Source</a></td>
58     
59
60     
61      <td><a href="./../../idldoc-help.html" 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="strsci.html">&lt;&lt;prev file</a> | <a href="strtok.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="strsed.html" target="_TOP">view single page</a> | <a href="./../../index.html" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | routine&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">ToBeReviewed/STRING/</a></h1>
82      <h2 class="pro_file">strsed.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments"> 
90 replace one (or more) character(s)/string(s) in a string array
91 "modern" version of the obsolete strrepl
92</div>
93
94     
95
96     
97
98     
99
100     
101
102      <div id="routine_details">
103       
104
105        <div class="routine_details" id="_strsed">
106
107          <h2><a class="top" href="#container">top</a>strsed <span class="categories">
108 String
109</span></h2>
110       
111          <p class="header">
112            <span class="result">result = </span>strsed(<span class="result"><a href="#_strsed_param_str">str</a>, <a href="#_strsed_param_exp1">exp1</a>, <a href="#_strsed_param_exp2">exp2</a></span>, <a href="#_strsed_keyword_FOLD_CASE">FOLD_CASE</a>=<span class="result">FOLD_CASE</span>)</p>
113       
114          <div class="comments">
115</div>
116
117          <h3>Return value</h3><div class="preformat">
118 string array or scalar
119</div>
120
121         
122            <h3>Parameters</h3>
123       
124           
125            <h4 id="_strsed_param_str">str&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
126              <span class="attr">in</span>
127             
128             
129              <span class="attr">required</span>
130             
131              <span class="attr">type:</span> <span class="value">string array or scalar</span>
132             
133             
134            </h4>
135       
136          <div class="comments">
137 the string to be changed
138</div>
139           
140            <h4 id="_strsed_param_exp1">exp1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
141              <span class="attr">in</span>
142             
143             
144              <span class="attr">required</span>
145             
146              <span class="attr">type:</span> <span class="value">scalar string</span>
147             
148             
149            </h4>
150       
151          <div class="comments">
152 a single regular expression (as implemented by the STREGEX function).
153</div>
154           
155            <h4 id="_strsed_param_exp2">exp2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
156              <span class="attr">in</span>
157             
158             
159              <span class="attr">required</span>
160             
161              <span class="attr">type:</span> <span class="value">scalar string</span>
162             
163             
164            </h4>
165       
166          <div class="comments">
167 replacement character/string
168</div>
169           
170
171         
172
173         
174
175            <h3>Keywords</h3>
176           
177            <h4 id="_strsed_keyword_FOLD_CASE">FOLD_CASE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
178             
179             
180             
181             
182             
183             
184             
185             
186            </h4>
187       
188            <div class="comments">
189 Indicates that the regular expression matching should be done in
190 a case-insensitive fashion.
191</div>
192           
193         
194
195          <h3>Examples</h3><div class="preformat">
196
197   IDL> abc = 'abcdefghijklmnopqrstuvwxyz'
198   IDL> print, strsed(abc, 'm', 'M')
199    abcdefghijklMnopqrstuvwxyz
200   IDL> print, strsed(abc, 'm.*t', 'M_T')
201    abcdefghijklM_Tuvwxyz
202   IDL> a = 'abcabcabc'
203   IDL> help, strsed([abc, a, 'eee'], 'abc', 'XXX_')
204    <Expression>    STRING    = Array[3]
205   IDL> print, strsed([abc, a, 'eee'], 'abc', 'XXX_')
206    XXX_defghijklmnopqrstuvwxyz XXX_XXX_XXX_ eee
207</div>
208          <h3>Version history</h3>
209         
210          <h4>Version</h4><div class="preformat">
211 $Id: strsed.pro 372 2008-08-08 12:31:53Z pinsard $</div>
212          <h4>History</h4><div class="preformat">
213 Sept 2006: Sebastien Masson (smasson@lodyc.jussieu.fr)
214</div>
215         
216         
217         
218         
219         
220         
221         
222       
223         
224         
225         
226         
227         
228         
229         
230       
231          <h3>Statistics</h3>
232          <table class="statistics">
233            <tr><td>McCabe cyclic</td><td>           3</td></tr>
234            <tr><td>McCabe essential</td><td>           1</td></tr>
235            <tr><td>McCabe modular design</td><td>           1</td></tr>
236          </table>
237         
238       
239        </div>
240       
241      </div>
242
243     
244
245      <div id="tagline">Produced by IDLdoc 2.0.</div>
246
247    </div>
248
249  </body>
250</html>
Note: See TracBrowser for help on using the repository browser.