Mercurial > octave-nkf

annotate scripts/io/csvwrite.m @ 14138:72c96de7a403 stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
maint: update copyright notices for 2012
author John W. Eaton <jwe@octave.org>
date Mon, 02 Jan 2012 14:25:41 -0500
parents 453997717598
children 221e71d2aef0
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
14138
72c96de7a403 maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents: 13766
diff changeset
1 ## Copyright (C) 2001-2012 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 -*-
10821
693e22af08ae Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents: 10687
diff changeset
20 ## @deftypefn {Function File} {} csvwrite (@var{filename}, @var{x})
693e22af08ae Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents: 10687
diff changeset
21 ## @deftypefnx {Function File} {} csvwrite (@var{filename}, @var{x}, @var{dlm_opts})
10687
a8ce6bdecce5 Improve documentation strings.
Rik <octave@nomad.inbox5.com>
parents: 7650
diff changeset
22 ## Write the matrix @var{x} to the file @var{filename} in
a8ce6bdecce5 Improve documentation strings.
Rik <octave@nomad.inbox5.com>
parents: 7650
diff changeset
23 ## @w{comma-separated-value} format.
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
24 ##
7581
e0d7bb35a3ec style fixes
John W. Eaton <jwe@octave.org>
parents: 7580
diff changeset
25 ## This function is equivalent to
10821
693e22af08ae Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents: 10687
diff changeset
26 ##
7581
e0d7bb35a3ec style fixes
John W. Eaton <jwe@octave.org>
parents: 7580
diff changeset
27 ## @example
e0d7bb35a3ec style fixes
John W. Eaton <jwe@octave.org>
parents: 7580
diff changeset
28 ## dlmwrite (@var{filename}, @var{x}, ",", @dots{})
e0d7bb35a3ec style fixes
John W. Eaton <jwe@octave.org>
parents: 7580
diff changeset
29 ## @end example
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
30 ##
10821
693e22af08ae Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents: 10687
diff changeset
31 ## @seealso{csvread, dlmwrite, dlmread}
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
32 ## @end deftypefn
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
33
11469
c776f063fefe Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents: 10821
diff changeset
34 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
35 dlmwrite (filename, x, ",", varargin{:});
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
36 endfunction
13766
453997717598 Add functional tests for csvwrite/csvread.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
37
453997717598 Add functional tests for csvwrite/csvread.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
38
453997717598 Add functional tests for csvwrite/csvread.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
39 %!shared fname
453997717598 Add functional tests for csvwrite/csvread.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
40 %! fname = tmpnam ();
453997717598 Add functional tests for csvwrite/csvread.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
41
453997717598 Add functional tests for csvwrite/csvread.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
42 %!test
453997717598 Add functional tests for csvwrite/csvread.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
43 %! csvwrite (fname, magic (3));
453997717598 Add functional tests for csvwrite/csvread.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
44 %! assert (csvread (fname), magic (3));
453997717598 Add functional tests for csvwrite/csvread.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
45 %! unlink (fname);
453997717598 Add functional tests for csvwrite/csvread.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
46
453997717598 Add functional tests for csvwrite/csvread.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
47 %!test
453997717598 Add functional tests for csvwrite/csvread.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
48 %! 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
49 %! fid = fopen (fname, "rt");
453997717598 Add functional tests for csvwrite/csvread.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
50 %! txt = char (fread (fid,Inf,'char')');
453997717598 Add functional tests for csvwrite/csvread.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
51 %! fclose (fid);
453997717598 Add functional tests for csvwrite/csvread.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
52 %! 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
53 %! unlink (fname);
453997717598 Add functional tests for csvwrite/csvread.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
54