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
|
<html lang="en">
<head>
<title>Binary I/O - GNU Octave</title>
<meta http-equiv="Content-Type" content="text/html">
<meta name="description" content="GNU Octave">
<meta name="generator" content="makeinfo 4.13">
<link title="Top" rel="start" href="index.html#Top">
<link rel="up" href="C_002dStyle-I_002fO-Functions.html#C_002dStyle-I_002fO-Functions" title="C-Style I/O Functions">
<link rel="prev" href="String-Input-Conversions.html#String-Input-Conversions" title="String Input Conversions">
<link rel="next" href="Temporary-Files.html#Temporary-Files" title="Temporary Files">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
pre.display { font-family:inherit }
pre.format { font-family:inherit }
pre.smalldisplay { font-family:inherit; font-size:smaller }
pre.smallformat { font-family:inherit; font-size:smaller }
pre.smallexample { font-size:smaller }
pre.smalllisp { font-size:smaller }
span.sc { font-variant:small-caps }
span.roman { font-family:serif; font-weight:normal; }
span.sansserif { font-family:sans-serif; font-weight:normal; }
--></style>
</head>
<body>
<div class="node">
<a name="Binary-I%2fO"></a>
<a name="Binary-I_002fO"></a>
<p>
Next: <a rel="next" accesskey="n" href="Temporary-Files.html#Temporary-Files">Temporary Files</a>,
Previous: <a rel="previous" accesskey="p" href="String-Input-Conversions.html#String-Input-Conversions">String Input Conversions</a>,
Up: <a rel="up" accesskey="u" href="C_002dStyle-I_002fO-Functions.html#C_002dStyle-I_002fO-Functions">C-Style I/O Functions</a>
<hr>
</div>
<h4 class="subsection">14.2.16 Binary I/O</h4>
<p>Octave can read and write binary data using the functions <code>fread</code>
and <code>fwrite</code>, which are patterned after the standard C functions
with the same names. They are able to automatically swap the byte order
of integer data and convert among the supported floating point formats
as the data are read.
<!-- fread src/file-io.cc -->
<p><a name="doc_002dfread"></a>
<div class="defun">
— Built-in Function: [<var>val</var>, <var>count</var>] = <b>fread</b> (<var>fid, size, precision, skip, arch</var>)<var><a name="index-fread-1007"></a></var><br>
<blockquote><p>Read binary data of type <var>precision</var> from the specified file ID
<var>fid</var>.
<p>The optional argument <var>size</var> specifies the amount of data to read
and may be one of
<dl>
<dt><code>Inf</code><dd>Read as much as possible, returning a column vector.
<br><dt><var>nr</var><dd>Read up to <var>nr</var> elements, returning a column vector.
<br><dt><code>[</code><var>nr</var><code>, Inf]</code><dd>Read as much as possible, returning a matrix with <var>nr</var> rows. If the
number of elements read is not an exact multiple of <var>nr</var>, the last
column is padded with zeros.
<br><dt><code>[</code><var>nr</var><code>, </code><var>nc</var><code>]</code><dd>Read up to <var>nr</var><code> * </code><var>nc</var> elements, returning a matrix with
<var>nr</var> rows. If the number of elements read is not an exact multiple
of <var>nr</var>, the last column is padded with zeros.
</dl>
<p class="noindent">If <var>size</var> is omitted, a value of <code>Inf</code> is assumed.
<p>The optional argument <var>precision</var> is a string specifying the type of
data to read and may be one of
<dl>
<dt>"schar"<dt>"signed char"<dd>Signed character.
<br><dt>"uchar"<dt>"unsigned char"<dd>Unsigned character.
<br><dt>"int8"<dt>"integer*1"<dd>
8-bit signed integer.
<br><dt>"int16"<dt>"integer*2"<dd>16-bit signed integer.
<br><dt>"int32"<dt>"integer*4"<dd>32-bit signed integer.
<br><dt>"int64"<dt>"integer*8"<dd>64-bit signed integer.
<br><dt>"uint8"<dd>8-bit unsigned integer.
<br><dt>"uint16"<dd>16-bit unsigned integer.
<br><dt>"uint32"<dd>32-bit unsigned integer.
<br><dt>"uint64"<dd>64-bit unsigned integer.
<br><dt>"single"<dt>"float32"<dt>"real*4"<dd>32-bit floating point number.
<br><dt>"double"<dt>"float64"<dt>"real*8"<dd>64-bit floating point number.
<br><dt>"char"<dt>"char*1"<dd>Single character.
<br><dt>"short"<dd>Short integer (size is platform dependent).
<br><dt>"int"<dd>Integer (size is platform dependent).
<br><dt>"long"<dd>Long integer (size is platform dependent).
<br><dt>"ushort"<dt>"unsigned short"<dd>Unsigned short integer (size is platform dependent).
<br><dt>"uint"<dt>"unsigned int"<dd>Unsigned integer (size is platform dependent).
<br><dt>"ulong"<dt>"unsigned long"<dd>Unsigned long integer (size is platform dependent).
<br><dt>"float"<dd>Single precision floating point number (size is platform dependent).
</dl>
<p class="noindent">The default precision is <code>"uchar"</code>.
<p>The <var>precision</var> argument may also specify an optional repeat
count. For example, ‘<samp><span class="samp">32*single</span></samp>’ causes <code>fread</code> to read
a block of 32 single precision floating point numbers. Reading in
blocks is useful in combination with the <var>skip</var> argument.
<p>The <var>precision</var> argument may also specify a type conversion.
For example, ‘<samp><span class="samp">int16=>int32</span></samp>’ causes <code>fread</code> to read 16-bit
integer values and return an array of 32-bit integer values. By
default, <code>fread</code> returns a double precision array. The special
form ‘<samp><span class="samp">*TYPE</span></samp>’ is shorthand for ‘<samp><span class="samp">TYPE=>TYPE</span></samp>’.
<p>The conversion and repeat counts may be combined. For example, the
specification ‘<samp><span class="samp">32*single=>single</span></samp>’ causes <code>fread</code> to read
blocks of single precision floating point values and return an array
of single precision values instead of the default array of double
precision values.
<p>The optional argument <var>skip</var> specifies the number of bytes to skip
after each element (or block of elements) is read. If it is not
specified, a value of 0 is assumed. If the final block read is not
complete, the final skip is omitted. For example,
<pre class="example"> fread (f, 10, "3*single=>single", 8)
</pre>
<p class="noindent">will omit the final 8-byte skip because the last read will not be
a complete block of 3 values.
<p>The optional argument <var>arch</var> is a string specifying the data format
for the file. Valid values are
<dl>
<dt><code>"native"</code><dd>The format of the current machine.
<br><dt><code>"ieee-be"</code><dd>IEEE big endian.
<br><dt><code>"ieee-le"</code><dd>IEEE little endian.
<br><dt><code>"vaxd"</code><dd>VAX D floating format.
<br><dt><code>"vaxg"</code><dd>VAX G floating format.
<br><dt><code>"cray"</code><dd>Cray floating format.
</dl>
<p class="noindent">Conversions are currently only supported for <code>"ieee-be"</code> and
<code>"ieee-le"</code> formats.
<p>The data read from the file is returned in <var>val</var>, and the number of
values read is returned in <code>count</code>
<!-- Texinfo @sp should work but in practice produces ugly results for HTML. -->
<!-- A simple blank line produces the correct behavior. -->
<!-- @sp 1 -->
<p class="noindent"><strong>See also:</strong> <a href="doc_002dfwrite.html#doc_002dfwrite">fwrite</a>, <a href="doc_002dfopen.html#doc_002dfopen">fopen</a>, <a href="doc_002dfclose.html#doc_002dfclose">fclose</a>.
</p></blockquote></div>
<!-- fwrite src/file-io.cc -->
<p><a name="doc_002dfwrite"></a>
<div class="defun">
— Built-in Function: <var>count</var> = <b>fwrite</b> (<var>fid, data, precision, skip, arch</var>)<var><a name="index-fwrite-1008"></a></var><br>
<blockquote><p>Write data in binary form of type <var>precision</var> to the specified file
ID <var>fid</var>, returning the number of values successfully written to the
file.
<p>The argument <var>data</var> is a matrix of values that are to be written to
the file. The values are extracted in column-major order.
<p>The remaining arguments <var>precision</var>, <var>skip</var>, and <var>arch</var> are
optional, and are interpreted as described for <code>fread</code>.
<p>The behavior of <code>fwrite</code> is undefined if the values in <var>data</var>
are too large to fit in the specified precision.
<!-- Texinfo @sp should work but in practice produces ugly results for HTML. -->
<!-- A simple blank line produces the correct behavior. -->
<!-- @sp 1 -->
<p class="noindent"><strong>See also:</strong> <a href="doc_002dfread.html#doc_002dfread">fread</a>, <a href="doc_002dfopen.html#doc_002dfopen">fopen</a>, <a href="doc_002dfclose.html#doc_002dfclose">fclose</a>.
</p></blockquote></div>
</body></html>
|
