~ubuntu-branches/ubuntu/hoary/scilab/hoary

« back to all changes in this revision

Viewing changes to man/eng/fileio/readb.xml

  • Committer: Bazaar Package Importer
  • Author(s): Torsten Werner
  • Date: 2005-01-09 22:58:21 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20050109225821-473xr8vhgugxxx5j
Tags: 3.0-12
changed configure.in to build scilab's own malloc.o, closes: #255869

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<?xml version="1.0" encoding="ISO-8859-1" standalone="no"?>
 
2
<!DOCTYPE MAN SYSTEM "../../manrev.dtd">
 
3
<MAN>
 
4
  <LANGUAGE>eng</LANGUAGE>
 
5
  <TITLE>readb</TITLE>
 
6
  <TYPE>Scilab Function</TYPE>
 
7
  <DATE>April 1993</DATE>
 
8
  <SHORT_DESCRIPTION name="readb"> fortran file binary read</SHORT_DESCRIPTION>
 
9
  <CALLING_SEQUENCE>
 
10
    <CALLING_SEQUENCE_ITEM>x=readb(file-name,m,n [,rec])  </CALLING_SEQUENCE_ITEM>
 
11
  </CALLING_SEQUENCE>
 
12
  <PARAM>
 
13
    <PARAM_INDENT>
 
14
      <PARAM_ITEM>
 
15
        <PARAM_NAME>file-name</PARAM_NAME>
 
16
        <PARAM_DESCRIPTION>
 
17
          <SP>: string or integer</SP>
 
18
        </PARAM_DESCRIPTION>
 
19
      </PARAM_ITEM>
 
20
      <PARAM_ITEM>
 
21
        <PARAM_NAME>m, n</PARAM_NAME>
 
22
        <PARAM_DESCRIPTION>
 
23
          <SP>: integers (dimensions of the matrix x). Set m=-1 if you do not know the numbers of rows, so all the file is read</SP>
 
24
        </PARAM_DESCRIPTION>
 
25
      </PARAM_ITEM>
 
26
      <PARAM_ITEM>
 
27
        <PARAM_NAME>rec</PARAM_NAME>
 
28
        <PARAM_DESCRIPTION>
 
29
          <SP>: vector of positive integers. the selected records for direct access. This vector size must be equal to the number of rows of desired <VERB>x</VERB>.</SP>
 
30
        </PARAM_DESCRIPTION>
 
31
      </PARAM_ITEM>
 
32
    </PARAM_INDENT>
 
33
  </PARAM>
 
34
  <DESCRIPTION>
 
35
    <P>
 
36
    binary read of the matrix <VERB>x</VERB> in the file <VERB>file-name</VERB>.
 
37
    Matrix entries are supposed to have been stored on 8 byte words.</P>
 
38
    <P>
 
39
    For direct record access, file must have been previously opened using
 
40
    <VERB>file</VERB> function to set the record_length. <VERB>file-name</VERB> must be
 
41
    the result of the <VERB>file</VERB> function.</P>
 
42
  </DESCRIPTION>
 
43
  <SEE_ALSO>
 
44
    <SEE_ALSO_ITEM>
 
45
      <LINK>file</LINK>
 
46
    </SEE_ALSO_ITEM>
 
47
    <SEE_ALSO_ITEM>
 
48
      <LINK>write</LINK>
 
49
    </SEE_ALSO_ITEM>
 
50
    <SEE_ALSO_ITEM>
 
51
      <LINK>writb</LINK>
 
52
    </SEE_ALSO_ITEM>
 
53
    <SEE_ALSO_ITEM>
 
54
      <LINK>mget</LINK>
 
55
    </SEE_ALSO_ITEM>
 
56
    <SEE_ALSO_ITEM>
 
57
      <LINK>read4b</LINK>
 
58
    </SEE_ALSO_ITEM>
 
59
  </SEE_ALSO>
 
60
</MAN>