Mercurial > octave

annotate scripts/io/csvread.m @ 33658:b1d6e40ac737 stable tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
NEWS.9.md: Fix typo and minor formatting changes. * etc/NEWS.9.md: Fix typo. Adjust whitespace. Use markdown syntax for code snippets.
author Markus Mützel <markus.muetzel@gmx.de>
date Wed, 05 Jun 2024 11:27:35 +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) 2001-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: 23220
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: 23220
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: 23220
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: 19833
diff changeset
27 ## @deftypefn {} {@var{x} =} csvread (@var{filename})
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 ## @deftypefnx {} {@var{x} =} csvread (@var{filename}, @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
29 ## Read the comma-separated-value (CSV) file @var{filename} into the matrix
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
30 ## @var{x}.
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
31 ##
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
32 ## Note: only CSV files containing numeric data can be read.
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
33 ##
7581
e0d7bb35a3ec style fixes
John W. Eaton <jwe@octave.org>
parents: 7580
diff changeset
34 ## This function is equivalent to
10821
693e22af08ae Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents: 10687
diff changeset
35 ##
7581
e0d7bb35a3ec style fixes
John W. Eaton <jwe@octave.org>
parents: 7580
diff changeset
36 ## @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
37 ## @var{x} = dlmread (@var{filename}, "," , @var{dlm_opt1}, @dots{})
7581
e0d7bb35a3ec style fixes
John W. Eaton <jwe@octave.org>
parents: 7580
diff changeset
38 ## @end example
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
39 ##
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
40 ## Any optional arguments are passed directly to @code{dlmread}
28959
5394d688d456 doc: Use @code{} within alternate text for @xref,@pxref macros for better Info display.
Rik <rik@octave.org>
parents: 27923
diff changeset
41 ## (@pxref{XREFdlmread,,@code{dlmread}}).
25764
826b45c1c427 textread.m: Make m-file a legacy function.
Rik <rik@octave.org>
parents: 25054
diff changeset
42 ## @seealso{dlmread, textscan, csvwrite, dlmwrite}
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
43 ## @end deftypefn
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
44
11469
c776f063fefe Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents: 10821
diff changeset
45 function x = csvread (filename, varargin)
c776f063fefe Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents: 10821
diff changeset
46 x = dlmread (filename, ",", varargin{:});
7580
b4aa9ef3d3ef Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
David Bateman <dbateman@free.fr>
parents:
diff changeset
47 endfunction
13766
453997717598 Add functional tests for csvwrite/csvread.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
48
453997717598 Add functional tests for csvwrite/csvread.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
49
19833
9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 19697
diff changeset
50 ## Tests for csvread() are in csvwrite()
9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 19697
diff changeset
51 ## Mark file as being tested
13766
453997717598 Add functional tests for csvwrite/csvread.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
52 %!assert (1)