| 12
 3
 4
 5
 6
 7
 8
 9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 
 | .TH read 1 "April 1993" "Scilab Group" "Scilab Function"
.so ../sci.an
.SH NAME
read - matrices read
.SH CALLING SEQUENCE
.nf
[x]=read(file-desc,m,n,[format])   
[x]=read(file-desc,m,n,k,format)
.fi
.SH PARAMETERS
.TP 10
file-desc
: character string specifying the file name or integer value
specifying logical unit (see file).
.TP 10
m, n
: integers (dimensions of the matrix x). Set m=-1 if you do not know the
numbers of rows, so the whole file is read.
.TP 10
format : character string, specifies a "Fortran" format. This
character string must begin with a right parenthesis and end with a
left parenthesis.  Formats cannot mix floating point or character
edition modes. 
.TP 10
k
: integer or vector of integer
.SH DESCRIPTION
reads row after row
the \fVmxn\fR matrix \fVx\fR (\fVn=1\fR for character chain) in the
file \fVfile-desc\fR (string or integer).  Each row of the matrix \fVx\fR
begin in a new line of \fVfile-desc\fR file. Depending on \fVformat\fR, a
given row of the \fVx\fR matrix may be read from more than one line
of \fVfile-desc\fR file.
.LP
The type of the result will depend on the specified format. 
If format contains only \fV(d,e,f,g)\fR  descriptors the function
tries to read numerical data (the result is matrix of real numbers).
.LP
If format contains only  \fVa\fR descriptors the function tries to
read character strings (the result is a character string column
vector). In this case n must be equal to 1. 
.LP
Examples for \fVformat\fR: 
.nf 
(1x,e10.3,5x,3(f3.0))
(10x,a20) 
.LP 
When format is omitted datas are read using numerical free format: 
blank, comma and slash may be used as data separators, n*v may be use
to represent n occurrences of value n.
.LP
A direct access file can be used if using the parameter \fVk\fR which is 
is the vector of record numbers to be read (one record per row),
thus \fVm\fR must be \fVm=prod(size(k))\fR.
.LP
To read on the keyboard use \fVread(%io(1),...)\fR.
.SH REMARK
Last line of data files must be terminated by a newline to be taken
into account.
.SH EXAMPLE
.nf
if MSDOS then unix('del foo');
else unix('rm -f foo'); end
A=rand(3,5); write('foo',A);
B=read('foo',3,5)
B=read('foo',-1,5)
read(%io(1),1,1,'(a)')  // waits for user's input
.fi
.SH SEE ALSO
file, readb, write, x_dialog, mscanf, mfscanf, msscanf, fscanfMat
 |