Google Git
Sign in
apache / systemds / d7838c8d55e38db7d9ead5104ba8696eec64ac9a / . / docs / api / java / org / apache / sysds / runtime / data / SparseBlockCOO.html
blob: 98c78e43a462c4b4ff7d58dc2bbfd44548c77990 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>SparseBlockCOO (Apache SystemDS 3.2.0-SNAPSHOT API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../jquery/jquery-3.6.0.min.js"></script>
<script type="text/javascript" src="../../../../../jquery/jquery-ui.min.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="SparseBlockCOO (Apache SystemDS 3.2.0-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":9,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":10,"i35":10,"i36":10,"i37":10,"i38":10,"i39":10,"i40":10,"i41":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/SparseBlockCOO.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.sysds.runtime.data</a></div>
<h2 title="Class SparseBlockCOO" class="title">Class SparseBlockCOO</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="SparseBlock.html" title="class in org.apache.sysds.runtime.data">org.apache.sysds.runtime.data.SparseBlock</a></li>
<li>
<ul class="inheritance">
<li>org.apache.sysds.runtime.data.SparseBlockCOO</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/Serializable.html?is-external=true" title="class or interface in java.io" class="externalLink">Serializable</a></code>, <code><a href="Block.html" title="interface in org.apache.sysds.runtime.data">Block</a></code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">SparseBlockCOO</span>
extends <a href="SparseBlock.html" title="class in org.apache.sysds.runtime.data">SparseBlock</a></pre>
<div class="block">SparseBlock implementation that realizes a traditional 'coordinate matrix'
representation, where the entire sparse block is stored as triples in three arrays:
row indexes, column indexes, and values, where row indexes and colunm indexes are
sorted in order to allow binary search. This format is very memory efficient for
ultra-sparse matrices, allows fast incremental construction but has performance
drawbacks for row-major access through our sparse block abstraction since there
is no constant-time random access to individual rows. Similar to CSR, the nnz
is limited to Integer.MAX_VALUE.
In contrast to COO matrix formats with three arrays, we use 1+#dims arrays
to represent the values and indexes of all dimensions.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../serialized-form.html#org.apache.sysds.runtime.data.SparseBlockCOO">Serialized Form</a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<ul class="blockList">
<li class="blockList"><a id="nested.classes.inherited.from.class.org.apache.sysds.runtime.data.SparseBlock">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from class&nbsp;org.apache.sysds.runtime.data.<a href="SparseBlock.html" title="class in org.apache.sysds.runtime.data">SparseBlock</a></h3>
<code><a href="SparseBlock.Type.html" title="enum in org.apache.sysds.runtime.data">SparseBlock.Type</a></code></li>
</ul>
</li>
</ul>
</section>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(int)">SparseBlockCOO</a></span>&#8203;(int&nbsp;rlen)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(int,int)">SparseBlockCOO</a></span>&#8203;(int&nbsp;rlen,
int&nbsp;capacity)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.sysds.runtime.data.SparseBlock)">SparseBlockCOO</a></span>&#8203;(<a href="SparseBlock.html" title="class in org.apache.sysds.runtime.data">SparseBlock</a>&nbsp;sblock)</code></th>
<td class="colLast">
<div class="block">Copy constructor sparse block abstraction.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.sysds.runtime.data.SparseRow%5B%5D,int)">SparseBlockCOO</a></span>&#8203;(<a href="SparseRow.html" title="class in org.apache.sysds.runtime.data">SparseRow</a>[]&nbsp;rows,
int&nbsp;nnz)</code></th>
<td class="colLast">
<div class="block">Copy constructor old sparse row representation.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#add(int,int,double)">add</a></span>&#8203;(int&nbsp;r,
int&nbsp;c,
double&nbsp;v)</code></th>
<td class="colLast">
<div class="block">Add a value to a matrix cell (r,c).</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#allocate(int)">allocate</a></span>&#8203;(int&nbsp;r)</code></th>
<td class="colLast">
<div class="block">Allocate the underlying data structure holding non-zero values
of row r if necessary.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#allocate(int,int)">allocate</a></span>&#8203;(int&nbsp;r,
int&nbsp;nnz)</code></th>
<td class="colLast">
<div class="block">Allocate the underlying data structure holding non-zero values
of row r if necessary, w/ given size.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#allocate(int,int,int)">allocate</a></span>&#8203;(int&nbsp;r,
int&nbsp;ennz,
int&nbsp;maxnnz)</code></th>
<td class="colLast">
<div class="block">Allocate the underlying data structure holding non-zero values
of row r w/ the specified estimated nnz and max nnz.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#append(int,int,double)">append</a></span>&#8203;(int&nbsp;r,
int&nbsp;c,
double&nbsp;v)</code></th>
<td class="colLast">
<div class="block">Append a value to the end of the physical representation.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#checkValidity(int,int,long,boolean)">checkValidity</a></span>&#8203;(int&nbsp;rlen,
int&nbsp;clen,
long&nbsp;nnz,
boolean&nbsp;strict)</code></th>
<td class="colLast">
<div class="block">Validate the correctness of the internal data structures of the different
sparse block implementations.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#compact(int)">compact</a></span>&#8203;(int&nbsp;r)</code></th>
<td class="colLast">
<div class="block">Re-allocate physical row if physical size exceeds
logical size plus resize factor.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#deleteIndexRange(int,int,int)">deleteIndexRange</a></span>&#8203;(int&nbsp;r,
int&nbsp;cl,
int&nbsp;cu)</code></th>
<td class="colLast">
<div class="block">Deletes all non-zero values of the given column range [cl,cu) in row r.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>static long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#estimateSizeInMemory(long,long,double)">estimateSizeInMemory</a></span>&#8203;(long&nbsp;nrows,
long&nbsp;ncols,
double&nbsp;sparsity)</code></th>
<td class="colLast">
<div class="block">Get the estimated in-memory size of the sparse block in COO
with the given dimensions w/o accounting for overallocation.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="SparseRow.html" title="class in org.apache.sysds.runtime.data">SparseRow</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#get(int)">get</a></span>&#8203;(int&nbsp;r)</code></th>
<td class="colLast">
<div class="block">Get values of row r in the format of a sparse row.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>double</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#get(int,int)">get</a></span>&#8203;(int&nbsp;r,
int&nbsp;c)</code></th>
<td class="colLast">
<div class="block">Get value of matrix cell (r,c).</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Iterator.html?is-external=true" title="class or interface in java.util" class="externalLink">Iterator</a>&lt;<a href="../matrix/data/IJV.html" title="class in org.apache.sysds.runtime.matrix.data">IJV</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getIterator()">getIterator</a></span>()</code></th>
<td class="colLast">
<div class="block">Get a non-zero iterator over the entire sparse block.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Iterator.html?is-external=true" title="class or interface in java.util" class="externalLink">Iterator</a>&lt;<a href="../matrix/data/IJV.html" title="class in org.apache.sysds.runtime.matrix.data">IJV</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getIterator(int)">getIterator</a></span>&#8203;(int&nbsp;ru)</code></th>
<td class="colLast">
<div class="block">Get a non-zero iterator over the partial sparse block [0,ru).</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Iterator.html?is-external=true" title="class or interface in java.util" class="externalLink">Iterator</a>&lt;<a href="../matrix/data/IJV.html" title="class in org.apache.sysds.runtime.matrix.data">IJV</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getIterator(int,int)">getIterator</a></span>&#8203;(int&nbsp;rl,
int&nbsp;ru)</code></th>
<td class="colLast">
<div class="block">Get a non-zero iterator over the subblock [rl, ru).</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>int[]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#indexes()">indexes</a></span>()</code></th>
<td class="colLast">
<div class="block">Get raw access to underlying array of column indices
For use in GPU code</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>int[]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#indexes(int)">indexes</a></span>&#8203;(int&nbsp;r)</code></th>
<td class="colLast">
<div class="block">Get the sorted array of column indexes of all non-zero entries in
row r.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isAllocated(int)">isAllocated</a></span>&#8203;(int&nbsp;r)</code></th>
<td class="colLast">
<div class="block">Indicates if the underlying data structure for a given row
is already allocated.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isContiguous()">isContiguous</a></span>()</code></th>
<td class="colLast">
<div class="block">Indicates if the underlying data structures returned by values
and indexes are contiguous arrays, which can be exploited for
more efficient operations.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isEmpty(int)">isEmpty</a></span>&#8203;(int&nbsp;r)</code></th>
<td class="colLast">
<div class="block">Get information if row r is empty, i.e., does not contain non-zero
values.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isThreadSafe()">isThreadSafe</a></span>()</code></th>
<td class="colLast">
<div class="block">Indicates if the underlying implementation allows thread-safe row
updates if concurrent threads update disjoint rows.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#numRows()">numRows</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the number of rows in the sparse block.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#pos(int)">pos</a></span>&#8203;(int&nbsp;r)</code></th>
<td class="colLast">
<div class="block">Get the starting position of row r in the indexes/values arrays returned
by indexes(r) and values(r).</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#posFIndexGT(int,int)">posFIndexGT</a></span>&#8203;(int&nbsp;r,
int&nbsp;c)</code></th>
<td class="colLast">
<div class="block">Get position of first column index greater than column c in row r.</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#posFIndexGTE(int,int)">posFIndexGTE</a></span>&#8203;(int&nbsp;r,
int&nbsp;c)</code></th>
<td class="colLast">
<div class="block">Get position of first column index greater than or equal column c
in row r.</div>
</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#posFIndexLTE(int,int)">posFIndexLTE</a></span>&#8203;(int&nbsp;r,
int&nbsp;c)</code></th>
<td class="colLast">
<div class="block">Get position of first column index lower than or equal column c
in row r.</div>
</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#reset()">reset</a></span>()</code></th>
<td class="colLast">
<div class="block">Clears the sparse block by deleting non-zero values.</div>
</td>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#reset(int,int)">reset</a></span>&#8203;(int&nbsp;ennz,
int&nbsp;maxnnz)</code></th>
<td class="colLast">
<div class="block">Clears the sparse block by deleting non-zero values.</div>
</td>
</tr>
<tr id="i27" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#reset(int,int,int)">reset</a></span>&#8203;(int&nbsp;r,
int&nbsp;ennz,
int&nbsp;maxnnz)</code></th>
<td class="colLast">
<div class="block">Clears row r of the sparse block by deleting non-zero values.</div>
</td>
</tr>
<tr id="i28" class="altColor">
<td class="colFirst"><code>int[]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#rowIndexes()">rowIndexes</a></span>()</code></th>
<td class="colLast">
<div class="block">Get raw access to underlying array of row indices
For use in GPU code</div>
</td>
</tr>
<tr id="i29" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#set(int,int,double)">set</a></span>&#8203;(int&nbsp;r,
int&nbsp;c,
double&nbsp;v)</code></th>
<td class="colLast">
<div class="block">Set the value of a matrix cell (r,c).</div>
</td>
</tr>
<tr id="i30" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#set(int,org.apache.sysds.runtime.data.SparseRow,boolean)">set</a></span>&#8203;(int&nbsp;r,
<a href="SparseRow.html" title="class in org.apache.sysds.runtime.data">SparseRow</a>&nbsp;row,
boolean&nbsp;deep)</code></th>
<td class="colLast">
<div class="block">Set the values of row r to the given sparse row.</div>
</td>
</tr>
<tr id="i31" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setIndexRange(int,int,int,double%5B%5D,int%5B%5D,int,int)">setIndexRange</a></span>&#8203;(int&nbsp;r,
int&nbsp;cl,
int&nbsp;cu,
double[]&nbsp;v,
int[]&nbsp;vix,
int&nbsp;vpos,
int&nbsp;vlen)</code></th>
<td class="colLast">
<div class="block">Sets a sparse array of non-zeros values and indexes into the column range [cl,cu)
in row r.</div>
</td>
</tr>
<tr id="i32" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setIndexRange(int,int,int,double%5B%5D,int,int)">setIndexRange</a></span>&#8203;(int&nbsp;r,
int&nbsp;cl,
int&nbsp;cu,
double[]&nbsp;v,
int&nbsp;vix,
int&nbsp;vlen)</code></th>
<td class="colLast">
<div class="block">Sets a dense array of non-zeros values into the column range [cl,cu)
in row r.</div>
</td>
</tr>
<tr id="i33" class="rowColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#size()">size</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the number of non-zero values in the sparse block.</div>
</td>
</tr>
<tr id="i34" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#size(int)">size</a></span>&#8203;(int&nbsp;r)</code></th>
<td class="colLast">
<div class="block">Get the number of non-zero values in row r.</div>
</td>
</tr>
<tr id="i35" class="rowColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#size(int,int)">size</a></span>&#8203;(int&nbsp;rl,
int&nbsp;ru)</code></th>
<td class="colLast">
<div class="block">Get the number of non-zeros values in the row range
of [rl, ru).</div>
</td>
</tr>
<tr id="i36" class="altColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#size(int,int,int,int)">size</a></span>&#8203;(int&nbsp;rl,
int&nbsp;ru,
int&nbsp;cl,
int&nbsp;cu)</code></th>
<td class="colLast">
<div class="block">Get the number of non-zeros values in the row and column
range of [rl/cl, ru/cu);</div>
</td>
</tr>
<tr id="i37" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sort()">sort</a></span>()</code></th>
<td class="colLast">
<div class="block">Sort all non-zero value/index pairs of the sparse block by row
and column index.</div>
</td>
</tr>
<tr id="i38" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sort(int)">sort</a></span>&#8203;(int&nbsp;r)</code></th>
<td class="colLast">
<div class="block">Sort all non-zero value/index pairs of row r column index.</div>
</td>
</tr>
<tr id="i39" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toString()">toString</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i40" class="altColor">
<td class="colFirst"><code>double[]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#values()">values</a></span>()</code></th>
<td class="colLast">
<div class="block">Get raw access to underlying array of values
For use in GPU code</div>
</td>
</tr>
<tr id="i41" class="rowColor">
<td class="colFirst"><code>double[]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#values(int)">values</a></span>&#8203;(int&nbsp;r)</code></th>
<td class="colLast">
<div class="block">Get the array of all non-zero entries in row r, sorted by their column
indexes.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.sysds.runtime.data.SparseBlock">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.sysds.runtime.data.<a href="SparseBlock.html" title="class in org.apache.sysds.runtime.data">SparseBlock</a></h3>
<code><a href="SparseBlock.html#contains(double)">contains</a>, <a href="SparseBlock.html#equals(double%5B%5D,int)">equals</a>, <a href="SparseBlock.html#equals(double%5B%5D,int,double)">equals</a>, <a href="SparseBlock.html#equals(java.lang.Object)">equals</a>, <a href="SparseBlock.html#equals(org.apache.sysds.runtime.data.SparseBlock,double)">equals</a>, <a href="SparseBlock.html#isAligned(int,org.apache.sysds.runtime.data.SparseBlock)">isAligned</a>, <a href="SparseBlock.html#isAligned(org.apache.sysds.runtime.data.SparseBlock)">isAligned</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SparseBlockCOO</h4>
<pre>public&nbsp;SparseBlockCOO&#8203;(int&nbsp;rlen)</pre>
</li>
</ul>
<a id="&lt;init&gt;(int,int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SparseBlockCOO</h4>
<pre>public&nbsp;SparseBlockCOO&#8203;(int&nbsp;rlen,
int&nbsp;capacity)</pre>
</li>
</ul>
<a id="&lt;init&gt;(org.apache.sysds.runtime.data.SparseBlock)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SparseBlockCOO</h4>
<pre>public&nbsp;SparseBlockCOO&#8203;(<a href="SparseBlock.html" title="class in org.apache.sysds.runtime.data">SparseBlock</a>&nbsp;sblock)</pre>
<div class="block">Copy constructor sparse block abstraction.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>sblock</code> - sparse block to copy</dd>
</dl>
</li>
</ul>
<a id="&lt;init&gt;(org.apache.sysds.runtime.data.SparseRow[],int)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SparseBlockCOO</h4>
<pre>public&nbsp;SparseBlockCOO&#8203;(<a href="SparseRow.html" title="class in org.apache.sysds.runtime.data">SparseRow</a>[]&nbsp;rows,
int&nbsp;nnz)</pre>
<div class="block">Copy constructor old sparse row representation.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>rows</code> - array of sparse rows</dd>
<dd><code>nnz</code> - number of non-zeros</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="estimateSizeInMemory(long,long,double)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>estimateSizeInMemory</h4>
<pre class="methodSignature">public static&nbsp;long&nbsp;estimateSizeInMemory&#8203;(long&nbsp;nrows,
long&nbsp;ncols,
double&nbsp;sparsity)</pre>
<div class="block">Get the estimated in-memory size of the sparse block in COO
with the given dimensions w/o accounting for overallocation.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>nrows</code> - number of rows</dd>
<dd><code>ncols</code> - number of columns</dd>
<dd><code>sparsity</code> - sparsity ratio</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>memory estimate</dd>
</dl>
</li>
</ul>
<a id="allocate(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>allocate</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;allocate&#8203;(int&nbsp;r)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="SparseBlock.html#allocate(int)">SparseBlock</a></code></span></div>
<div class="block">Allocate the underlying data structure holding non-zero values
of row r if necessary.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="SparseBlock.html#allocate(int)">allocate</a></code>&nbsp;in class&nbsp;<code><a href="SparseBlock.html" title="class in org.apache.sysds.runtime.data">SparseBlock</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>r</code> - row index</dd>
</dl>
</li>
</ul>
<a id="allocate(int,int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>allocate</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;allocate&#8203;(int&nbsp;r,
int&nbsp;nnz)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="SparseBlock.html#allocate(int,int)">SparseBlock</a></code></span></div>
<div class="block">Allocate the underlying data structure holding non-zero values
of row r if necessary, w/ given size.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="SparseBlock.html#allocate(int,int)">allocate</a></code>&nbsp;in class&nbsp;<code><a href="SparseBlock.html" title="class in org.apache.sysds.runtime.data">SparseBlock</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>r</code> - row index</dd>
<dd><code>nnz</code> - number of non-zeros</dd>
</dl>
</li>
</ul>
<a id="allocate(int,int,int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>allocate</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;allocate&#8203;(int&nbsp;r,
int&nbsp;ennz,
int&nbsp;maxnnz)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="SparseBlock.html#allocate(int,int,int)">SparseBlock</a></code></span></div>
<div class="block">Allocate the underlying data structure holding non-zero values
of row r w/ the specified estimated nnz and max nnz.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="SparseBlock.html#allocate(int,int,int)">allocate</a></code>&nbsp;in class&nbsp;<code><a href="SparseBlock.html" title="class in org.apache.sysds.runtime.data">SparseBlock</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>r</code> - row index</dd>
<dd><code>ennz</code> - estimated non-zeros</dd>
<dd><code>maxnnz</code> - max non-zeros</dd>
</dl>
</li>
</ul>
<a id="compact(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>compact</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;compact&#8203;(int&nbsp;r)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="SparseBlock.html#compact(int)">SparseBlock</a></code></span></div>
<div class="block">Re-allocate physical row if physical size exceeds
logical size plus resize factor.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="SparseBlock.html#compact(int)">compact</a></code>&nbsp;in class&nbsp;<code><a href="SparseBlock.html" title="class in org.apache.sysds.runtime.data">SparseBlock</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>r</code> - row index</dd>
</dl>
</li>
</ul>
<a id="numRows()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>numRows</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;numRows()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="SparseBlock.html#numRows()">SparseBlock</a></code></span></div>
<div class="block">Get the number of rows in the sparse block.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="SparseBlock.html#numRows()">numRows</a></code>&nbsp;in class&nbsp;<code><a href="SparseBlock.html" title="class in org.apache.sysds.runtime.data">SparseBlock</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>number of rows</dd>
</dl>
</li>
</ul>
<a id="isThreadSafe()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isThreadSafe</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isThreadSafe()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="SparseBlock.html#isThreadSafe()">SparseBlock</a></code></span></div>
<div class="block">Indicates if the underlying implementation allows thread-safe row
updates if concurrent threads update disjoint rows.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="SparseBlock.html#isThreadSafe()">isThreadSafe</a></code>&nbsp;in class&nbsp;<code><a href="SparseBlock.html" title="class in org.apache.sysds.runtime.data">SparseBlock</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if thread-safe row updates</dd>
</dl>
</li>
</ul>
<a id="isContiguous()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isContiguous</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isContiguous()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="SparseBlock.html#isContiguous()">SparseBlock</a></code></span></div>
<div class="block">Indicates if the underlying data structures returned by values
and indexes are contiguous arrays, which can be exploited for
more efficient operations.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="SparseBlock.html#isContiguous()">isContiguous</a></code>&nbsp;in class&nbsp;<code><a href="SparseBlock.html" title="class in org.apache.sysds.runtime.data">SparseBlock</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if underlying data structures are contiguous arrays</dd>
</dl>
</li>
</ul>
<a id="isAllocated(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isAllocated</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isAllocated&#8203;(int&nbsp;r)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="SparseBlock.html#isAllocated(int)">SparseBlock</a></code></span></div>
<div class="block">Indicates if the underlying data structure for a given row
is already allocated.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="SparseBlock.html#isAllocated(int)">isAllocated</a></code>&nbsp;in class&nbsp;<code><a href="SparseBlock.html" title="class in org.apache.sysds.runtime.data">SparseBlock</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>r</code> - row index</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if already allocated</dd>
</dl>
</li>
</ul>
<a id="checkValidity(int,int,long,boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>checkValidity</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;checkValidity&#8203;(int&nbsp;rlen,
int&nbsp;clen,
long&nbsp;nnz,
boolean&nbsp;strict)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="SparseBlock.html#checkValidity(int,int,long,boolean)">SparseBlock</a></code></span></div>
<div class="block">Validate the correctness of the internal data structures of the different
sparse block implementations.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="SparseBlock.html#checkValidity(int,int,long,boolean)">checkValidity</a></code>&nbsp;in class&nbsp;<code><a href="SparseBlock.html" title="class in org.apache.sysds.runtime.data">SparseBlock</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>rlen</code> - number of rows</dd>
<dd><code>clen</code> - number of columns</dd>
<dd><code>nnz</code> - number of non zeros</dd>
<dd><code>strict</code> - enforce optional properties</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the sparse block is valid wrt the corresponding format
such as COO, CSR, MCSR.</dd>
</dl>
</li>
</ul>
<a id="reset()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>reset</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;reset()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="SparseBlock.html#reset()">SparseBlock</a></code></span></div>
<div class="block">Clears the sparse block by deleting non-zero values. After this call
all size() calls are guaranteed to return 0.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="SparseBlock.html#reset()">reset</a></code>&nbsp;in class&nbsp;<code><a href="SparseBlock.html" title="class in org.apache.sysds.runtime.data">SparseBlock</a></code></dd>
</dl>
</li>
</ul>
<a id="reset(int,int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>reset</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;reset&#8203;(int&nbsp;ennz,
int&nbsp;maxnnz)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="SparseBlock.html#reset(int,int)">SparseBlock</a></code></span></div>
<div class="block">Clears the sparse block by deleting non-zero values. After this call
all size() calls are guaranteed to return 0.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="SparseBlock.html#reset(int,int)">reset</a></code>&nbsp;in class&nbsp;<code><a href="SparseBlock.html" title="class in org.apache.sysds.runtime.data">SparseBlock</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>ennz</code> - estimated non-zeros</dd>
<dd><code>maxnnz</code> - max non-zeros</dd>
</dl>
</li>
</ul>
<a id="reset(int,int,int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>reset</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;reset&#8203;(int&nbsp;r,
int&nbsp;ennz,
int&nbsp;maxnnz)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="SparseBlock.html#reset(int,int,int)">SparseBlock</a></code></span></div>
<div class="block">Clears row r of the sparse block by deleting non-zero values.
After this call size(r) is guaranteed to return 0.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="SparseBlock.html#reset(int,int,int)">reset</a></code>&nbsp;in class&nbsp;<code><a href="SparseBlock.html" title="class in org.apache.sysds.runtime.data">SparseBlock</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>r</code> - row index</dd>
<dd><code>ennz</code> - estimated non-zeros</dd>
<dd><code>maxnnz</code> - max non-zeros</dd>
</dl>
</li>
</ul>
<a id="size()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>size</h4>
<pre class="methodSignature">public&nbsp;long&nbsp;size()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="SparseBlock.html#size()">SparseBlock</a></code></span></div>
<div class="block">Get the number of non-zero values in the sparse block.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="SparseBlock.html#size()">size</a></code>&nbsp;in class&nbsp;<code><a href="SparseBlock.html" title="class in org.apache.sysds.runtime.data">SparseBlock</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>number of non-zero values in sparse block</dd>
</dl>
</li>
</ul>
<a id="size(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>size</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;size&#8203;(int&nbsp;r)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="SparseBlock.html#size(int)">SparseBlock</a></code></span></div>
<div class="block">Get the number of non-zero values in row r.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="SparseBlock.html#size(int)">size</a></code>&nbsp;in class&nbsp;<code><a href="SparseBlock.html" title="class in org.apache.sysds.runtime.data">SparseBlock</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>r</code> - row index starting at 0</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>number of non-zero values in row r</dd>
</dl>
</li>
</ul>
<a id="size(int,int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>size</h4>
<pre class="methodSignature">public&nbsp;long&nbsp;size&#8203;(int&nbsp;rl,
int&nbsp;ru)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="SparseBlock.html#size(int,int)">SparseBlock</a></code></span></div>
<div class="block">Get the number of non-zeros values in the row range
of [rl, ru).</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="SparseBlock.html#size(int,int)">size</a></code>&nbsp;in class&nbsp;<code><a href="SparseBlock.html" title="class in org.apache.sysds.runtime.data">SparseBlock</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>rl</code> - row lower index</dd>
<dd><code>ru</code> - row upper index</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>number of non-zero values in the row range</dd>
</dl>
</li>
</ul>
<a id="size(int,int,int,int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>size</h4>
<pre class="methodSignature">public&nbsp;long&nbsp;size&#8203;(int&nbsp;rl,
int&nbsp;ru,
int&nbsp;cl,
int&nbsp;cu)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="SparseBlock.html#size(int,int,int,int)">SparseBlock</a></code></span></div>
<div class="block">Get the number of non-zeros values in the row and column
range of [rl/cl, ru/cu);</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="SparseBlock.html#size(int,int,int,int)">size</a></code>&nbsp;in class&nbsp;<code><a href="SparseBlock.html" title="class in org.apache.sysds.runtime.data">SparseBlock</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>rl</code> - row lower index</dd>
<dd><code>ru</code> - row upper index</dd>
<dd><code>cl</code> - column lower index</dd>
<dd><code>cu</code> - column upper index</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>number of non-zero values in the row and column range</dd>
</dl>
</li>
</ul>
<a id="isEmpty(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isEmpty</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isEmpty&#8203;(int&nbsp;r)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="SparseBlock.html#isEmpty(int)">SparseBlock</a></code></span></div>
<div class="block">Get information if row r is empty, i.e., does not contain non-zero
values. Equivalent to size(r)==0. Users should do this check if
it is unknown if the underlying row data structure is allocated.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="SparseBlock.html#isEmpty(int)">isEmpty</a></code>&nbsp;in class&nbsp;<code><a href="SparseBlock.html" title="class in org.apache.sysds.runtime.data">SparseBlock</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>r</code> - row index starting at 0</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if row does not contain non-zero values</dd>
</dl>
</li>
</ul>
<a id="indexes(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>indexes</h4>
<pre class="methodSignature">public&nbsp;int[]&nbsp;indexes&#8203;(int&nbsp;r)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="SparseBlock.html#indexes(int)">SparseBlock</a></code></span></div>
<div class="block">Get the sorted array of column indexes of all non-zero entries in
row r. Note that - for flexibility of the implementing format - the
returned array may be larger, where the range for row r is given by
[pos(r),pos(r)+size(r)).</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="SparseBlock.html#indexes(int)">indexes</a></code>&nbsp;in class&nbsp;<code><a href="SparseBlock.html" title="class in org.apache.sysds.runtime.data">SparseBlock</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>r</code> - row index starting at 0</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>sorted array of column indexes</dd>
</dl>
</li>
</ul>
<a id="values(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>values</h4>
<pre class="methodSignature">public&nbsp;double[]&nbsp;values&#8203;(int&nbsp;r)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="SparseBlock.html#values(int)">SparseBlock</a></code></span></div>
<div class="block">Get the array of all non-zero entries in row r, sorted by their column
indexes. Note that - for flexibility of the implementing format - the
returned array may be larger, where the range for row r is given by
[pos(r),pos(r)+size(r)).</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="SparseBlock.html#values(int)">values</a></code>&nbsp;in class&nbsp;<code><a href="SparseBlock.html" title="class in org.apache.sysds.runtime.data">SparseBlock</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>r</code> - row index starting at 0</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>array of all non-zero entries in row r sorted by column indexes</dd>
</dl>
</li>
</ul>
<a id="pos(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>pos</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;pos&#8203;(int&nbsp;r)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="SparseBlock.html#pos(int)">SparseBlock</a></code></span></div>
<div class="block">Get the starting position of row r in the indexes/values arrays returned
by indexes(r) and values(r).</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="SparseBlock.html#pos(int)">pos</a></code>&nbsp;in class&nbsp;<code><a href="SparseBlock.html" title="class in org.apache.sysds.runtime.data">SparseBlock</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>r</code> - row index starting at 0</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>starting position of row r</dd>
</dl>
</li>
</ul>
<a id="set(int,int,double)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>set</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;set&#8203;(int&nbsp;r,
int&nbsp;c,
double&nbsp;v)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="SparseBlock.html#set(int,int,double)">SparseBlock</a></code></span></div>
<div class="block">Set the value of a matrix cell (r,c). This might update an existing
non-zero value, insert a new non-zero value, or delete a non-zero value.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="SparseBlock.html#set(int,int,double)">set</a></code>&nbsp;in class&nbsp;<code><a href="SparseBlock.html" title="class in org.apache.sysds.runtime.data">SparseBlock</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>r</code> - row index starting at 0</dd>
<dd><code>c</code> - column index starting at 0</dd>
<dd><code>v</code> - zero or non-zero value</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true, if number of non-zeros changed</dd>
</dl>
</li>
</ul>
<a id="set(int,org.apache.sysds.runtime.data.SparseRow,boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>set</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;set&#8203;(int&nbsp;r,
<a href="SparseRow.html" title="class in org.apache.sysds.runtime.data">SparseRow</a>&nbsp;row,
boolean&nbsp;deep)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="SparseBlock.html#set(int,org.apache.sysds.runtime.data.SparseRow,boolean)">SparseBlock</a></code></span></div>
<div class="block">Set the values of row r to the given sparse row. This might update
existing non-zero values, insert a new row, or delete a row.
NOTE: This method exists for incremental runtime integration and might
be deleted in the future.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="SparseBlock.html#set(int,org.apache.sysds.runtime.data.SparseRow,boolean)">set</a></code>&nbsp;in class&nbsp;<code><a href="SparseBlock.html" title="class in org.apache.sysds.runtime.data">SparseBlock</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>r</code> - row index starting at 0</dd>
<dd><code>row</code> - sparse row</dd>
<dd><code>deep</code> - indicator to create deep copy of sparse row</dd>
</dl>
</li>
</ul>
<a id="add(int,int,double)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>add</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;add&#8203;(int&nbsp;r,
int&nbsp;c,
double&nbsp;v)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="SparseBlock.html#add(int,int,double)">SparseBlock</a></code></span></div>
<div class="block">Add a value to a matrix cell (r,c). This might update an existing
non-zero value, or insert a new non-zero value.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="SparseBlock.html#add(int,int,double)">add</a></code>&nbsp;in class&nbsp;<code><a href="SparseBlock.html" title="class in org.apache.sysds.runtime.data">SparseBlock</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>r</code> - row index starting at 0</dd>
<dd><code>c</code> - column index starting at 0</dd>
<dd><code>v</code> - zero or non-zero value</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true, if number of non-zeros changed</dd>
</dl>
</li>
</ul>
<a id="append(int,int,double)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>append</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;append&#8203;(int&nbsp;r,
int&nbsp;c,
double&nbsp;v)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="SparseBlock.html#append(int,int,double)">SparseBlock</a></code></span></div>
<div class="block">Append a value to the end of the physical representation. This should
only be used for operations with sequential write pattern or if followed
by a sort() operation. Note that this operation does not perform any
matrix cell updates.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="SparseBlock.html#append(int,int,double)">append</a></code>&nbsp;in class&nbsp;<code><a href="SparseBlock.html" title="class in org.apache.sysds.runtime.data">SparseBlock</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>r</code> - row index starting at 0</dd>
<dd><code>c</code> - column index starting at 0</dd>
<dd><code>v</code> - zero or non-zero value</dd>
</dl>
</li>
</ul>
<a id="setIndexRange(int,int,int,double[],int,int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setIndexRange</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setIndexRange&#8203;(int&nbsp;r,
int&nbsp;cl,
int&nbsp;cu,
double[]&nbsp;v,
int&nbsp;vix,
int&nbsp;vlen)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="SparseBlock.html#setIndexRange(int,int,int,double%5B%5D,int,int)">SparseBlock</a></code></span></div>
<div class="block">Sets a dense array of non-zeros values into the column range [cl,cu)
in row r. The passed value array may be larger and the relevant range
is given by [vix,vix+len).</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="SparseBlock.html#setIndexRange(int,int,int,double%5B%5D,int,int)">setIndexRange</a></code>&nbsp;in class&nbsp;<code><a href="SparseBlock.html" title="class in org.apache.sysds.runtime.data">SparseBlock</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>r</code> - row index starting at 0</dd>
<dd><code>cl</code> - lower column index starting at 0</dd>
<dd><code>cu</code> - upper column index starting at 0</dd>
<dd><code>v</code> - value array</dd>
<dd><code>vix</code> - start index in value array</dd>
<dd><code>vlen</code> - number of relevant values</dd>
</dl>
</li>
</ul>
<a id="setIndexRange(int,int,int,double[],int[],int,int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setIndexRange</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setIndexRange&#8203;(int&nbsp;r,
int&nbsp;cl,
int&nbsp;cu,
double[]&nbsp;v,
int[]&nbsp;vix,
int&nbsp;vpos,
int&nbsp;vlen)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="SparseBlock.html#setIndexRange(int,int,int,double%5B%5D,int%5B%5D,int,int)">SparseBlock</a></code></span></div>
<div class="block">Sets a sparse array of non-zeros values and indexes into the column range [cl,cu)
in row r. The passed value array may be larger.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="SparseBlock.html#setIndexRange(int,int,int,double%5B%5D,int%5B%5D,int,int)">setIndexRange</a></code>&nbsp;in class&nbsp;<code><a href="SparseBlock.html" title="class in org.apache.sysds.runtime.data">SparseBlock</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>r</code> - row index starting at 0</dd>
<dd><code>cl</code> - lower column index starting at 0</dd>
<dd><code>cu</code> - upper column index starting at 0</dd>
<dd><code>v</code> - value array</dd>
<dd><code>vix</code> - column index array</dd>
<dd><code>vpos</code> - start index in value and index arrays</dd>
<dd><code>vlen</code> - number of relevant values</dd>
</dl>
</li>
</ul>
<a id="deleteIndexRange(int,int,int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deleteIndexRange</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;deleteIndexRange&#8203;(int&nbsp;r,
int&nbsp;cl,
int&nbsp;cu)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="SparseBlock.html#deleteIndexRange(int,int,int)">SparseBlock</a></code></span></div>
<div class="block">Deletes all non-zero values of the given column range [cl,cu) in row r.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="SparseBlock.html#deleteIndexRange(int,int,int)">deleteIndexRange</a></code>&nbsp;in class&nbsp;<code><a href="SparseBlock.html" title="class in org.apache.sysds.runtime.data">SparseBlock</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>r</code> - row index starting at 0</dd>
<dd><code>cl</code> - lower column index starting at 0</dd>
<dd><code>cu</code> - upper column index starting at 0</dd>
</dl>
</li>
</ul>
<a id="sort()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sort</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;sort()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="SparseBlock.html#sort()">SparseBlock</a></code></span></div>
<div class="block">Sort all non-zero value/index pairs of the sparse block by row
and column index.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="SparseBlock.html#sort()">sort</a></code>&nbsp;in class&nbsp;<code><a href="SparseBlock.html" title="class in org.apache.sysds.runtime.data">SparseBlock</a></code></dd>
</dl>
</li>
</ul>
<a id="sort(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sort</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;sort&#8203;(int&nbsp;r)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="SparseBlock.html#sort(int)">SparseBlock</a></code></span></div>
<div class="block">Sort all non-zero value/index pairs of row r column index.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="SparseBlock.html#sort(int)">sort</a></code>&nbsp;in class&nbsp;<code><a href="SparseBlock.html" title="class in org.apache.sysds.runtime.data">SparseBlock</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>r</code> - row index starting at 0</dd>
</dl>
</li>
</ul>
<a id="get(int,int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>get</h4>
<pre class="methodSignature">public&nbsp;double&nbsp;get&#8203;(int&nbsp;r,
int&nbsp;c)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="SparseBlock.html#get(int,int)">SparseBlock</a></code></span></div>
<div class="block">Get value of matrix cell (r,c). In case of non existing values
this call returns 0.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="Block.html#get(int,int)">get</a></code>&nbsp;in interface&nbsp;<code><a href="Block.html" title="interface in org.apache.sysds.runtime.data">Block</a></code></dd>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="SparseBlock.html#get(int,int)">get</a></code>&nbsp;in class&nbsp;<code><a href="SparseBlock.html" title="class in org.apache.sysds.runtime.data">SparseBlock</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>r</code> - row index starting at 0</dd>
<dd><code>c</code> - column index starting at 0</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>value of cell at position (r,c)</dd>
</dl>
</li>
</ul>
<a id="get(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>get</h4>
<pre class="methodSignature">public&nbsp;<a href="SparseRow.html" title="class in org.apache.sysds.runtime.data">SparseRow</a>&nbsp;get&#8203;(int&nbsp;r)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="SparseBlock.html#get(int)">SparseBlock</a></code></span></div>
<div class="block">Get values of row r in the format of a sparse row.
NOTE: This method exists for incremental runtime integration and might
be deleted in the future.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="SparseBlock.html#get(int)">get</a></code>&nbsp;in class&nbsp;<code><a href="SparseBlock.html" title="class in org.apache.sysds.runtime.data">SparseBlock</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>r</code> - row index starting at 0</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>values of row r as a sparse row</dd>
</dl>
</li>
</ul>
<a id="posFIndexLTE(int,int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>posFIndexLTE</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;posFIndexLTE&#8203;(int&nbsp;r,
int&nbsp;c)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="SparseBlock.html#posFIndexLTE(int,int)">SparseBlock</a></code></span></div>
<div class="block">Get position of first column index lower than or equal column c
in row r. The position is relative to the indexes/values arrays
returned by indexes(r) and values(r). If no such value exists,
this call returns -1.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="SparseBlock.html#posFIndexLTE(int,int)">posFIndexLTE</a></code>&nbsp;in class&nbsp;<code><a href="SparseBlock.html" title="class in org.apache.sysds.runtime.data">SparseBlock</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>r</code> - row index starting at 0</dd>
<dd><code>c</code> - column index starting at 0</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>position of the first column index lower than or equal to column c in row r</dd>
</dl>
</li>
</ul>
<a id="posFIndexGTE(int,int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>posFIndexGTE</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;posFIndexGTE&#8203;(int&nbsp;r,
int&nbsp;c)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="SparseBlock.html#posFIndexGTE(int,int)">SparseBlock</a></code></span></div>
<div class="block">Get position of first column index greater than or equal column c
in row r. The position is relative to the indexes/values arrays
returned by indexes(r) and values(r). If no such value exists,
this call returns -1.
Note if CSR the pos(r) is subtracted from the result.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="SparseBlock.html#posFIndexGTE(int,int)">posFIndexGTE</a></code>&nbsp;in class&nbsp;<code><a href="SparseBlock.html" title="class in org.apache.sysds.runtime.data">SparseBlock</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>r</code> - row index starting at 0</dd>
<dd><code>c</code> - column index starting at 0</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>position of the first column index greater than or equal to column c in row r</dd>
</dl>
</li>
</ul>
<a id="posFIndexGT(int,int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>posFIndexGT</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;posFIndexGT&#8203;(int&nbsp;r,
int&nbsp;c)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="SparseBlock.html#posFIndexGT(int,int)">SparseBlock</a></code></span></div>
<div class="block">Get position of first column index greater than column c in row r.
The position is relative to the indexes/values arrays returned by
indexes(r) and values(r). If no such value exists, this call
returns -1.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="SparseBlock.html#posFIndexGT(int,int)">posFIndexGT</a></code>&nbsp;in class&nbsp;<code><a href="SparseBlock.html" title="class in org.apache.sysds.runtime.data">SparseBlock</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>r</code> - row index starting at 0</dd>
<dd><code>c</code> - column index starting at 0</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>position of the first column index greater than column c in row r</dd>
</dl>
</li>
</ul>
<a id="getIterator()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIterator</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Iterator.html?is-external=true" title="class or interface in java.util" class="externalLink">Iterator</a>&lt;<a href="../matrix/data/IJV.html" title="class in org.apache.sysds.runtime.matrix.data">IJV</a>&gt;&nbsp;getIterator()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="SparseBlock.html#getIterator()">SparseBlock</a></code></span></div>
<div class="block">Get a non-zero iterator over the entire sparse block. Note that
the returned IJV object is reused across next calls and should
be directly consumed or deep copied.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="SparseBlock.html#getIterator()">getIterator</a></code>&nbsp;in class&nbsp;<code><a href="SparseBlock.html" title="class in org.apache.sysds.runtime.data">SparseBlock</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>IJV iterator</dd>
</dl>
</li>
</ul>
<a id="getIterator(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIterator</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Iterator.html?is-external=true" title="class or interface in java.util" class="externalLink">Iterator</a>&lt;<a href="../matrix/data/IJV.html" title="class in org.apache.sysds.runtime.matrix.data">IJV</a>&gt;&nbsp;getIterator&#8203;(int&nbsp;ru)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="SparseBlock.html#getIterator(int)">SparseBlock</a></code></span></div>
<div class="block">Get a non-zero iterator over the partial sparse block [0,ru). Note
that the returned IJV object is reused across next calls and should
be directly consumed or deep copied.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="SparseBlock.html#getIterator(int)">getIterator</a></code>&nbsp;in class&nbsp;<code><a href="SparseBlock.html" title="class in org.apache.sysds.runtime.data">SparseBlock</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>ru</code> - exclusive upper row index starting at 0</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>IJV iterator</dd>
</dl>
</li>
</ul>
<a id="getIterator(int,int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIterator</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Iterator.html?is-external=true" title="class or interface in java.util" class="externalLink">Iterator</a>&lt;<a href="../matrix/data/IJV.html" title="class in org.apache.sysds.runtime.matrix.data">IJV</a>&gt;&nbsp;getIterator&#8203;(int&nbsp;rl,
int&nbsp;ru)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="SparseBlock.html#getIterator(int,int)">SparseBlock</a></code></span></div>
<div class="block">Get a non-zero iterator over the subblock [rl, ru). Note that
the returned IJV object is reused across next calls and should
be directly consumed or deep copied.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="SparseBlock.html#getIterator(int,int)">getIterator</a></code>&nbsp;in class&nbsp;<code><a href="SparseBlock.html" title="class in org.apache.sysds.runtime.data">SparseBlock</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>rl</code> - inclusive lower row index starting at 0</dd>
<dd><code>ru</code> - exclusive upper row index starting at 0</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>IJV iterator</dd>
</dl>
</li>
</ul>
<a id="toString()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toString</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;toString()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="SparseBlock.html#toString()">toString</a></code>&nbsp;in class&nbsp;<code><a href="SparseBlock.html" title="class in org.apache.sysds.runtime.data">SparseBlock</a></code></dd>
</dl>
</li>
</ul>
<a id="rowIndexes()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>rowIndexes</h4>
<pre class="methodSignature">public&nbsp;int[]&nbsp;rowIndexes()</pre>
<div class="block">Get raw access to underlying array of row indices
For use in GPU code</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>array of row indices</dd>
</dl>
</li>
</ul>
<a id="indexes()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>indexes</h4>
<pre class="methodSignature">public&nbsp;int[]&nbsp;indexes()</pre>
<div class="block">Get raw access to underlying array of column indices
For use in GPU code</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>array of column indices</dd>
</dl>
</li>
</ul>
<a id="values()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>values</h4>
<pre class="methodSignature">public&nbsp;double[]&nbsp;values()</pre>
<div class="block">Get raw access to underlying array of values
For use in GPU code</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>array of values</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/SparseBlockCOO.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>