Mercurial > octave

annotate scripts/io/dlmwrite.m @ 33632:fed0dc6fd44c default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
remove unused variable from libgui/module.mk * libgui/module.mk: remove empty variable OCTAVE_GUI_EDITOR_MOC
author Torsten Lilge <ttl-octave@mailbox.org>
date Mon, 27 May 2024 19:42:05 +0200
parents 2e484f9f1f18
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
27923
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
1 ########################################################################
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
2 ##
32632
2e484f9f1f18 maint: update Octave Project Developers copyright for the new year
John W. Eaton <jwe@octave.org>
parents: 31706
diff changeset
3 ## Copyright (C) 2002-2024 The Octave Project Developers
27918
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
4 ##
27923
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
5 ## See the file COPYRIGHT.md in the top-level directory of this
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
6 ## distribution or <https://octave.org/copyright/>.
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
7 ##
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
8 ## This file is part of Octave.
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
9 ##
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 24422
diff changeset
10 ## Octave is free software: you can redistribute it and/or modify it
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
11 ## under the terms of the GNU General Public License as published by
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 24422
diff changeset
12 ## the Free Software Foundation, either version 3 of the License, or
22755
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22323
diff changeset
13 ## (at your option) any later version.
7580
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 ## 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
16 ## WITHOUT ANY WARRANTY; without even the implied warranty of
22755
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22323
diff changeset
17 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22323
diff changeset
18 ## GNU General Public License for more details.
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
19 ##
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
20 ## 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
21 ## along with Octave; see the file COPYING. If not, see
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 24422
diff changeset
22 ## <https://www.gnu.org/licenses/>.
27923
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
23 ##
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
24 ########################################################################
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
25
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
26 ## -*- texinfo -*-
20852
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents: 20735
diff changeset
27 ## @deftypefn {} {} dlmwrite (@var{file}, @var{M})
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents: 20735
diff changeset
28 ## @deftypefnx {} {} dlmwrite (@var{file}, @var{M}, @var{delim}, @var{r}, @var{c})
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents: 20735
diff changeset
29 ## @deftypefnx {} {} dlmwrite (@var{file}, @var{M}, @var{key}, @var{val} @dots{})
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents: 20735
diff changeset
30 ## @deftypefnx {} {} dlmwrite (@var{file}, @var{M}, "-append", @dots{})
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents: 20735
diff changeset
31 ## @deftypefnx {} {} dlmwrite (@var{fid}, @dots{})
21549
17845d0e359f doc: Remove unecessary whitespace and end of docstrings.
Rik <rik@octave.org>
parents: 21362
diff changeset
32 ## Write the numeric matrix @var{M} to the text file @var{file} using a
21362
1bb9a34011d1 doc: Specify that only numeric data are allowed for delimited file I/O (bug #46248).
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 20852
diff changeset
33 ## delimiter.
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
34 ##
21362
1bb9a34011d1 doc: Specify that only numeric data are allowed for delimited file I/O (bug #46248).
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 20852
diff changeset
35 ## @var{file} should be a filename or a writable file ID given by @code{fopen}.
10936
1d761a30c3fb support file IDs in dlmwrite
Jaroslav Hajek <highegg@gmail.com>
parents: 10793
diff changeset
36 ##
20160
03b9d17a2d95 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20101
diff changeset
37 ## The parameter @var{delim} specifies the delimiter to use to separate values
21362
1bb9a34011d1 doc: Specify that only numeric data are allowed for delimited file I/O (bug #46248).
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 20852
diff changeset
38 ## on a row. If no delimiter is specified the comma character @samp{,} is
1bb9a34011d1 doc: Specify that only numeric data are allowed for delimited file I/O (bug #46248).
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 20852
diff changeset
39 ## used.
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
40 ##
20160
03b9d17a2d95 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20101
diff changeset
41 ## The value of @var{r} specifies the number of delimiter-only lines to add to
03b9d17a2d95 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20101
diff changeset
42 ## the start of the file.
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
43 ##
20160
03b9d17a2d95 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20101
diff changeset
44 ## The value of @var{c} specifies the number of delimiters to prepend to each
03b9d17a2d95 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20101
diff changeset
45 ## line of data.
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
46 ##
20160
03b9d17a2d95 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20101
diff changeset
47 ## If the argument @qcode{"-append"} is given, append to the end of @var{file}.
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
48 ##
20160
03b9d17a2d95 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20101
diff changeset
49 ## In addition, the following keyword value pairs may appear at the end of
03b9d17a2d95 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20101
diff changeset
50 ## the argument list:
14327
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
51 ##
11595
5ec6aa05638d Prevent doubled quotes around @table items in Info.
Rik <octave@nomad.inbox5.com>
parents: 11588
diff changeset
52 ## @table @asis
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 16995
diff changeset
53 ## @item @qcode{"append"}
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 16995
diff changeset
54 ## 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
55 ##
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 16995
diff changeset
56 ## @item @qcode{"delimiter"}
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
57 ## See @var{delim} above.
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{"newline"}
21362
1bb9a34011d1 doc: Specify that only numeric data are allowed for delimited file I/O (bug #46248).
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 20852
diff changeset
60 ## The character(s) to separate each row. Three special cases exist for this
29117
10a35049bad7 doc: Cleanup Texinfo macros use in documentation.
Rik <rik@octave.org>
parents: 27923
diff changeset
61 ## option. @qcode{"unix"} is changed into @qcode{"@backslashchar{}n"},
10a35049bad7 doc: Cleanup Texinfo macros use in documentation.
Rik <rik@octave.org>
parents: 27923
diff changeset
62 ## @qcode{"pc"} is changed into @qcode{"@backslashchar{}r@backslashchar{}n"},
10a35049bad7 doc: Cleanup Texinfo macros use in documentation.
Rik <rik@octave.org>
parents: 27923
diff changeset
63 ## and @qcode{"mac"} is changed into @qcode{"@backslashchar{}r"}. Any other
21362
1bb9a34011d1 doc: Specify that only numeric data are allowed for delimited file I/O (bug #46248).
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 20852
diff changeset
64 ## value is used directly as the newline separator.
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
65 ##
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 16995
diff changeset
66 ## @item @qcode{"roffset"}
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
67 ## See @var{r} above.
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
68 ##
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 16995
diff changeset
69 ## @item @qcode{"coffset"}
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
70 ## See @var{c} above.
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
71 ##
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 16995
diff changeset
72 ## @item @qcode{"precision"}
20160
03b9d17a2d95 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20101
diff changeset
73 ## The precision to use when writing the file. It can either be a format
03b9d17a2d95 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20101
diff changeset
74 ## string (as used by fprintf) or a number of significant digits.
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
75 ## @end table
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
76 ##
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
77 ## @example
7590
780cf056eb85 dlmwrite doc fix
John W. Eaton <jwe@octave.org>
parents: 7581
diff changeset
78 ## 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
79 ## @end example
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 ## @example
20101
e51473fdb622 doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 19697
diff changeset
82 ## 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
83 ## @end example
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
84 ##
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
85 ## @seealso{dlmread, csvread, csvwrite}
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
86 ## @end deftypefn
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
87
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
88 ## 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
89 ##
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
90 ## 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
91 ##
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
92 ## 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
93 ## * Initial revision
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
94 ## 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
95 ## * 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
96 ## functionality.
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
97
11471
994e2a93a8e2 Use uppercase 'A' to refer to matrix inputs in m-files.
Rik <octave@nomad.inbox5.com>
parents: 11032
diff changeset
98 function dlmwrite (file, M, varargin)
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
99
13765
0d4c6d54b6a3 dlmwrite.m: Restore ability to use FID instead of filename.
Rik <octave@nomad.inbox5.com>
parents: 12462
diff changeset
100 if (nargin < 2)
9630
d52e405df4f7 dlmwrite.m: fix typo
John W. Eaton <jwe@octave.org>
parents: 9051
diff changeset
101 print_usage ();
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
102 endif
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
103
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
104 ## set defaults
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
105 delim = ",";
13765
0d4c6d54b6a3 dlmwrite.m: Restore ability to use FID instead of filename.
Rik <octave@nomad.inbox5.com>
parents: 12462
diff changeset
106 r = c = 0;
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
107 newline = "\n";
11471
994e2a93a8e2 Use uppercase 'A' to refer to matrix inputs in m-files.
Rik <octave@nomad.inbox5.com>
parents: 11032
diff changeset
108 if (ischar (M))
8509
841f8e3370c6 dlmwrite.m: use '%c' format for character data
John W. Eaton <jwe@octave.org>
parents: 7591
diff changeset
109 precision = "%c";
841f8e3370c6 dlmwrite.m: use '%c' format for character data
John W. Eaton <jwe@octave.org>
parents: 7591
diff changeset
110 else
841f8e3370c6 dlmwrite.m: use '%c' format for character data
John W. Eaton <jwe@octave.org>
parents: 7591
diff changeset
111 precision = "%.16g";
841f8e3370c6 dlmwrite.m: use '%c' format for character data
John W. Eaton <jwe@octave.org>
parents: 7591
diff changeset
112 endif
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
113 opentype = "wt";
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
114
13765
0d4c6d54b6a3 dlmwrite.m: Restore ability to use FID instead of filename.
Rik <octave@nomad.inbox5.com>
parents: 12462
diff changeset
115 ## process the input arguments
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
116 i = 0;
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
117 while (i < length (varargin))
20735
418ae0cb752f Replace ++,-- with in-place operators for performance.
Rik <rik@octave.org>
parents: 20713
diff changeset
118 i += 1;
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
119 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
120 delim = varargin{++i};
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
121 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
122 newline = varargin{++i};
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
123 if (strcmpi (newline, "unix"))
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 9630
diff changeset
124 newline = "\n";
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
125 elseif (strcmpi (newline, "pc"))
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 9630
diff changeset
126 newline = "\r\n";
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
127 elseif (strcmpi (newline, "mac"))
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 9630
diff changeset
128 newline = "\r";
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
129 endif
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
130 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
131 r = varargin{++i};
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
132 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
133 c = varargin{++i};
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
134 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
135 precision = varargin{++i};
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
136 if (! strcmpi (class (precision), "char"))
10626
044d9df4d79a Correctly set output precision (#29870) in dlmwrite
Rik <octave@nomad.inbox5.com>
parents: 10549
diff changeset
137 precision = sprintf ("%%.%gg", precision);
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
138 endif
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
139 elseif (strcmpi (varargin{i}, "-append"))
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
140 opentype = "at";
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
141 elseif (strcmpi (varargin{i}, "append"))
20735
418ae0cb752f Replace ++,-- with in-place operators for performance.
Rik <rik@octave.org>
parents: 20713
diff changeset
142 i += 1;
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
143 if (strcmpi (varargin{i}, "on"))
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 9630
diff changeset
144 opentype = "at";
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
145 elseif (strcmpi (varargin{i}, "off"))
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 9630
diff changeset
146 opentype = "wt";
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
147 else
13765
0d4c6d54b6a3 dlmwrite.m: Restore ability to use FID instead of filename.
Rik <octave@nomad.inbox5.com>
parents: 12462
diff changeset
148 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
149 endif
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
150 else
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
151 if (i == 1)
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 9630
diff changeset
152 delim = varargin{i};
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
153 elseif (i == 2)
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 9630
diff changeset
154 r = varargin{i};
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
155 elseif (i == 3)
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 9630
diff changeset
156 c = varargin{i};
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
157 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
158 print_usage ();
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
159 endif
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
160 endif
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
161 endwhile
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
162
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
163 ## 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
164 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
165 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
166 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
167
10936
1d761a30c3fb support file IDs in dlmwrite
Jaroslav Hajek <highegg@gmail.com>
parents: 10793
diff changeset
168 if (ischar (file))
1d761a30c3fb support file IDs in dlmwrite
Jaroslav Hajek <highegg@gmail.com>
parents: 10793
diff changeset
169 [fid, msg] = fopen (file, opentype);
24419
11d7cd4ece50 dlmwrite.m: Close fid if filename is only one char long (bug #52679)
Andreas Weber <andy.weber.aw@gmail.com>
parents: 23219
diff changeset
170 elseif (is_valid_file_id (file))
13765
0d4c6d54b6a3 dlmwrite.m: Restore ability to use FID instead of filename.
Rik <octave@nomad.inbox5.com>
parents: 12462
diff changeset
171 [fid, msg] = deal (file, "invalid file number");
10936
1d761a30c3fb support file IDs in dlmwrite
Jaroslav Hajek <highegg@gmail.com>
parents: 10793
diff changeset
172 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
173 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
174 endif
1d761a30c3fb support file IDs in dlmwrite
Jaroslav Hajek <highegg@gmail.com>
parents: 10793
diff changeset
175
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
176 if (fid < 0)
13765
0d4c6d54b6a3 dlmwrite.m: Restore ability to use FID instead of filename.
Rik <octave@nomad.inbox5.com>
parents: 12462
diff changeset
177 error (["dlmwrite: " msg]);
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
178 else
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
179 if (r > 0)
7581
e0d7bb35a3ec style fixes
John W. Eaton <jwe@octave.org>
parents: 7580
diff changeset
180 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
181 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
182 endif
11471
994e2a93a8e2 Use uppercase 'A' to refer to matrix inputs in m-files.
Rik <octave@nomad.inbox5.com>
parents: 11032
diff changeset
183 if (iscomplex (M))
13765
0d4c6d54b6a3 dlmwrite.m: Restore ability to use FID instead of filename.
Rik <octave@nomad.inbox5.com>
parents: 12462
diff changeset
184 cprecision = regexprep (precision, '^%([-\d.])', '%+$1');
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
185 template = [precision, cprecision, "i", ...
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 9630
diff changeset
186 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
187 columns(M) - 1), newline ];
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
188 else
11471
994e2a93a8e2 Use uppercase 'A' to refer to matrix inputs in m-files.
Rik <octave@nomad.inbox5.com>
parents: 11032
diff changeset
189 template = [precision, repmat([delim, precision], 1, columns(M)-1),...
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 9630
diff changeset
190 newline];
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
191 endif
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
192 if (c > 0)
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
193 template = [repmat(delim, 1, c), template];
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
194 endif
11471
994e2a93a8e2 Use uppercase 'A' to refer to matrix inputs in m-files.
Rik <octave@nomad.inbox5.com>
parents: 11032
diff changeset
195 if (iscomplex (M))
994e2a93a8e2 Use uppercase 'A' to refer to matrix inputs in m-files.
Rik <octave@nomad.inbox5.com>
parents: 11032
diff changeset
196 M = M.';
14868
5d3a684236b0 maint: Use Octave coding conventions for cuddling parentheses in scripts directory
Rik <octave@nomad.inbox5.com>
parents: 14846
diff changeset
197 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
198 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
199 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
200 fprintf (fid, template, b);
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
201 else
11471
994e2a93a8e2 Use uppercase 'A' to refer to matrix inputs in m-files.
Rik <octave@nomad.inbox5.com>
parents: 11032
diff changeset
202 fprintf (fid, template, M.');
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
203 endif
24419
11d7cd4ece50 dlmwrite.m: Close fid if filename is only one char long (bug #52679)
Andreas Weber <andy.weber.aw@gmail.com>
parents: 23219
diff changeset
204 if (ischar (file))
10940
306e40d773a9 don't fclose stream in dlmwrite
Jaroslav Hajek <highegg@gmail.com>
parents: 10936
diff changeset
205 fclose (fid);
306e40d773a9 don't fclose stream in dlmwrite
Jaroslav Hajek <highegg@gmail.com>
parents: 10936
diff changeset
206 endif
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
207 endif
13765
0d4c6d54b6a3 dlmwrite.m: Restore ability to use FID instead of filename.
Rik <octave@nomad.inbox5.com>
parents: 12462
diff changeset
208
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
209 endfunction
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
210
13765
0d4c6d54b6a3 dlmwrite.m: Restore ability to use FID instead of filename.
Rik <octave@nomad.inbox5.com>
parents: 12462
diff changeset
211
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
212 %!test
19278
6ca096827123 Use tempname() rather than tmpnam() in core Octave.
Rik <rik@octave.org>
parents: 17744
diff changeset
213 %! f = tempname ();
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14327
diff changeset
214 %! 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
215 %! 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
216 %! 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
217 %! fclose (fid);
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14327
diff changeset
218 %! 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
219 %! 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
220 %! 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
221 %! fclose (fid);
0d4c6d54b6a3 dlmwrite.m: Restore ability to use FID instead of filename.
Rik <octave@nomad.inbox5.com>
parents: 12462
diff changeset
222 %! unlink (f);
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
223 %!
13765
0d4c6d54b6a3 dlmwrite.m: Restore ability to use FID instead of filename.
Rik <octave@nomad.inbox5.com>
parents: 12462
diff changeset
224 %! 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
225 %! assert (f2,",,\n, 1.00, 2.00\n, 3.00, 4.00\n, 5.00, 6.00\n");