File: Converting-Numerical-Data-to-Strings.html

package info (click to toggle)
octave 3.8.2-2~bpo70%2B1
  • links: PTS, VCS
  • area: main
  • in suites: wheezy-backports
  • size: 84,360 kB
  • sloc: cpp: 293,356; ansic: 42,041; fortran: 23,669; sh: 13,629; objc: 7,890; yacc: 7,093; lex: 3,442; java: 2,125; makefile: 1,589; perl: 1,009; awk: 974; xml: 34
file content (193 lines) | stat: -rw-r--r-- 8,805 bytes parent folder | download | duplicates (3)
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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- Created by GNU Texinfo 5.2, http://www.gnu.org/software/texinfo/ -->
<head>
<title>GNU Octave: Converting Numerical Data to Strings</title>

<meta name="description" content="GNU Octave: Converting Numerical Data to Strings">
<meta name="keywords" content="GNU Octave: Converting Numerical Data to Strings">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link href="index.html#Top" rel="start" title="Top">
<link href="Concept-Index.html#Concept-Index" rel="index" title="Concept Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Creating-Strings.html#Creating-Strings" rel="up" title="Creating Strings">
<link href="Comparing-Strings.html#Comparing-Strings" rel="next" title="Comparing Strings">
<link href="Concatenating-Strings.html#Concatenating-Strings" rel="prev" title="Concatenating Strings">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.indentedblock {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
div.smalllisp {margin-left: 3.2em}
kbd {font-style:oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
pre.smalldisplay {font-family: inherit; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: inherit; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.nocodebreak {white-space:nowrap}
span.nolinebreak {white-space:nowrap}
span.roman {font-family:serif; font-weight:normal}
span.sansserif {font-family:sans-serif; font-weight:normal}
ul.no-bullet {list-style: none}
-->
</style>


</head>

<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
<a name="Converting-Numerical-Data-to-Strings"></a>
<div class="header">
<p>
Previous: <a href="Concatenating-Strings.html#Concatenating-Strings" accesskey="p" rel="prev">Concatenating Strings</a>, Up: <a href="Creating-Strings.html#Creating-Strings" accesskey="u" rel="up">Creating Strings</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html#Concept-Index" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="Converting-Numerical-Data-to-Strings-1"></a>
<h4 class="subsection">5.3.2 Converting Numerical Data to Strings</h4>
<p>Apart from the string concatenation functions (see <a href="Concatenating-Strings.html#Concatenating-Strings">Concatenating Strings</a>)
which cast numerical data to the corresponding ASCII characters, there are
several functions that format numerical data as strings.  <code>mat2str</code> and
<code>num2str</code> convert real or complex matrices, while <code>int2str</code> converts
integer matrices.  <code>int2str</code> takes the real part of complex values and
round fractional values to integer.  A more flexible way to format numerical
data as strings is the <code>sprintf</code> function (see <a href="Formatted-Output.html#Formatted-Output">Formatted Output</a>,
<a href="Formatted-Output.html#XREFsprintf">sprintf</a>).
</p>
<a name="XREFmat2str"></a><dl>
<dt><a name="index-mat2str"></a>Function File: <em><var>s</var> =</em> <strong>mat2str</strong> <em>(<var>x</var>, <var>n</var>)</em></dt>
<dt><a name="index-mat2str-1"></a>Function File: <em><var>s</var> =</em> <strong>mat2str</strong> <em>(<var>x</var>, <var>n</var>, &quot;class&quot;)</em></dt>
<dd><p>Format real, complex, and logical matrices as strings.  The 
returned string may be used to reconstruct the original matrix by using
the <code>eval</code> function.
</p>
<p>The precision of the values is given by <var>n</var>.  If <var>n</var> is a
scalar then both real and imaginary parts of the matrix are printed
to the same precision.  Otherwise <code><var>n</var>(1)</code> defines the
precision of the real part and <code><var>n</var>(2)</code> defines the
precision of the imaginary part.  The default for <var>n</var> is 15.
</p>
<p>If the argument <code>&quot;class&quot;</code> is given then the class of <var>x</var> is
included in the string in such a way that <code>eval</code> will result in the
construction of a matrix of the same class.
</p>
<div class="example">
<pre class="example">mat2str ([ -1/3 + i/7; 1/3 - i/7 ], [4 2])
     &rArr; &quot;[-0.3333+0.14i;0.3333-0.14i]&quot;

mat2str ([ -1/3 +i/7; 1/3 -i/7 ], [4 2])
     &rArr; &quot;[-0.3333+0i 0+0.14i;0.3333+0i -0-0.14i]&quot;

mat2str (int16 ([1 -1]), &quot;class&quot;)
     &rArr; &quot;int16([1 -1])&quot;

mat2str (logical (eye (2)))
     &rArr; &quot;[true false;false true]&quot;

isequal (x, eval (mat2str (x)))
     &rArr; 1
</pre></div>


<p><strong>See also:</strong> <a href="Formatted-Output.html#XREFsprintf">sprintf</a>, <a href="#XREFnum2str">num2str</a>, <a href="#XREFint2str">int2str</a>.
</p></dd></dl>


<a name="XREFnum2str"></a><dl>
<dt><a name="index-num2str"></a>Function File: <em></em> <strong>num2str</strong> <em>(<var>x</var>)</em></dt>
<dt><a name="index-num2str-1"></a>Function File: <em></em> <strong>num2str</strong> <em>(<var>x</var>, <var>precision</var>)</em></dt>
<dt><a name="index-num2str-2"></a>Function File: <em></em> <strong>num2str</strong> <em>(<var>x</var>, <var>format</var>)</em></dt>
<dd><p>Convert a number (or array) to a string (or a character array).  The
optional second argument may either give the number of significant
digits (<var>precision</var>) to be used in the output or a format
template string (<var>format</var>) as in <code>sprintf</code> (see <a href="Formatted-Output.html#Formatted-Output">Formatted Output</a>).  <code>num2str</code> can also handle complex numbers.
</p>
<p>Examples:
</p>
<div class="example">
<pre class="example">num2str (123.456)
     &rArr; &quot;123.46&quot;

num2str (123.456, 4)
     &rArr; &quot;123.5&quot;

s = num2str ([1, 1.34; 3, 3.56], &quot;%5.1f&quot;)
     &rArr; s =
        1.0  1.3
        3.0  3.6
whos s
     &rArr;
      Attr Name        Size                     Bytes  Class
      ==== ====        ====                     =====  =====
           s           2x8                         16  char

num2str (1.234 + 27.3i)
     &rArr; &quot;1.234+27.3i&quot;
</pre></div>

<p>Notes:
</p>
<p>For <small>MATLAB</small> compatibility, leading spaces are stripped before returning
the string.
</p>
<p>The <code>num2str</code> function is not very flexible.  For better control
over the results, use <code>sprintf</code> (see <a href="Formatted-Output.html#Formatted-Output">Formatted Output</a>).
</p>
<p>For complex <var>x</var>, the format string may only contain one
output conversion specification and nothing else.  Otherwise, results
will be unpredictable.
</p>
<p><strong>See also:</strong> <a href="Formatted-Output.html#XREFsprintf">sprintf</a>, <a href="#XREFint2str">int2str</a>, <a href="#XREFmat2str">mat2str</a>.
</p></dd></dl>


<a name="XREFint2str"></a><dl>
<dt><a name="index-int2str"></a>Function File: <em></em> <strong>int2str</strong> <em>(<var>n</var>)</em></dt>
<dd><p>Convert an integer (or array of integers) to a string (or a character
array).
</p>
<div class="example">
<pre class="example">int2str (123)
     &rArr; &quot;123&quot;

s = int2str ([1, 2, 3; 4, 5, 6])
     &rArr; s =
        1  2  3
        4  5  6

whos s
     &rArr;
      Attr Name        Size                     Bytes  Class
      ==== ====        ====                     =====  =====
           s           2x7                         14  char
</pre></div>

<p>This function is not very flexible.  For better control over the
results, use <code>sprintf</code> (see <a href="Formatted-Output.html#Formatted-Output">Formatted Output</a>).
</p>
<p><strong>See also:</strong> <a href="Formatted-Output.html#XREFsprintf">sprintf</a>, <a href="#XREFnum2str">num2str</a>, <a href="#XREFmat2str">mat2str</a>.
</p></dd></dl>


<hr>
<div class="header">
<p>
Previous: <a href="Concatenating-Strings.html#Concatenating-Strings" accesskey="p" rel="prev">Concatenating Strings</a>, Up: <a href="Creating-Strings.html#Creating-Strings" accesskey="u" rel="up">Creating Strings</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html#Concept-Index" title="Index" rel="index">Index</a>]</p>
</div>



</body>
</html>