File: Sparse-Functions.html

package info (click to toggle)
octave 10.3.0-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 145,388 kB
  • sloc: cpp: 335,976; ansic: 82,241; fortran: 20,963; objc: 9,402; sh: 8,756; yacc: 4,392; lex: 4,333; perl: 1,544; java: 1,366; awk: 1,259; makefile: 659; xml: 192
file content (107 lines) | stat: -rw-r--r-- 5,090 bytes parent folder | download | duplicates (2)
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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
<!DOCTYPE html>
<html>
<!-- Created by GNU Texinfo 7.1.1, https://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Sparse Functions (GNU Octave (version 10.3.0))</title>

<meta name="description" content="Sparse Functions (GNU Octave (version 10.3.0))">
<meta name="keywords" content="Sparse Functions (GNU Octave (version 10.3.0))">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta name="viewport" content="width=device-width,initial-scale=1">

<link href="index.html" rel="start" title="Top">
<link href="Concept-Index.html" rel="index" title="Concept Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Operators-and-Functions.html" rel="up" title="Operators and Functions">
<link href="Return-Types-of-Operators-and-Functions.html" rel="next" title="Return Types of Operators and Functions">
<style type="text/css">
<!--
a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
span:hover a.copiable-link {visibility: visible}
-->
</style>
<link rel="stylesheet" type="text/css" href="octave.css">


</head>

<body lang="en">
<div class="subsubsection-level-extent" id="Sparse-Functions">
<div class="nav-panel">
<p>
Next: <a href="Return-Types-of-Operators-and-Functions.html" accesskey="n" rel="next">Return Types of Operators and Functions</a>, Up: <a href="Operators-and-Functions.html" accesskey="u" rel="up">Basic Operators and Functions on Sparse Matrices</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<h4 class="subsubsection" id="Sparse-Functions-1"><span>22.1.4.1 Sparse Functions<a class="copiable-link" href="#Sparse-Functions-1"> &para;</a></span></h4>

<p>Many Octave functions have been overloaded to work with either sparse or full
matrices.  There is no difference in calling convention when using an
overloaded function with a sparse matrix, however, there is also no access to
potentially sparse-specific features.  At any time the sparse matrix specific
version of a function can be used by explicitly calling its function name.
</p>
<p>The table below lists all of the sparse functions of Octave.  Note that the
names of the specific sparse forms of the functions are typically the same as
the general versions with a <em class="dfn">sp</em> prefix.  In the table below, and in the
rest of this article, the specific sparse versions of functions are used.
</p>

<dl class="table">
<dt>Generate sparse matrices:</dt>
<dd><p><em class="dfn">spalloc</em>, <em class="dfn">spdiags</em>, <em class="dfn">speye</em>, <em class="dfn">sprand</em>,
  <em class="dfn">sprandn</em>, <em class="dfn">sprandsym</em>
</p>
</dd>
<dt>Sparse matrix conversion:</dt>
<dd><p><em class="dfn">full</em>, <em class="dfn">sparse</em>, <em class="dfn">spconvert</em>
</p>
</dd>
<dt>Manipulate sparse matrices</dt>
<dd><p><em class="dfn">issparse</em>, <em class="dfn">nnz</em>, <em class="dfn">nonzeros</em>, <em class="dfn">nzmax</em>,
  <em class="dfn">spfun</em>, <em class="dfn">spones</em>, <em class="dfn">spy</em>
</p>
</dd>
<dt>Graph Theory:</dt>
<dd><p><em class="dfn">etree</em>, <em class="dfn">etreeplot</em>, <em class="dfn">gplot</em>,
  <em class="dfn">treeplot</em>
</p>
</dd>
<dt>Sparse matrix reordering:</dt>
<dd><p><em class="dfn">amd</em>, <em class="dfn">ccolamd</em>, <em class="dfn">colamd</em>, <em class="dfn">colperm</em>, <em class="dfn">csymamd</em>,
  <em class="dfn">dmperm</em>, <em class="dfn">symamd</em>, <em class="dfn">randperm</em>, <em class="dfn">symrcm</em>
</p>
</dd>
<dt>Linear algebra:</dt>
<dd><p><em class="dfn">condest</em>, <em class="dfn">eigs</em>, <em class="dfn">matrix_type</em>,
  <em class="dfn">normest</em>, <em class="dfn">normest1</em>, <em class="dfn">sprank</em>, <em class="dfn">spaugment</em>, <em class="dfn">svds</em>
</p>
</dd>
<dt>Iterative techniques:</dt>
<dd><p><em class="dfn">ichol</em>, <em class="dfn">ilu</em>, <em class="dfn">pcg</em>, <em class="dfn">pcr</em>
</p>
</dd>
<dt>Miscellaneous:</dt>
<dd><p><em class="dfn">spparms</em>, <em class="dfn">symbfact</em>, <em class="dfn">spstats</em>
</p></dd>
</dl>

<p>In addition all of the standard Octave mapper functions (i.e., basic
math functions that take a single argument) such as <em class="dfn">abs</em>, etc.
can accept sparse matrices.  The reader is referred to the documentation
supplied with these functions within Octave itself for further
details.
</p>
</div>
<hr>
<div class="nav-panel">
<p>
Next: <a href="Return-Types-of-Operators-and-Functions.html">Return Types of Operators and Functions</a>, Up: <a href="Operators-and-Functions.html">Basic Operators and Functions on Sparse Matrices</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html" title="Index" rel="index">Index</a>]</p>
</div>



</body>
</html>