import.html 8.64 KB
Newer Older
Roman Flury's avatar
Roman Flury committed
1 2 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 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89
<!-- Generated by pkgdown: do not edit by hand -->
<!DOCTYPE html>
<html>
  <head>
  <meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>Read External Matrix Formats — import • spam</title>

<!-- jquery -->
<script src="https://code.jquery.com/jquery-3.1.0.min.js" integrity="sha384-nrOSfDHtoPMzJHjVTdCopGqIqeYETSXhZDFyniQ8ZHcVy08QesyHcnOUpMpqnmWq" crossorigin="anonymous"></script>
<!-- Bootstrap -->
<link href="https://maxcdn.bootstrapcdn.com/bootswatch/3.3.7/yeti/bootstrap.min.css" rel="stylesheet" crossorigin="anonymous">

<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha384-Tc5IQib027qvyjSMfHjOMaLkfuWVxZxUPnCJA7l2mCWNIpG9mGCD8wGNIcPD7Txa" crossorigin="anonymous"></script>

<!-- Font Awesome icons -->
<link href="https://maxcdn.bootstrapcdn.com/font-awesome/4.6.3/css/font-awesome.min.css" rel="stylesheet" integrity="sha384-T8Gy5hrqNKT+hzMclPo118YTQO6cYprQmhrYwIiQ/3axmI1hQomh7Ud2hPOy8SP1" crossorigin="anonymous">

<!-- clipboard.js -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/1.7.1/clipboard.min.js" integrity="sha384-cV+rhyOuRHc9Ub/91rihWcGmMmCXDeksTtCihMupQHSsi8GIIRDG0ThDc3HGQFJ3" crossorigin="anonymous"></script>

<!-- sticky kit -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/sticky-kit/1.1.3/sticky-kit.min.js" integrity="sha256-c4Rlo1ZozqTPE2RLuvbusY3+SU1pQaJC0TjuhygMipw=" crossorigin="anonymous"></script>

<!-- pkgdown -->
<link href="../pkgdown.css" rel="stylesheet">
<script src="../pkgdown.js"></script>



<meta property="og:title" content="Read External Matrix Formats — import" />

<meta property="og:description" content="Read matrices stored in the Harwell-Boeing or MatrixMarket formats." />
<meta name="twitter:card" content="summary" />



<!-- mathjax -->
<script src='https://mathjax.rstudio.com/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML'></script>

<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
<![endif]-->


  </head>

  <body>
    <div class="container template-reference-topic">
      <header>
      <div class="navbar navbar-inverse navbar-fixed-top" role="navigation">
  <div class="container">
    <div class="navbar-header">
      <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar">
        <span class="icon-bar"></span>
        <span class="icon-bar"></span>
        <span class="icon-bar"></span>
      </button>
      <span class="navbar-brand">
        <a class="navbar-link" href="../index.html">spam</a>
        <span class="label label-default" data-toggle="tooltip" data-placement="bottom" title="Released package">2.2.1</span>
      </span>
    </div>

    <div id="navbar" class="navbar-collapse collapse">
      <ul class="nav navbar-nav">
        <li>
  <a href="../index.html">
    <span class="fa fa-home"></span>
     
  </a>
</li>
<li>
  <a href="../articles/spam.html">Vignette</a>
</li>
<li>
  <a href="../reference/index.html">Reference</a>
</li>
<li>
  <a href="../news/index.html">Changelog</a>
</li>
      </ul>
      
      <ul class="nav navbar-nav navbar-right">
        <li>
  <a href="https://git.math.uzh.ch/reinhard.furrer/spam">
Roman Flury's avatar
Roman Flury committed
90
    <span class="fa fa-lg fa-gitlab"></span>
Roman Flury's avatar
Roman Flury committed
91
     
Roman Flury's avatar
Roman Flury committed
92
    gitlab
Roman Flury's avatar
Roman Flury committed
93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224
  </a>
</li>
<li>
  <a href="http://twitter.com/ReinhardFurrer">
    <span class="fa fa-lg fa-twitter"></span>
     
    twitter
  </a>
</li>
      </ul>
      
    </div><!--/.nav-collapse -->
  </div><!--/.container -->
</div><!--/.navbar -->

      
      </header>

<div class="row">
  <div class="col-md-9 contents">
    <div class="page-header">
    <h1>Read External Matrix Formats</h1>
    
    <div class="hidden name"><code>import.Rd</code></div>
    </div>

    <div class="ref-description">
    
    <p>Read matrices stored in the Harwell-Boeing or MatrixMarket formats.</p>
    
    </div>

    <pre class="usage"><span class='fu'>read.HB</span>(<span class='no'>file</span>)
<span class='fu'>read.MM</span>(<span class='no'>file</span>)</pre>
    
    <h2 class="hasAnchor" id="arguments"><a class="anchor" href="#arguments"></a>Arguments</h2>
    <table class="ref-arguments">
    <colgroup><col class="name" /><col class="desc" /></colgroup>
    <tr>
      <th>file</th>
      <td><p>the name of the file to read, as a character scalar.</p>
<p>Alternatively, <code>read.HB</code> and <code>read.MM</code> accept connection
   objects.</p></td>
    </tr>
    </table>
    
    <h2 class="hasAnchor" id="value"><a class="anchor" href="#value"></a>Value</h2>

    <p>A sparse matrix of class  <code>spam</code>.</p>
    
    <h2 class="hasAnchor" id="details"><a class="anchor" href="#details"></a>Details</h2>

    <p>The names of files storing matrices in the
  Harwell-Boeing format usually end in <code>".rua"</code> or <code>".rsa"</code>.
  Those storing matrices in the MatrixMarket format usually end in
  <code>".mtx"</code>.</p>
<p>Currently, only  real assembled Harwell-Boeing can be read with
  <code>read.HB</code>. Reading MatrixMarket formats is more flexible.
  However, as entries of <code>spam</code> matrices are of mode <code>double</code>,
  integers matrices are coerced to doubles, patterns lead to matrices
  containing ones and complex are coerced to the real part thereof. In
  these aforementioned cases, a warning is issued.<br /></p>
<p>MatrixMarket also defines an array format, in which case a (possibly)
  dense <code>spam</code> object is return (retaining only elements which are
  larger than <code>options('spam.eps')</code>. A warning is issued.</p>
    
    <h2 class="hasAnchor" id="note"><a class="anchor" href="#note"></a>Note</h2>

    <p>The functions are based on <code>readHB</code> and <code>readMM</code> from
  the library <code>Matrix</code> to build the connection and read the raw
  data.
  At present, <code>read.MM</code> is more flexible than  <code>readMM</code>.</p>
    
    <h2 class="hasAnchor" id="references"><a class="anchor" href="#references"></a>References</h2>

    <p><a href='http://math.nist.gov/MatrixMarket'>http://math.nist.gov/MatrixMarket</a></p>  
<p><a href='https://sparse.tamu.edu/'>https://sparse.tamu.edu/</a></p>
    

    <h2 class="hasAnchor" id="examples"><a class="anchor" href="#examples"></a>Examples</h2>
    <pre class="examples"><div class='input'>
</div><span class='co'># NOT RUN {</span>
<span class='fu'>image</span>(<span class='fu'>read.MM</span>(<span class='fu'>gzcon</span>(<span class='fu'>url</span>(
  <span class='st'>"ftp://math.nist.gov/pub/MatrixMarket2/Harwell-Boeing/bcspwr/bcspwr01.mtx.gz"</span>))))
<span class='co'># }</span><div class='input'>
</div><span class='co'># NOT RUN {</span>
<span class='co'>## Datasets supplied within Matrix</span>
<span class='fu'>str</span>(<span class='fu'>read.MM</span>(<span class='fu'>system.file</span>(<span class='st'>"external/pores_1.mtx"</span>,<span class='kw'>package</span> <span class='kw'>=</span> <span class='st'>"Matrix"</span>)))
<span class='fu'>str</span>(<span class='fu'>read.HB</span>(<span class='fu'>system.file</span>(<span class='st'>"external/utm300.rua"</span>, <span class='kw'>package</span> <span class='kw'>=</span> <span class='st'>"Matrix"</span>)))
<span class='fu'>str</span>(<span class='fu'>read.MM</span>(<span class='fu'>system.file</span>(<span class='st'>"external/lund_a.mtx"</span>, <span class='kw'>package</span> <span class='kw'>=</span> <span class='st'>"Matrix"</span>)))
<span class='fu'>str</span>(<span class='fu'>read.HB</span>(<span class='fu'>system.file</span>(<span class='st'>"external/lund_a.rsa"</span>, <span class='kw'>package</span> <span class='kw'>=</span> <span class='st'>"Matrix"</span>)))
<span class='co'># }</span></pre>
  </div>
  <div class="col-md-3 hidden-xs hidden-sm" id="sidebar">
    <h2>Contents</h2>
    <ul class="nav nav-pills nav-stacked">
      <li><a href="#arguments">Arguments</a></li>
      
      <li><a href="#value">Value</a></li>

      <li><a href="#details">Details</a></li>

      <li><a href="#note">Note</a></li>

      <li><a href="#references">References</a></li>
      
      <li><a href="#examples">Examples</a></li>
    </ul>

    <h2>Author</h2>
    Reinhard Furrer based on <code>Matrix</code> functions by
  Douglas Bates <a href='mailto:bates@stat.wisc.edu'>bates@stat.wisc.edu</a> and Martin Maechler <a href='mailto:maechler@stat.math.ethz.ch'>maechler@stat.math.ethz.ch</a>
  </div>
</div>

      <footer>
      <div class="copyright">
  <p>Developed by Reinhard Furrer.</p>
</div>

<div class="pkgdown">
  <p>Site built with <a href="http://pkgdown.r-lib.org/">pkgdown</a>.</p>
</div>

      </footer>
   </div>

  

  </body>
</html>