Mercurial > octave
annotate scripts/io/csvwrite.m @ 22323:bac0d6f07a3e
maint: Update copyright notices for 2016.
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Wed, 17 Aug 2016 01:05:19 -0400 |
parents | c9f967cfe7c1 |
children | 3a2b891d0b33 e9a0469dedd9 |
rev | line source |
---|---|
22323
bac0d6f07a3e
maint: Update copyright notices for 2016.
John W. Eaton <jwe@octave.org>
parents:
21383
diff
changeset
|
1 ## Copyright (C) 2001-2016 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 -*- |
20852
516bb87ea72e
2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents:
19697
diff
changeset
|
20 ## @deftypefn {} {} csvwrite (@var{filename}, @var{x}) |
21383
c9f967cfe7c1
doc: Point user to dlmread/dlmwrite in csvread/csvwrite for dlmopts (bug #47309)
Nicholas R. Jankowski <jankowskin@asme.org>
parents:
21362
diff
changeset
|
21 ## @deftypefnx {} {} csvwrite (@var{filename}, @var{x}, @var{dlm_opt1}, @dots{}) |
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
|
22 ## Write the numeric matrix @var{x} to the file @var{filename} in |
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
|
23 ## @w{comma-separated-value} (CSV) format. |
7580
b4aa9ef3d3ef
Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff
changeset
|
24 ## |
7581 | 25 ## This function is equivalent to |
10821
693e22af08ae
Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents:
10687
diff
changeset
|
26 ## |
7581 | 27 ## @example |
21383
c9f967cfe7c1
doc: Point user to dlmread/dlmwrite in csvread/csvwrite for dlmopts (bug #47309)
Nicholas R. Jankowski <jankowskin@asme.org>
parents:
21362
diff
changeset
|
28 ## dlmwrite (@var{filename}, @var{x}, ",", @var{dlm_opt1}, @dots{}) |
7581 | 29 ## @end example |
7580
b4aa9ef3d3ef
Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff
changeset
|
30 ## |
21383
c9f967cfe7c1
doc: Point user to dlmread/dlmwrite in csvread/csvwrite for dlmopts (bug #47309)
Nicholas R. Jankowski <jankowskin@asme.org>
parents:
21362
diff
changeset
|
31 ## Any optional arguments are passed directly to @code{dlmwrite} |
c9f967cfe7c1
doc: Point user to dlmread/dlmwrite in csvread/csvwrite for dlmopts (bug #47309)
Nicholas R. Jankowski <jankowskin@asme.org>
parents:
21362
diff
changeset
|
32 ## (@pxref{XREFdlmwrite,,dlmwrite}). |
10821
693e22af08ae
Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents:
10687
diff
changeset
|
33 ## @seealso{csvread, dlmwrite, dlmread} |
7580
b4aa9ef3d3ef
Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff
changeset
|
34 ## @end deftypefn |
b4aa9ef3d3ef
Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff
changeset
|
35 |
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
10821
diff
changeset
|
36 function csvwrite (filename, x, varargin) |
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
10821
diff
changeset
|
37 dlmwrite (filename, x, ",", varargin{:}); |
7580
b4aa9ef3d3ef
Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff
changeset
|
38 endfunction |
13766
453997717598
Add functional tests for csvwrite/csvread.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
39 |
453997717598
Add functional tests for csvwrite/csvread.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
40 |
453997717598
Add functional tests for csvwrite/csvread.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
41 %!shared fname |
19278
6ca096827123
Use tempname() rather than tmpnam() in core Octave.
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
42 %! fname = tempname (); |
13766
453997717598
Add functional tests for csvwrite/csvread.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
43 |
453997717598
Add functional tests for csvwrite/csvread.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
44 %!test |
453997717598
Add functional tests for csvwrite/csvread.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
45 %! csvwrite (fname, magic (3)); |
16974
221e71d2aef0
Unlink tmp files in %!tests before doing asserts so that file is always removed.
Rik <rik@octave.org>
parents:
14138
diff
changeset
|
46 %! data = csvread (fname); |
13766
453997717598
Add functional tests for csvwrite/csvread.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
47 %! unlink (fname); |
16974
221e71d2aef0
Unlink tmp files in %!tests before doing asserts so that file is always removed.
Rik <rik@octave.org>
parents:
14138
diff
changeset
|
48 %! assert (data, magic (3)); |
13766
453997717598
Add functional tests for csvwrite/csvread.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
49 |
453997717598
Add functional tests for csvwrite/csvread.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
50 %!test |
453997717598
Add functional tests for csvwrite/csvread.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
51 %! csvwrite (fname, magic (3), "precision", "%2.1f", "newline", "unix"); |
453997717598
Add functional tests for csvwrite/csvread.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
52 %! fid = fopen (fname, "rt"); |
453997717598
Add functional tests for csvwrite/csvread.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
53 %! txt = char (fread (fid,Inf,'char')'); |
453997717598
Add functional tests for csvwrite/csvread.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
54 %! fclose (fid); |
16974
221e71d2aef0
Unlink tmp files in %!tests before doing asserts so that file is always removed.
Rik <rik@octave.org>
parents:
14138
diff
changeset
|
55 %! unlink (fname); |
13766
453997717598
Add functional tests for csvwrite/csvread.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
56 %! assert (txt, "8.0,1.0,6.0\n3.0,5.0,7.0\n4.0,9.0,2.0\n"); |
453997717598
Add functional tests for csvwrite/csvread.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
57 |