annotate scripts/io/dlmwrite.m @ 20170:af2b7695f1c4 draft default tip @

gallery.m: clean and vectorize part of qmult. * scripts/special-matrix/gallery.m: make qmult() follow Octave guidelines, vectorize last for loop in qmult().
author Antonio Pino Robles <data.script93@gmail.com>
date Thu, 28 May 2015 18:32:47 +0200
parents e51473fdb622
children 03b9d17a2d95
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
19697
4197fc428c7d maint: Update copyright notices for 2015.
John W. Eaton <jwe@octave.org>
parents: 19278
diff changeset
1 ## Copyright (C) 2002-2015 Paul Kienzle
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
2 ##
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
3 ## This file is part of Octave.
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
4 ##
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
8 ## your option) any later version.
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
9 ##
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
13 ## General Public License for more details.
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
14 ##
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
17 ## <http://www.gnu.org/licenses/>.
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
18
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
19 ## -*- texinfo -*-
11471
994e2a93a8e2 Use uppercase 'A' to refer to matrix inputs in m-files.
Rik <octave@nomad.inbox5.com>
parents: 11032
diff changeset
20 ## @deftypefn {Function File} {} dlmwrite (@var{file}, @var{M})
994e2a93a8e2 Use uppercase 'A' to refer to matrix inputs in m-files.
Rik <octave@nomad.inbox5.com>
parents: 11032
diff changeset
21 ## @deftypefnx {Function File} {} dlmwrite (@var{file}, @var{M}, @var{delim}, @var{r}, @var{c})
994e2a93a8e2 Use uppercase 'A' to refer to matrix inputs in m-files.
Rik <octave@nomad.inbox5.com>
parents: 11032
diff changeset
22 ## @deftypefnx {Function File} {} dlmwrite (@var{file}, @var{M}, @var{key}, @var{val} @dots{})
994e2a93a8e2 Use uppercase 'A' to refer to matrix inputs in m-files.
Rik <octave@nomad.inbox5.com>
parents: 11032
diff changeset
23 ## @deftypefnx {Function File} {} dlmwrite (@var{file}, @var{M}, "-append", @dots{})
13765
0d4c6d54b6a3 dlmwrite.m: Restore ability to use FID instead of filename.
Rik <octave@nomad.inbox5.com>
parents: 12462
diff changeset
24 ## @deftypefnx {Function File} {} dlmwrite (@var{fid}, @dots{})
11471
994e2a93a8e2 Use uppercase 'A' to refer to matrix inputs in m-files.
Rik <octave@nomad.inbox5.com>
parents: 11032
diff changeset
25 ## Write the matrix @var{M} to the named file using delimiters.
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
26 ##
10936
1d761a30c3fb support file IDs in dlmwrite
Jaroslav Hajek <highegg@gmail.com>
parents: 10793
diff changeset
27 ## @var{file} should be a file name or writable file ID given by @code{fopen}.
1d761a30c3fb support file IDs in dlmwrite
Jaroslav Hajek <highegg@gmail.com>
parents: 10793
diff changeset
28 ##
7590
780cf056eb85 dlmwrite doc fix
John W. Eaton <jwe@octave.org>
parents: 7581
diff changeset
29 ## The parameter @var{delim} specifies the delimiter to use to separate
780cf056eb85 dlmwrite doc fix
John W. Eaton <jwe@octave.org>
parents: 7581
diff changeset
30 ## values on a row.
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
31 ##
7590
780cf056eb85 dlmwrite doc fix
John W. Eaton <jwe@octave.org>
parents: 7581
diff changeset
32 ## The value of @var{r} specifies the number of delimiter-only lines to
780cf056eb85 dlmwrite doc fix
John W. Eaton <jwe@octave.org>
parents: 7581
diff changeset
33 ## add to the start of the file.
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
34 ##
7590
780cf056eb85 dlmwrite doc fix
John W. Eaton <jwe@octave.org>
parents: 7581
diff changeset
35 ## The value of @var{c} specifies the number of delimiters to prepend to
780cf056eb85 dlmwrite doc fix
John W. Eaton <jwe@octave.org>
parents: 7581
diff changeset
36 ## each line of data.
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
37 ##
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 16995
diff changeset
38 ## If the argument @qcode{"-append"} is given, append to the end of
7590
780cf056eb85 dlmwrite doc fix
John W. Eaton <jwe@octave.org>
parents: 7581
diff changeset
39 ## @var{file}.
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
40 ##
7590
780cf056eb85 dlmwrite doc fix
John W. Eaton <jwe@octave.org>
parents: 7581
diff changeset
41 ## In addition, the following keyword value pairs may appear at the end
780cf056eb85 dlmwrite doc fix
John W. Eaton <jwe@octave.org>
parents: 7581
diff changeset
42 ## of the argument list:
14327
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
43 ##
11595
5ec6aa05638d Prevent doubled quotes around @table items in Info.
Rik <octave@nomad.inbox5.com>
parents: 11588
diff changeset
44 ## @table @asis
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 16995
diff changeset
45 ## @item @qcode{"append"}
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 16995
diff changeset
46 ## Either @qcode{"on"} or @qcode{"off"}. See @qcode{"-append"} above.
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
47 ##
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 16995
diff changeset
48 ## @item @qcode{"delimiter"}
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
49 ## See @var{delim} above.
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
50 ##
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 16995
diff changeset
51 ## @item @qcode{"newline"}
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
52 ## The character(s) to use to separate each row. Three special cases
20101
e51473fdb622 doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 19697
diff changeset
53 ## exist for this option. @qcode{"unix"} is changed into
e51473fdb622 doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 19697
diff changeset
54 ## @qcode{"@xbackslashchar{}n"}, @qcode{"pc"} is changed into
e51473fdb622 doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 19697
diff changeset
55 ## @qcode{"@xbackslashchar{}r@xbackslashchar{}n"}, and @qcode{"mac"} is changed
e51473fdb622 doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 19697
diff changeset
56 ## into @qcode{"@xbackslashchar{}r"}. Any other value is used directly as the
e51473fdb622 doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 19697
diff changeset
57 ## newline separator.
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
58 ##
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 16995
diff changeset
59 ## @item @qcode{"roffset"}
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
60 ## See @var{r} above.
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
61 ##
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 16995
diff changeset
62 ## @item @qcode{"coffset"}
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
63 ## See @var{c} above.
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
64 ##
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 16995
diff changeset
65 ## @item @qcode{"precision"}
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
66 ## The precision to use when writing the file. It can either be a
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
67 ## format string (as used by fprintf) or a number of significant digits.
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
68 ## @end table
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
69 ##
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
70 ## @example
7590
780cf056eb85 dlmwrite doc fix
John W. Eaton <jwe@octave.org>
parents: 7581
diff changeset
71 ## dlmwrite ("file.csv", reshape (1:16, 4, 4));
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
72 ## @end example
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
73 ##
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
74 ## @example
20101
e51473fdb622 doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 19697
diff changeset
75 ## dlmwrite ("file.tex", a, "delimiter", "&", "newline", "\n")
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
76 ## @end example
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
77 ##
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
78 ## @seealso{dlmread, csvread, csvwrite}
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
79 ## @end deftypefn
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
80
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
81 ## Author: Paul Kienzle <pkienzle@users.sf.net>
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
82 ##
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
83 ## This program was originally granted to the public domain
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
84 ##
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
85 ## 2002-03-08 Paul Kienzle <pkienzle@users.sf.net>
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
86 ## * Initial revision
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
87 ## 2005-11-27 Bill Denney <bill@givebillmoney.com>
16668
0c9aaceadc33 * dlmwrite.m: Fix typo.
Andreas Weber <andreas.weber@hs-offenburg.de>
parents: 14868
diff changeset
88 ## * Significant modifications of the input arguments for additional
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
89 ## functionality.
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
90
11471
994e2a93a8e2 Use uppercase 'A' to refer to matrix inputs in m-files.
Rik <octave@nomad.inbox5.com>
parents: 11032
diff changeset
91 function dlmwrite (file, M, varargin)
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
92
13765
0d4c6d54b6a3 dlmwrite.m: Restore ability to use FID instead of filename.
Rik <octave@nomad.inbox5.com>
parents: 12462
diff changeset
93 if (nargin < 2)
9630
d52e405df4f7 dlmwrite.m: fix typo
John W. Eaton <jwe@octave.org>
parents: 9051
diff changeset
94 print_usage ();
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
95 endif
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
96
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
97 ## set defaults
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
98 delim = ",";
13765
0d4c6d54b6a3 dlmwrite.m: Restore ability to use FID instead of filename.
Rik <octave@nomad.inbox5.com>
parents: 12462
diff changeset
99 r = c = 0;
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
100 newline = "\n";
11471
994e2a93a8e2 Use uppercase 'A' to refer to matrix inputs in m-files.
Rik <octave@nomad.inbox5.com>
parents: 11032
diff changeset
101 if (ischar (M))
8509
841f8e3370c6 dlmwrite.m: use '%c' format for character data
John W. Eaton <jwe@octave.org>
parents: 7591
diff changeset
102 precision = "%c";
841f8e3370c6 dlmwrite.m: use '%c' format for character data
John W. Eaton <jwe@octave.org>
parents: 7591
diff changeset
103 else
841f8e3370c6 dlmwrite.m: use '%c' format for character data
John W. Eaton <jwe@octave.org>
parents: 7591
diff changeset
104 precision = "%.16g";
841f8e3370c6 dlmwrite.m: use '%c' format for character data
John W. Eaton <jwe@octave.org>
parents: 7591
diff changeset
105 endif
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
106 opentype = "wt";
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
107
13765
0d4c6d54b6a3 dlmwrite.m: Restore ability to use FID instead of filename.
Rik <octave@nomad.inbox5.com>
parents: 12462
diff changeset
108 ## process the input arguments
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
109 i = 0;
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
110 while (i < length (varargin))
13765
0d4c6d54b6a3 dlmwrite.m: Restore ability to use FID instead of filename.
Rik <octave@nomad.inbox5.com>
parents: 12462
diff changeset
111 i++;
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
112 if (strcmpi (varargin{i}, "delimiter"))
13765
0d4c6d54b6a3 dlmwrite.m: Restore ability to use FID instead of filename.
Rik <octave@nomad.inbox5.com>
parents: 12462
diff changeset
113 delim = varargin{++i};
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
114 elseif (strcmpi (varargin{i}, "newline"))
13765
0d4c6d54b6a3 dlmwrite.m: Restore ability to use FID instead of filename.
Rik <octave@nomad.inbox5.com>
parents: 12462
diff changeset
115 newline = varargin{++i};
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
116 if (strcmpi (newline, "unix"))
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 9630
diff changeset
117 newline = "\n";
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
118 elseif (strcmpi (newline, "pc"))
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 9630
diff changeset
119 newline = "\r\n";
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
120 elseif (strcmpi (newline, "mac"))
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 9630
diff changeset
121 newline = "\r";
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
122 endif
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
123 elseif (strcmpi (varargin{i}, "roffset"))
13765
0d4c6d54b6a3 dlmwrite.m: Restore ability to use FID instead of filename.
Rik <octave@nomad.inbox5.com>
parents: 12462
diff changeset
124 r = varargin{++i};
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
125 elseif (strcmpi (varargin{i}, "coffset"))
13765
0d4c6d54b6a3 dlmwrite.m: Restore ability to use FID instead of filename.
Rik <octave@nomad.inbox5.com>
parents: 12462
diff changeset
126 c = varargin{++i};
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
127 elseif (strcmpi (varargin{i}, "precision"))
13765
0d4c6d54b6a3 dlmwrite.m: Restore ability to use FID instead of filename.
Rik <octave@nomad.inbox5.com>
parents: 12462
diff changeset
128 precision = varargin{++i};
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
129 if (! strcmpi (class (precision), "char"))
10626
044d9df4d79a Correctly set output precision (#29870) in dlmwrite
Rik <octave@nomad.inbox5.com>
parents: 10549
diff changeset
130 precision = sprintf ("%%.%gg", precision);
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
131 endif
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
132 elseif (strcmpi (varargin{i}, "-append"))
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
133 opentype = "at";
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
134 elseif (strcmpi (varargin{i}, "append"))
13765
0d4c6d54b6a3 dlmwrite.m: Restore ability to use FID instead of filename.
Rik <octave@nomad.inbox5.com>
parents: 12462
diff changeset
135 i++;
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
136 if (strcmpi (varargin{i}, "on"))
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 9630
diff changeset
137 opentype = "at";
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
138 elseif (strcmpi (varargin{i}, "off"))
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 9630
diff changeset
139 opentype = "wt";
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
140 else
13765
0d4c6d54b6a3 dlmwrite.m: Restore ability to use FID instead of filename.
Rik <octave@nomad.inbox5.com>
parents: 12462
diff changeset
141 error ('dlmwrite: append must be "on" or "off"');
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
142 endif
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
143 else
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
144 if (i == 1)
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 9630
diff changeset
145 delim = varargin{i};
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
146 elseif (i == 2)
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 9630
diff changeset
147 r = varargin{i};
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
148 elseif (i == 3)
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 9630
diff changeset
149 c = varargin{i};
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
150 else
14846
460a3c6d8bf1 maint: Use Octave coding convention for cuddled parenthis in function calls with empty argument lists.
Rik <octave@nomad.inbox5.com>
parents: 14363
diff changeset
151 print_usage ();
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
152 endif
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
153 endif
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
154 endwhile
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
155
16995
1a1e831fe6b4 dlmwrite.m: Expand '\t' to TAB when used as delimiter for Matlab compatibility (bug #39505).
Rik <rik@octave.org>
parents: 16668
diff changeset
156 ## Expand '\t' to TAB for Matlab compatibility
1a1e831fe6b4 dlmwrite.m: Expand '\t' to TAB when used as delimiter for Matlab compatibility (bug #39505).
Rik <rik@octave.org>
parents: 16668
diff changeset
157 if (strcmp (delim, '\t'))
1a1e831fe6b4 dlmwrite.m: Expand '\t' to TAB when used as delimiter for Matlab compatibility (bug #39505).
Rik <rik@octave.org>
parents: 16668
diff changeset
158 delim = "\t";
1a1e831fe6b4 dlmwrite.m: Expand '\t' to TAB when used as delimiter for Matlab compatibility (bug #39505).
Rik <rik@octave.org>
parents: 16668
diff changeset
159 endif
1a1e831fe6b4 dlmwrite.m: Expand '\t' to TAB when used as delimiter for Matlab compatibility (bug #39505).
Rik <rik@octave.org>
parents: 16668
diff changeset
160
10936
1d761a30c3fb support file IDs in dlmwrite
Jaroslav Hajek <highegg@gmail.com>
parents: 10793
diff changeset
161 if (ischar (file))
1d761a30c3fb support file IDs in dlmwrite
Jaroslav Hajek <highegg@gmail.com>
parents: 10793
diff changeset
162 [fid, msg] = fopen (file, opentype);
1d761a30c3fb support file IDs in dlmwrite
Jaroslav Hajek <highegg@gmail.com>
parents: 10793
diff changeset
163 elseif (isscalar (file) && isnumeric (file))
13765
0d4c6d54b6a3 dlmwrite.m: Restore ability to use FID instead of filename.
Rik <octave@nomad.inbox5.com>
parents: 12462
diff changeset
164 [fid, msg] = deal (file, "invalid file number");
10936
1d761a30c3fb support file IDs in dlmwrite
Jaroslav Hajek <highegg@gmail.com>
parents: 10793
diff changeset
165 else
11472
1740012184f9 Use uppercase for variable names in error() strings to match Info documentation. Only m-files done.
Rik <octave@nomad.inbox5.com>
parents: 11471
diff changeset
166 error ("dlmwrite: FILE must be a filename string or numeric FID");
10936
1d761a30c3fb support file IDs in dlmwrite
Jaroslav Hajek <highegg@gmail.com>
parents: 10793
diff changeset
167 endif
1d761a30c3fb support file IDs in dlmwrite
Jaroslav Hajek <highegg@gmail.com>
parents: 10793
diff changeset
168
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
169 if (fid < 0)
13765
0d4c6d54b6a3 dlmwrite.m: Restore ability to use FID instead of filename.
Rik <octave@nomad.inbox5.com>
parents: 12462
diff changeset
170 error (["dlmwrite: " msg]);
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
171 else
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
172 if (r > 0)
7581
e0d7bb35a3ec style fixes
John W. Eaton <jwe@octave.org>
parents: 7580
diff changeset
173 fprintf (fid, "%s",
11471
994e2a93a8e2 Use uppercase 'A' to refer to matrix inputs in m-files.
Rik <octave@nomad.inbox5.com>
parents: 11032
diff changeset
174 repmat ([repmat(delim, 1, c + columns(M)-1), newline], 1, r));
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
175 endif
11471
994e2a93a8e2 Use uppercase 'A' to refer to matrix inputs in m-files.
Rik <octave@nomad.inbox5.com>
parents: 11032
diff changeset
176 if (iscomplex (M))
13765
0d4c6d54b6a3 dlmwrite.m: Restore ability to use FID instead of filename.
Rik <octave@nomad.inbox5.com>
parents: 12462
diff changeset
177 cprecision = regexprep (precision, '^%([-\d.])', '%+$1');
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
178 template = [precision, cprecision, "i", ...
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 9630
diff changeset
179 repmat([delim, precision, cprecision, "i"], 1, ...
11471
994e2a93a8e2 Use uppercase 'A' to refer to matrix inputs in m-files.
Rik <octave@nomad.inbox5.com>
parents: 11032
diff changeset
180 columns(M) - 1), newline ];
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
181 else
11471
994e2a93a8e2 Use uppercase 'A' to refer to matrix inputs in m-files.
Rik <octave@nomad.inbox5.com>
parents: 11032
diff changeset
182 template = [precision, repmat([delim, precision], 1, columns(M)-1),...
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 9630
diff changeset
183 newline];
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
184 endif
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
185 if (c > 0)
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
186 template = [repmat(delim, 1, c), template];
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
187 endif
11471
994e2a93a8e2 Use uppercase 'A' to refer to matrix inputs in m-files.
Rik <octave@nomad.inbox5.com>
parents: 11032
diff changeset
188 if (iscomplex (M))
994e2a93a8e2 Use uppercase 'A' to refer to matrix inputs in m-files.
Rik <octave@nomad.inbox5.com>
parents: 11032
diff changeset
189 M = M.';
14868
5d3a684236b0 maint: Use Octave coding conventions for cuddling parentheses in scripts directory
Rik <octave@nomad.inbox5.com>
parents: 14846
diff changeset
190 b = zeros (2*rows (M), columns (M));
11471
994e2a93a8e2 Use uppercase 'A' to refer to matrix inputs in m-files.
Rik <octave@nomad.inbox5.com>
parents: 11032
diff changeset
191 b(1: 2 : end, :) = real (M);
994e2a93a8e2 Use uppercase 'A' to refer to matrix inputs in m-files.
Rik <octave@nomad.inbox5.com>
parents: 11032
diff changeset
192 b(2: 2 : end, :) = imag (M);
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
193 fprintf (fid, template, b);
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
194 else
11471
994e2a93a8e2 Use uppercase 'A' to refer to matrix inputs in m-files.
Rik <octave@nomad.inbox5.com>
parents: 11032
diff changeset
195 fprintf (fid, template, M.');
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
196 endif
10940
306e40d773a9 don't fclose stream in dlmwrite
Jaroslav Hajek <highegg@gmail.com>
parents: 10936
diff changeset
197 if (! isscalar (file))
306e40d773a9 don't fclose stream in dlmwrite
Jaroslav Hajek <highegg@gmail.com>
parents: 10936
diff changeset
198 fclose (fid);
306e40d773a9 don't fclose stream in dlmwrite
Jaroslav Hajek <highegg@gmail.com>
parents: 10936
diff changeset
199 endif
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
200 endif
13765
0d4c6d54b6a3 dlmwrite.m: Restore ability to use FID instead of filename.
Rik <octave@nomad.inbox5.com>
parents: 12462
diff changeset
201
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
202 endfunction
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
203
13765
0d4c6d54b6a3 dlmwrite.m: Restore ability to use FID instead of filename.
Rik <octave@nomad.inbox5.com>
parents: 12462
diff changeset
204
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
205 %!test
19278
6ca096827123 Use tempname() rather than tmpnam() in core Octave.
Rik <rik@octave.org>
parents: 17744
diff changeset
206 %! f = tempname ();
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14327
diff changeset
207 %! dlmwrite (f,[1,2;3,4],"precision","%5.2f","newline","unix","roffset",1,"coffset",1);
13765
0d4c6d54b6a3 dlmwrite.m: Restore ability to use FID instead of filename.
Rik <octave@nomad.inbox5.com>
parents: 12462
diff changeset
208 %! fid = fopen (f,"rt");
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14327
diff changeset
209 %! f1 = char (fread (fid,Inf,"char")');
13765
0d4c6d54b6a3 dlmwrite.m: Restore ability to use FID instead of filename.
Rik <octave@nomad.inbox5.com>
parents: 12462
diff changeset
210 %! fclose (fid);
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14327
diff changeset
211 %! dlmwrite (f,[5,6],"precision","%5.2f","newline","unix","coffset",1,"delimiter",",","-append");
13765
0d4c6d54b6a3 dlmwrite.m: Restore ability to use FID instead of filename.
Rik <octave@nomad.inbox5.com>
parents: 12462
diff changeset
212 %! fid = fopen (f,"rt");
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14327
diff changeset
213 %! f2 = char (fread (fid,Inf,"char")');
13765
0d4c6d54b6a3 dlmwrite.m: Restore ability to use FID instead of filename.
Rik <octave@nomad.inbox5.com>
parents: 12462
diff changeset
214 %! fclose (fid);
0d4c6d54b6a3 dlmwrite.m: Restore ability to use FID instead of filename.
Rik <octave@nomad.inbox5.com>
parents: 12462
diff changeset
215 %! unlink (f);
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
216 %!
13765
0d4c6d54b6a3 dlmwrite.m: Restore ability to use FID instead of filename.
Rik <octave@nomad.inbox5.com>
parents: 12462
diff changeset
217 %! assert (f1,",,\n, 1.00, 2.00\n, 3.00, 4.00\n");
0d4c6d54b6a3 dlmwrite.m: Restore ability to use FID instead of filename.
Rik <octave@nomad.inbox5.com>
parents: 12462
diff changeset
218 %! assert (f2,",,\n, 1.00, 2.00\n, 3.00, 4.00\n, 5.00, 6.00\n");
0d4c6d54b6a3 dlmwrite.m: Restore ability to use FID instead of filename.
Rik <octave@nomad.inbox5.com>
parents: 12462
diff changeset
219