SCM

SCM Repository

[matrix] Diff of /pkg/Matrix/man/externalFormats.Rd
ViewVC logotype

Diff of /pkg/Matrix/man/externalFormats.Rd

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1228, Wed Mar 15 17:43:34 2006 UTC revision 1620, Sat Oct 7 12:48:05 2006 UTC
# Line 20  Line 20 
20  \usage{  \usage{
21  readHB(file)  readHB(file)
22  readMM(file)  readMM(file)
23  writeHB(obj, file, ...)  writeHB(obj, file, ...)  # deprecated
24  writeMM(obj, file, ...)  writeMM(obj, file, ...)
25  }  }
26  \arguments{  \arguments{
27   \item{obj}{a real sparse matrix}   \item{obj}{a real sparse matrix}
28   \item{file}{for \code{writeHB} and \code{writeMM} - the name of the   \item{file}{for \code{writeMM} - the name of the file to be written.
29     file to be written.  For \code{readHB} and \code{readMM}     For \code{readHB} and \code{readMM} the name of the file to read, as
30     the name of the file to read, as a character scalar.     a character scalar.  The names of files storing matrices in the
31     The names of files storing matrices in the Harwell-Boeing format     Harwell-Boeing format usually end in \code{".rua"} or \code{".rsa"}.
32     usually end in \code{".rua"} or \code{".rsa"}.  Those storing     Those storing matrices in the MatrixMarket format usually end in
33     matrices in the MatrixMarket format usually end in {".mtx"}.     {".mtx"}.
34    
35     Alternatively, \code{readHB} accepts a connection object.}     Alternatively, \code{readHB} and \code{readMM} accept connection objects.}
36   \item{\dots}{optional additional arguments. Currently none are used in   \item{\dots}{optional additional arguments. Currently none are used in
37     any methods.}     any methods.}
38  }  }
39  \value{  \value{
40    The \code{readHB} and \code{readMM} functions return an object that    The \code{readHB} and \code{readMM} functions return an object that
41    inherits from the \code{"Matrix"} class.  Methods for the    inherits from the \code{"Matrix"} class.  Methods for the
42    \code{writeHB} and \code{writeMM} generic functions usually return    \code{writeMM} generic functions usually return
43    \code{NULL} and, as a side effect, the matrix \code{obj} is written to    \code{NULL} and, as a side effect, the matrix \code{obj} is written to
44    \code{file} in the Harwell-Boeing format (writeHB)    \code{file} in the MatrixMarket format (writeMM).
45    or the MatrixMarket format (writeMM).  }
46    \note{
47      The Harwell-Boeing format is older and less flexible than the
48     MatrixMarket format.  The function \code{writeHB} is now deprecated.
49     We recommend the use of \code{writeMM} instead.
50  }  }
51  \references{  \references{
52    \url{http://math.nist.gov/MatrixMarket}    \url{http://math.nist.gov/MatrixMarket}
# Line 67  Line 71 
71   readMM(gzcon(url("ftp://math.nist.gov/pub/MatrixMarket2/Harwell-Boeing/counterx/jgl009.mtx.gz"))))   readMM(gzcon(url("ftp://math.nist.gov/pub/MatrixMarket2/Harwell-Boeing/counterx/jgl009.mtx.gz"))))
72  }  }
73  data(KNex)  data(KNex)
74    \dontrun{
75  writeHB(KNex$mm, "mmHB.rua")  writeHB(KNex$mm, "mmHB.rua")
76    }
77  writeMM(KNex$mm, "mmMM.mtx")  writeMM(KNex$mm, "mmMM.mtx")
78  }  }
79  \keyword{IO}  \keyword{IO}

Legend:
Removed from v.1228  
changed lines
  Added in v.1620

root@r-forge.r-project.org
ViewVC Help
Powered by ViewVC 1.0.0  
Thanks to:
Vienna University of Economics and Business University of Wisconsin - Madison Powered By FusionForge