[SYSTEMML-1168] Document printf functionality Add print function's multi-argument printf formatting capabilities to the DML Language Reference.
Closes #333. Project: http://git-wip-us.apache.org/repos/asf/incubator-systemml/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-systemml/commit/82682553 Tree: http://git-wip-us.apache.org/repos/asf/incubator-systemml/tree/82682553 Diff: http://git-wip-us.apache.org/repos/asf/incubator-systemml/diff/82682553 Branch: refs/heads/gh-pages Commit: 82682553dab1264c86987b4aaff00735f983f673 Parents: a9695eb Author: Deron Eriksson <[email protected]> Authored: Fri Jan 6 21:30:10 2017 -0800 Committer: Deron Eriksson <[email protected]> Committed: Fri Jan 6 21:30:10 2017 -0800 ---------------------------------------------------------------------- dml-language-reference.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/82682553/dml-language-reference.md ---------------------------------------------------------------------- diff --git a/dml-language-reference.md b/dml-language-reference.md index eefdc44..80fc8ca 100644 --- a/dml-language-reference.md +++ b/dml-language-reference.md @@ -1454,7 +1454,7 @@ Function | Description | Parameters | Example -------- | ----------- | ---------- | ------- append() | Append a string to another string separated by "\n" <br/> Limitation: The string may grow up to 1 MByte. | Input: (<string>, <string>) <br/> Output: <string> | s = "iter=" + i <br/> i = i + 1 <br/> s = append(s, "iter=" + i) <br/> write(s, "s.out") toString() | Formats a Matrix or Frame object into a string. <br/> "rows" & "cols" : number of rows and columns to print<br/> "decimal" : number of digits after the decimal<br/>"sparse" : set to true to print Matrix object in sparse format, i.e. _RowIndex_ _ColIndex_ _Value_<br/>"sep" and "linesep" : inter-element separator and the line separator strings| Input : (<matrix> or <frame>,<br/> rows=100,<br/> cols=100,<br/> decimal=3,<br/> sparse=FALSE,<br/> sep=" ",<br/> linesep="\n") <br/> Output: <string> | X = matrix(seq(1, 9), rows=3, cols=3)<br/>str = toString(X, sep=" \| ") <br/><br/>F = as.frame(X)<br/>print(toString(F, rows=2, cols=2)) -print() | Prints the value of a scalar variable x. This built-in takes an optional string parameter. | Input: (<scalar>) | print("hello") <br/> print("hello" + "world") <br/> print("value of x is " + x ) +print() | Prints a scalar variable. The print() function allows printf-style formatting by optionally allowing multiple arguments, where the first argument is the string that specifies the formatting and the additional arguments are the arguments to format. | Input: <scalar><br/>or<br/><string, args...> | print("hello") <br/> print("hello" + "world") <br/> print("value of x is " + x ) <br/><br/>a='hello';<br/>b=3;<br/>c=4.5;<br/>d=TRUE;<br/>print('%s %d %f %b', a, b, c, d); <br/><br/>a='hello';<br/>b='goodbye';<br/>c=4;<br/>d=3;<br/>e=3.0;<br/>f=5.0;<br/>g=FALSE;<br/>print('%s %d %f %b', (a+b), (c-d), (e*f), !g); stop() | Halts the execution of DML program by printing the message that is passed in as the argument. <br/> Note that the use of stop() is not allowed inside a parfor loop. | Input: (<scalar>) | stop("Inputs to DML program are invalid") <br/> stop("Class labels must be either -1 or +1") order() | Sort a column of the matrix X in decreasing/increasing order and return either index (index.return=TRUE) or data (index.return=FALSE). | Input: (target=X, by=column, decreasing, index.return) | order(X, by=1, decreasing=FALSE, index.return=FALSE)
