view scripts/io/csvwrite.m @ 14366:b76f0740940e

doc: Periodic grammar check of documentation. * accumarray.m, repmat.m, imshow.m, strread.m, edit.m, mkoctfile.m, warning_ids.m, glpk.m, lsqnonneg.m, optimset.m, pqpnonneg.m, figure.m, print.m, __print_parse_opts__.m, gmres.m, zscore.m, __init_fltk__.cc, cellfun.cc, nproc.cc, regexp.cc, spparms.cc, dirfns.cc, file-io.cc, load-save.cc, ov-null-mat.cc, ov-usr-fcn.cc, variables.cc: Periodic grammar check of documentation.
author Rik <octave@nomad.inbox5.com>
date Wed, 15 Feb 2012 13:31:31 -0800
parents 72c96de7a403
children 221e71d2aef0
line wrap: on
line source

## Copyright (C) 2001-2012 Paul Kienzle
##
## 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
## <http://www.gnu.org/licenses/>.

## -*- texinfo -*-
## @deftypefn  {Function File} {} csvwrite (@var{filename}, @var{x})
## @deftypefnx {Function File} {} csvwrite (@var{filename}, @var{x}, @var{dlm_opts})
## Write the matrix @var{x} to the file @var{filename} in
## @w{comma-separated-value} format.
##
## This function is equivalent to
##
## @example
## dlmwrite (@var{filename}, @var{x}, ",", @dots{})
## @end example
##
## @seealso{csvread, dlmwrite, dlmread}
## @end deftypefn

function csvwrite (filename, x, varargin)
  dlmwrite (filename, x, ",", varargin{:});
endfunction


%!shared fname
%! fname = tmpnam ();

%!test
%! csvwrite (fname, magic (3));
%! assert (csvread (fname), magic (3));
%! unlink (fname);

%!test
%! csvwrite (fname, magic (3), "precision", "%2.1f", "newline", "unix");
%! fid = fopen (fname, "rt");
%! txt = char (fread (fid,Inf,'char')');
%! fclose (fid);
%! assert (txt, "8.0,1.0,6.0\n3.0,5.0,7.0\n4.0,9.0,2.0\n");
%! unlink (fname);