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
|
########################################################################
##
## Copyright (C) 2002-2024 The Octave Project Developers
##
## See the file COPYRIGHT.md in the top-level directory of this
## distribution or <https://octave.org/copyright/>.
##
## This file is part of Octave.
##
## Octave is free software: you can redistribute it and/or modify it
## under the terms of the GNU General Public License as published by
## the Free Software Foundation, either version 3 of the License, or
## (at your option) any later version.
##
## Octave is distributed in the hope that it will be useful, but
## WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
## GNU General Public License for more details.
##
## You should have received a copy of the GNU General Public License
## along with Octave; see the file COPYING. If not, see
## <https://www.gnu.org/licenses/>.
##
########################################################################
## -*- texinfo -*-
## @deftypefn {} {} dlmwrite (@var{file}, @var{M})
## @deftypefnx {} {} dlmwrite (@var{file}, @var{M}, @var{delim}, @var{r}, @var{c})
## @deftypefnx {} {} dlmwrite (@var{file}, @var{M}, @var{key}, @var{val} @dots{})
## @deftypefnx {} {} dlmwrite (@var{file}, @var{M}, "-append", @dots{})
## @deftypefnx {} {} dlmwrite (@var{fid}, @dots{})
## Write the numeric matrix @var{M} to the text file @var{file} using a
## delimiter.
##
## @var{file} should be a filename or a writable file ID given by @code{fopen}.
##
## The parameter @var{delim} specifies the delimiter to use to separate values
## on a row. If no delimiter is specified the comma character @samp{,} is
## used.
##
## The value of @var{r} specifies the number of delimiter-only lines to add to
## the start of the file.
##
## The value of @var{c} specifies the number of delimiters to prepend to each
## line of data.
##
## If the argument @qcode{"-append"} is given, append to the end of @var{file}.
##
## In addition, the following keyword value pairs may appear at the end of
## the argument list:
##
## @table @asis
## @item @qcode{"append"}
## Either @qcode{"on"} or @qcode{"off"}. See @qcode{"-append"} above.
##
## @item @qcode{"delimiter"}
## See @var{delim} above.
##
## @item @qcode{"newline"}
## The character(s) to separate each row. Three special cases exist for this
## option. @qcode{"unix"} is changed into @qcode{"@backslashchar{}n"},
## @qcode{"pc"} is changed into @qcode{"@backslashchar{}r@backslashchar{}n"},
## and @qcode{"mac"} is changed into @qcode{"@backslashchar{}r"}. Any other
## value is used directly as the newline separator.
##
## @item @qcode{"roffset"}
## See @var{r} above.
##
## @item @qcode{"coffset"}
## See @var{c} above.
##
## @item @qcode{"precision"}
## The precision to use when writing the file. It can either be a format
## string (as used by fprintf) or a number of significant digits.
## @end table
##
## @example
## dlmwrite ("file.csv", reshape (1:16, 4, 4));
## @end example
##
## @example
## dlmwrite ("file.tex", a, "delimiter", "&", "newline", "\n")
## @end example
##
## @seealso{dlmread, csvread, csvwrite}
## @end deftypefn
## Author: Paul Kienzle <pkienzle@users.sf.net>
##
## This program was originally granted to the public domain
##
## 2002-03-08 Paul Kienzle <pkienzle@users.sf.net>
## * Initial revision
## 2005-11-27 Bill Denney <bill@givebillmoney.com>
## * Significant modifications of the input arguments for additional
## functionality.
function dlmwrite (file, M, varargin)
if (nargin < 2)
print_usage ();
endif
## set defaults
delim = ",";
r = c = 0;
newline = "\n";
if (ischar (M))
precision = "%c";
else
precision = "%.16g";
endif
opentype = "wt";
## process the input arguments
i = 0;
while (i < length (varargin))
i += 1;
if (strcmpi (varargin{i}, "delimiter"))
delim = varargin{++i};
elseif (strcmpi (varargin{i}, "newline"))
newline = varargin{++i};
if (strcmpi (newline, "unix"))
newline = "\n";
elseif (strcmpi (newline, "pc"))
newline = "\r\n";
elseif (strcmpi (newline, "mac"))
newline = "\r";
endif
elseif (strcmpi (varargin{i}, "roffset"))
r = varargin{++i};
elseif (strcmpi (varargin{i}, "coffset"))
c = varargin{++i};
elseif (strcmpi (varargin{i}, "precision"))
precision = varargin{++i};
if (! strcmpi (class (precision), "char"))
precision = sprintf ("%%.%gg", precision);
endif
elseif (strcmpi (varargin{i}, "-append"))
opentype = "at";
elseif (strcmpi (varargin{i}, "append"))
i += 1;
if (strcmpi (varargin{i}, "on"))
opentype = "at";
elseif (strcmpi (varargin{i}, "off"))
opentype = "wt";
else
error ('dlmwrite: append must be "on" or "off"');
endif
else
if (i == 1)
delim = varargin{i};
elseif (i == 2)
r = varargin{i};
elseif (i == 3)
c = varargin{i};
else
print_usage ();
endif
endif
endwhile
## Expand '\t' to TAB for Matlab compatibility
if (strcmp (delim, '\t'))
delim = "\t";
endif
if (ischar (file))
[fid, msg] = fopen (file, opentype);
elseif (is_valid_file_id (file))
[fid, msg] = deal (file, "invalid file number");
else
error ("dlmwrite: FILE must be a filename string or numeric FID");
endif
if (fid < 0)
error (["dlmwrite: " msg]);
else
if (r > 0)
fprintf (fid, "%s",
repmat ([repmat(delim, 1, c + columns(M)-1), newline], 1, r));
endif
if (iscomplex (M))
cprecision = regexprep (precision, '^%([-\d.])', '%+$1');
template = [precision, cprecision, "i", ...
repmat([delim, precision, cprecision, "i"], 1, ...
columns(M) - 1), newline ];
else
template = [precision, repmat([delim, precision], 1, columns(M)-1),...
newline];
endif
if (c > 0)
template = [repmat(delim, 1, c), template];
endif
if (iscomplex (M))
M = M.';
b = zeros (2*rows (M), columns (M));
b(1: 2 : end, :) = real (M);
b(2: 2 : end, :) = imag (M);
fprintf (fid, template, b);
else
fprintf (fid, template, M.');
endif
if (ischar (file))
fclose (fid);
endif
endif
endfunction
%!test
%! f = tempname ();
%! dlmwrite (f,[1,2;3,4],"precision","%5.2f","newline","unix","roffset",1,"coffset",1);
%! fid = fopen (f,"rt");
%! f1 = char (fread (fid,Inf,"char")');
%! fclose (fid);
%! dlmwrite (f,[5,6],"precision","%5.2f","newline","unix","coffset",1,"delimiter",",","-append");
%! fid = fopen (f,"rt");
%! f2 = char (fread (fid,Inf,"char")');
%! fclose (fid);
%! unlink (f);
%!
%! assert (f1,",,\n, 1.00, 2.00\n, 3.00, 4.00\n");
%! assert (f2,",,\n, 1.00, 2.00\n, 3.00, 4.00\n, 5.00, 6.00\n");
|
