Mercurial > octave-antonio

comparison scripts/io/dlmwrite.m @ 20160:03b9d17a2d95 stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Update more docstrings to have one sentence summary as first line. Reviewed io, java, linear-algebra, prefs, and set script directories. * scripts/io/beep.m, scripts/io/dlmwrite.m, scripts/io/importdata.m, scripts/io/strread.m, scripts/io/textread.m, scripts/java/javaArray.m, scripts/java/java_get.m, scripts/java/java_set.m, scripts/java/javaaddpath.m, scripts/java/javachk.m, scripts/java/javaclasspath.m, scripts/java/javamem.m, scripts/java/javarmpath.m, scripts/linear-algebra/bandwidth.m, scripts/linear-algebra/commutation_matrix.m, scripts/linear-algebra/cond.m, scripts/linear-algebra/condest.m, scripts/linear-algebra/cross.m, scripts/linear-algebra/duplication_matrix.m, scripts/linear-algebra/expm.m, scripts/linear-algebra/housh.m, scripts/linear-algebra/isdefinite.m, scripts/linear-algebra/ishermitian.m, scripts/linear-algebra/issymmetric.m, scripts/linear-algebra/istril.m, scripts/linear-algebra/istriu.m, scripts/linear-algebra/krylov.m, scripts/linear-algebra/logm.m, scripts/linear-algebra/normest.m, scripts/linear-algebra/null.m, scripts/linear-algebra/onenormest.m, scripts/linear-algebra/orth.m, scripts/linear-algebra/qzhess.m, scripts/linear-algebra/rank.m, scripts/linear-algebra/rref.m, scripts/linear-algebra/vech.m, scripts/path/matlabroot.m, scripts/prefs/addpref.m, scripts/prefs/getpref.m, scripts/prefs/ispref.m, scripts/prefs/rmpref.m, scripts/prefs/setpref.m, scripts/set/powerset.m, scripts/set/setdiff.m: Update more docstrings to have one sentence summary as first line.
author Rik <rik@octave.org>
date Sun, 03 May 2015 15:36:23 -0700
parents e51473fdb622
children
comparison
equal deleted inserted replaced
20159:597991b19e40 20160:03b9d17a2d95
24 ## @deftypefnx {Function File} {} dlmwrite (@var{fid}, @dots{}) 24 ## @deftypefnx {Function File} {} dlmwrite (@var{fid}, @dots{})
25 ## Write the matrix @var{M} to the named file using delimiters. 25 ## Write the matrix @var{M} to the named file using delimiters.
26 ## 26 ##
27 ## @var{file} should be a file name or writable file ID given by @code{fopen}. 27 ## @var{file} should be a file name or writable file ID given by @code{fopen}.
28 ## 28 ##
29 ## The parameter @var{delim} specifies the delimiter to use to separate 29 ## The parameter @var{delim} specifies the delimiter to use to separate values
30 ## values on a row. 30 ## on a row.
31 ## 31 ##
32 ## The value of @var{r} specifies the number of delimiter-only lines to 32 ## The value of @var{r} specifies the number of delimiter-only lines to add to
33 ## add to the start of the file. 33 ## the start of the file.
34 ## 34 ##
35 ## The value of @var{c} specifies the number of delimiters to prepend to 35 ## The value of @var{c} specifies the number of delimiters to prepend to each
36 ## each line of data. 36 ## line of data.
37 ## 37 ##
38 ## If the argument @qcode{"-append"} is given, append to the end of 38 ## If the argument @qcode{"-append"} is given, append to the end of @var{file}.
39 ## @var{file}. 39 ##
40 ## 40 ## In addition, the following keyword value pairs may appear at the end of
41 ## In addition, the following keyword value pairs may appear at the end 41 ## the argument list:
42 ## of the argument list:
43 ## 42 ##
44 ## @table @asis 43 ## @table @asis
45 ## @item @qcode{"append"} 44 ## @item @qcode{"append"}
46 ## Either @qcode{"on"} or @qcode{"off"}. See @qcode{"-append"} above. 45 ## Either @qcode{"on"} or @qcode{"off"}. See @qcode{"-append"} above.
47 ## 46 ##
48 ## @item @qcode{"delimiter"} 47 ## @item @qcode{"delimiter"}
49 ## See @var{delim} above. 48 ## See @var{delim} above.
50 ## 49 ##
51 ## @item @qcode{"newline"} 50 ## @item @qcode{"newline"}
52 ## The character(s) to use to separate each row. Three special cases 51 ## The character(s) to use to separate each row. Three special cases exist
53 ## exist for this option. @qcode{"unix"} is changed into 52 ## for this option. @qcode{"unix"} is changed into
54 ## @qcode{"@xbackslashchar{}n"}, @qcode{"pc"} is changed into 53 ## @qcode{"@xbackslashchar{}n"}, @qcode{"pc"} is changed into
55 ## @qcode{"@xbackslashchar{}r@xbackslashchar{}n"}, and @qcode{"mac"} is changed 54 ## @qcode{"@xbackslashchar{}r@xbackslashchar{}n"}, and @qcode{"mac"} is
56 ## into @qcode{"@xbackslashchar{}r"}. Any other value is used directly as the 55 ## changed into @qcode{"@xbackslashchar{}r"}. Any other value is used
57 ## newline separator. 56 ## directly as the newline separator.
58 ## 57 ##
59 ## @item @qcode{"roffset"} 58 ## @item @qcode{"roffset"}
60 ## See @var{r} above. 59 ## See @var{r} above.
61 ## 60 ##
62 ## @item @qcode{"coffset"} 61 ## @item @qcode{"coffset"}
63 ## See @var{c} above. 62 ## See @var{c} above.
64 ## 63 ##
65 ## @item @qcode{"precision"} 64 ## @item @qcode{"precision"}
66 ## The precision to use when writing the file. It can either be a 65 ## The precision to use when writing the file. It can either be a format
67 ## format string (as used by fprintf) or a number of significant digits. 66 ## string (as used by fprintf) or a number of significant digits.
68 ## @end table 67 ## @end table
69 ## 68 ##
70 ## @example 69 ## @example
71 ## dlmwrite ("file.csv", reshape (1:16, 4, 4)); 70 ## dlmwrite ("file.csv", reshape (1:16, 4, 4));
72 ## @end example 71 ## @end example