File: Common-String-Operations.html

package info (click to toggle)
octave 10.3.0-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 145,388 kB
  • sloc: cpp: 335,976; ansic: 82,241; fortran: 20,963; objc: 9,402; sh: 8,756; yacc: 4,392; lex: 4,333; perl: 1,544; java: 1,366; awk: 1,259; makefile: 659; xml: 192
file content (249 lines) | stat: -rw-r--r-- 13,016 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
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
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
<!DOCTYPE html>
<html>
<!-- Created by GNU Texinfo 7.1.1, https://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Common String Operations (GNU Octave (version 10.3.0))</title>

<meta name="description" content="Common String Operations (GNU Octave (version 10.3.0))">
<meta name="keywords" content="Common String Operations (GNU Octave (version 10.3.0))">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta name="viewport" content="width=device-width,initial-scale=1">

<link href="index.html" rel="start" title="Top">
<link href="Concept-Index.html" rel="index" title="Concept Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="String-Operations.html" rel="up" title="String Operations">
<link href="Concatenating-Strings.html" rel="next" title="Concatenating Strings">
<style type="text/css">
<!--
a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
div.example {margin-left: 3.2em}
span:hover a.copiable-link {visibility: visible}
strong.def-name {font-family: monospace; font-weight: bold; font-size: larger}
-->
</style>
<link rel="stylesheet" type="text/css" href="octave.css">


</head>

<body lang="en">
<div class="subsection-level-extent" id="Common-String-Operations">
<div class="nav-panel">
<p>
Next: <a href="Concatenating-Strings.html" accesskey="n" rel="next">Concatenating Strings</a>, Up: <a href="String-Operations.html" accesskey="u" rel="up">String Operations</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<h4 class="subsection" id="Common-String-Operations-1"><span>5.3.1 Common String Operations<a class="copiable-link" href="#Common-String-Operations-1"> &para;</a></span></h4>

<p>The following functions are useful to perform common String operations.
</p>
<a class="anchor" id="XREFlower"></a><span style="display:block; margin-top:-4.5ex;">&nbsp;</span>


<dl class="first-deftypefn">
<dt class="deftypefn" id="index-lower"><span><code class="def-type"><var class="var">y</var> =</code> <strong class="def-name">lower</strong> <code class="def-code-arguments">(<var class="var">s</var>)</code><a class="copiable-link" href="#index-lower"> &para;</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-tolower"><span><code class="def-type"><var class="var">y</var> =</code> <strong class="def-name">tolower</strong> <code class="def-code-arguments">(<var class="var">s</var>)</code><a class="copiable-link" href="#index-tolower"> &para;</a></span></dt>
<dd><p>Return a copy of the string or cell string <var class="var">s</var>, with each uppercase
character replaced by the corresponding lowercase one; non-alphabetic
characters are left unchanged.
</p>
<p>For example:
</p>
<div class="example">
<div class="group"><pre class="example-preformatted">lower (&quot;MiXeD cAsE 123&quot;)
    &rArr; &quot;mixed case 123&quot;
</pre></div></div>

<p>Programming Note: <code class="code">tolower</code> is an alias for <code class="code">lower</code> and either name
can be used in Octave.
</p>

<p><strong class="strong">See also:</strong> <a class="ref" href="#XREFupper">upper</a>.
</p></dd></dl>


<a class="anchor" id="XREFupper"></a><span style="display:block; margin-top:-4.5ex;">&nbsp;</span>


<dl class="first-deftypefn">
<dt class="deftypefn" id="index-upper"><span><code class="def-type"><var class="var">y</var> =</code> <strong class="def-name">upper</strong> <code class="def-code-arguments">(<var class="var">s</var>)</code><a class="copiable-link" href="#index-upper"> &para;</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-toupper"><span><code class="def-type"><var class="var">y</var> =</code> <strong class="def-name">toupper</strong> <code class="def-code-arguments">(<var class="var">s</var>)</code><a class="copiable-link" href="#index-toupper"> &para;</a></span></dt>
<dd><p>Return a copy of the string or cell string <var class="var">s</var>, with each lowercase
character replaced by the corresponding uppercase one; non-alphabetic
characters are left unchanged.
</p>
<p>For example:
</p>
<div class="example">
<div class="group"><pre class="example-preformatted">upper (&quot;MiXeD cAsE 123&quot;)
    &rArr; &quot;MIXED CASE 123&quot;
</pre></div></div>

<p>Programming Note: <code class="code">toupper</code> is an alias for <code class="code">upper</code> and either name
can be used in Octave.
</p>

<p><strong class="strong">See also:</strong> <a class="ref" href="#XREFlower">lower</a>.
</p></dd></dl>


<a class="anchor" id="XREFdeblank"></a><span style="display:block; margin-top:-4.5ex;">&nbsp;</span>


<dl class="first-deftypefn">
<dt class="deftypefn" id="index-deblank"><span><code class="def-type"><var class="var">s</var> =</code> <strong class="def-name">deblank</strong> <code class="def-code-arguments">(<var class="var">s</var>)</code><a class="copiable-link" href="#index-deblank"> &para;</a></span></dt>
<dd><p>Remove trailing whitespace and nulls from <var class="var">s</var>.
</p>
<p>If <var class="var">s</var> is a matrix, <var class="var">deblank</var> trims each row to the length of
the longest string.  If <var class="var">s</var> is a cell array of strings, operate
recursively on each string element.
</p>
<p>Examples:
</p>
<div class="example">
<div class="group"><pre class="example-preformatted">deblank (&quot;    abc  &quot;)
     &rArr;  &quot;    abc&quot;

deblank ([&quot; abc   &quot;; &quot;   def   &quot;])
     &rArr;  [&quot; abc  &quot; ; &quot;   def&quot;]
</pre></div></div>

<p><strong class="strong">See also:</strong> <a class="ref" href="#XREFstrtrim">strtrim</a>.
</p></dd></dl>


<a class="anchor" id="XREFstrtrim"></a><span style="display:block; margin-top:-4.5ex;">&nbsp;</span>


<dl class="first-deftypefn">
<dt class="deftypefn" id="index-strtrim"><span><code class="def-type"><var class="var">s</var> =</code> <strong class="def-name">strtrim</strong> <code class="def-code-arguments">(<var class="var">s</var>)</code><a class="copiable-link" href="#index-strtrim"> &para;</a></span></dt>
<dd><p>Remove leading and trailing whitespace from <var class="var">s</var>.
</p>
<p>If <var class="var">s</var> is a matrix, <var class="var">strtrim</var> trims each row to the length of
longest string.  If <var class="var">s</var> is a cell array of strings, operate recursively
on each string element.
</p>
<p>For example:
</p>
<div class="example">
<div class="group"><pre class="example-preformatted">strtrim (&quot;    abc  &quot;)
     &rArr;  &quot;abc&quot;

strtrim ([&quot; abc   &quot;; &quot;   def   &quot;])
     &rArr;  [&quot;abc  &quot;  ; &quot;  def&quot;]
</pre></div></div>

<p><strong class="strong">See also:</strong> <a class="ref" href="#XREFdeblank">deblank</a>.
</p></dd></dl>


<a class="anchor" id="XREFstrtrunc"></a><span style="display:block; margin-top:-4.5ex;">&nbsp;</span>


<dl class="first-deftypefn">
<dt class="deftypefn" id="index-strtrunc"><span><code class="def-type"><var class="var">s</var> =</code> <strong class="def-name">strtrunc</strong> <code class="def-code-arguments">(<var class="var">s</var>, <var class="var">n</var>)</code><a class="copiable-link" href="#index-strtrunc"> &para;</a></span></dt>
<dd><p>Truncate the character string <var class="var">s</var> to length <var class="var">n</var>.
</p>
<p>If <var class="var">s</var> is a character matrix, then the number of columns is adjusted.
</p>
<p>If <var class="var">s</var> is a cell array of strings, then the operation is performed
on each cell element and the new cell array is returned.
</p></dd></dl>


<a class="anchor" id="XREFuntabify"></a><span style="display:block; margin-top:-4.5ex;">&nbsp;</span>


<dl class="first-deftypefn">
<dt class="deftypefn" id="index-untabify"><span><code class="def-type"><var class="var">str</var> =</code> <strong class="def-name">untabify</strong> <code class="def-code-arguments">(<var class="var">t</var>)</code><a class="copiable-link" href="#index-untabify"> &para;</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-untabify-1"><span><code class="def-type"><var class="var">str</var> =</code> <strong class="def-name">untabify</strong> <code class="def-code-arguments">(<var class="var">t</var>, <var class="var">tw</var>)</code><a class="copiable-link" href="#index-untabify-1"> &para;</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-untabify-2"><span><code class="def-type"><var class="var">str</var> =</code> <strong class="def-name">untabify</strong> <code class="def-code-arguments">(<var class="var">t</var>, <var class="var">tw</var>, <var class="var">deblank</var>)</code><a class="copiable-link" href="#index-untabify-2"> &para;</a></span></dt>
<dd><p>Replace TAB characters in <var class="var">t</var> with spaces.
</p>
<p>The input, <var class="var">t</var>, may be either a 2-D character array, or a cell array of
character strings.  The output is the same class as the input.
</p>
<p>The tab width is specified by <var class="var">tw</var>, and defaults to eight.
</p>
<p>If the optional argument <var class="var">deblank</var> is true, then the spaces will be
removed from the end of the character data.
</p>
<p>The following example reads a file and writes an untabified version of the
same file with trailing spaces stripped.
</p>
<div class="example">
<div class="group"><pre class="example-preformatted">fid = fopen (&quot;tabbed_script.m&quot;);
text = char (fread (fid, &quot;uchar&quot;)');
fclose (fid);
fid = fopen (&quot;untabified_script.m&quot;, &quot;w&quot;);
text = untabify (strsplit (text, &quot;\n&quot;), 8, true);
fprintf (fid, &quot;%s\n&quot;, text{:});
fclose (fid);
</pre></div></div>


<p><strong class="strong">See also:</strong> <a class="ref" href="Character-Arrays.html#XREFstrjust">strjust</a>, <a class="ref" href="Splitting-and-Joining-Strings.html#XREFstrsplit">strsplit</a>, <a class="ref" href="#XREFdeblank">deblank</a>.
</p></dd></dl>


<a class="anchor" id="XREFdo_005fstring_005fescapes"></a><span style="display:block; margin-top:-4.5ex;">&nbsp;</span>


<dl class="first-deftypefn">
<dt class="deftypefn" id="index-do_005fstring_005fescapes"><span><code class="def-type"><var class="var">newstr</var> =</code> <strong class="def-name">do_string_escapes</strong> <code class="def-code-arguments">(<var class="var">string</var>)</code><a class="copiable-link" href="#index-do_005fstring_005fescapes"> &para;</a></span></dt>
<dd><p>Convert escape sequences in <var class="var">string</var> to the characters they represent.
</p>
<p>Escape sequences begin with a leading backslash
(<code class="code">'\'</code>) followed by 1&ndash;3 characters
(.e.g., <code class="code">&quot;\n&quot;</code> =&gt; newline).
</p>
<p><strong class="strong">See also:</strong> <a class="ref" href="#XREFundo_005fstring_005fescapes">undo_string_escapes</a>.
</p></dd></dl>


<a class="anchor" id="XREFundo_005fstring_005fescapes"></a><span style="display:block; margin-top:-4.5ex;">&nbsp;</span>


<dl class="first-deftypefn">
<dt class="deftypefn" id="index-undo_005fstring_005fescapes"><span><code class="def-type"><var class="var">newstr</var> =</code> <strong class="def-name">undo_string_escapes</strong> <code class="def-code-arguments">(<var class="var">string</var>)</code><a class="copiable-link" href="#index-undo_005fstring_005fescapes"> &para;</a></span></dt>
<dd><p>Convert special characters in <var class="var">string</var> back to their escaped forms.
</p>
<p>For example, the expression
</p>
<div class="example">
<pre class="example-preformatted"><var class="var">bell</var> = &quot;\a&quot;;
</pre></div>

<p>assigns the value of the alert character (control-g, ASCII code 7) to the
string variable <code class="code">bell</code>.  If this string is printed, the system will
ring the terminal bell (if it is possible).  This is normally the desired
outcome.  However, sometimes it is useful to be able to print the original
representation of the string, with the special characters replaced by their
escape sequences.  For example,
</p>
<div class="example">
<div class="group"><pre class="example-preformatted">octave:13&gt; undo_string_escapes (bell)
ans = \a
</pre></div></div>

<p>replaces the unprintable alert character with its printable representation.
</p>
<p><strong class="strong">See also:</strong> <a class="ref" href="#XREFdo_005fstring_005fescapes">do_string_escapes</a>.
</p></dd></dl>


</div>
<hr>
<div class="nav-panel">
<p>
Next: <a href="Concatenating-Strings.html">Concatenating Strings</a>, Up: <a href="String-Operations.html">String Operations</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html" title="Index" rel="index">Index</a>]</p>
</div>



</body>
</html>