Google Git
Sign in
apache / systemds / d73bfdb1b71b20b7e56f8ec9f55d8262adca5900 / . / docs / api / java / org / apache / sysds / runtime / controlprogram / caching / MatrixObject.html
blob: f0abf4f66e18b0f53d6b22fe7b13af8ddb74c150 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>MatrixObject (SystemDS 2.0.0-SNAPSHOT API)</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="MatrixObject (SystemDS 2.0.0-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/MatrixObject.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">
<li><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/LazyWriteBuffer.RPolicy.html" title="enum in org.apache.sysds.runtime.controlprogram.caching"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/MatrixObject.UpdateType.html" title="enum in org.apache.sysds.runtime.controlprogram.caching"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/sysds/runtime/controlprogram/caching/MatrixObject.html" target="_top">Frames</a></li>
<li><a href="MatrixObject.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></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>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#fields.inherited.from.class.org.apache.sysds.runtime.controlprogram.caching.CacheableData">Field</a>&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 name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.sysds.runtime.controlprogram.caching</div>
<h2 title="Class MatrixObject" class="title">Class MatrixObject</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../../org/apache/sysds/runtime/instructions/cp/Data.html" title="class in org.apache.sysds.runtime.instructions.cp">org.apache.sysds.runtime.instructions.cp.Data</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html" title="class in org.apache.sysds.runtime.controlprogram.caching">org.apache.sysds.runtime.controlprogram.caching.CacheableData</a>&lt;<a href="../../../../../../org/apache/sysds/runtime/matrix/data/MatrixBlock.html" title="class in org.apache.sysds.runtime.matrix.data">MatrixBlock</a>&gt;</li>
<li>
<ul class="inheritance">
<li>org.apache.sysds.runtime.controlprogram.caching.MatrixObject</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">MatrixObject</span>
extends <a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html" title="class in org.apache.sysds.runtime.controlprogram.caching">CacheableData</a>&lt;<a href="../../../../../../org/apache/sysds/runtime/matrix/data/MatrixBlock.html" title="class in org.apache.sysds.runtime.matrix.data">MatrixBlock</a>&gt;</pre>
<div class="block">Represents a matrix in control program. This class contains method to read
matrices from HDFS and convert them to a specific format/representation. It
is also able to write several formats/representation of matrices to HDFS.
IMPORTANT: Preserve one-to-one correspondence between <a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/MatrixObject.html" title="class in org.apache.sysds.runtime.controlprogram.caching"><code>MatrixObject</code></a>
and <a href="../../../../../../org/apache/sysds/runtime/matrix/data/MatrixBlock.html" title="class in org.apache.sysds.runtime.matrix.data"><code>MatrixBlock</code></a> objects, for cache purposes. Do not change a
<a href="../../../../../../org/apache/sysds/runtime/matrix/data/MatrixBlock.html" title="class in org.apache.sysds.runtime.matrix.data"><code>MatrixBlock</code></a> object without informing its <a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/MatrixObject.html" title="class in org.apache.sysds.runtime.controlprogram.caching"><code>MatrixObject</code></a> object.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../serialized-form.html#org.apache.sysds.runtime.controlprogram.caching.MatrixObject">Serialized Form</a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/MatrixObject.UpdateType.html" title="enum in org.apache.sysds.runtime.controlprogram.caching">MatrixObject.UpdateType</a></span></code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.sysds.runtime.controlprogram.caching.CacheableData">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from class&nbsp;org.apache.sysds.runtime.controlprogram.caching.<a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html" title="class in org.apache.sysds.runtime.controlprogram.caching">CacheableData</a></h3>
<code><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.CacheStatus.html" title="enum in org.apache.sysds.runtime.controlprogram.caching">CacheableData.CacheStatus</a></code></li>
</ul>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.sysds.runtime.controlprogram.caching.CacheableData">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.sysds.runtime.controlprogram.caching.<a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html" title="class in org.apache.sysds.runtime.controlprogram.caching">CacheableData</a></h3>
<code><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#cacheEvictionLocalFilePath">cacheEvictionLocalFilePath</a>, <a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#cacheEvictionLocalFilePrefix">cacheEvictionLocalFilePrefix</a>, <a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#CACHING_ASYNC_FILECLEANUP">CACHING_ASYNC_FILECLEANUP</a>, <a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#CACHING_BUFFER_PAGECACHE">CACHING_BUFFER_PAGECACHE</a>, <a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#CACHING_BUFFER_POLICY">CACHING_BUFFER_POLICY</a>, <a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#CACHING_BUFFER_SIZE">CACHING_BUFFER_SIZE</a>, <a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#CACHING_COUNTER_GROUP_NAME">CACHING_COUNTER_GROUP_NAME</a>, <a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#CACHING_EVICTION_FILEEXTENSION">CACHING_EVICTION_FILEEXTENSION</a>, <a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#CACHING_THRESHOLD">CACHING_THRESHOLD</a>, <a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#CACHING_WRITE_CACHE_ON_READ">CACHING_WRITE_CACHE_ON_READ</a></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/MatrixObject.html#MatrixObject-org.apache.sysds.runtime.controlprogram.caching.MatrixObject-">MatrixObject</a></span>(<a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/MatrixObject.html" title="class in org.apache.sysds.runtime.controlprogram.caching">MatrixObject</a>&nbsp;mo)</code>
<div class="block">Copy constructor that copies meta data but NO data.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/MatrixObject.html#MatrixObject-org.apache.sysds.common.Types.ValueType-java.lang.String-">MatrixObject</a></span>(<a href="../../../../../../org/apache/sysds/common/Types.ValueType.html" title="enum in org.apache.sysds.common">Types.ValueType</a>&nbsp;vt,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;file)</code>
<div class="block">Constructor that takes the value type and the HDFS filename.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/MatrixObject.html#MatrixObject-org.apache.sysds.common.Types.ValueType-java.lang.String-org.apache.sysds.runtime.meta.MetaData-">MatrixObject</a></span>(<a href="../../../../../../org/apache/sysds/common/Types.ValueType.html" title="enum in org.apache.sysds.common">Types.ValueType</a>&nbsp;vt,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;file,
<a href="../../../../../../org/apache/sysds/runtime/meta/MetaData.html" title="class in org.apache.sysds.runtime.meta">MetaData</a>&nbsp;mtd)</code>
<div class="block">Constructor that takes the value type, HDFS filename and associated metadata.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</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="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/sysds/runtime/matrix/data/MatrixBlock.html" title="class in org.apache.sysds.runtime.matrix.data">MatrixBlock</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/MatrixObject.html#acquireRead--">acquireRead</a></span>()</code>
<div class="block">Acquires a shared "read-only" lock, produces the reference to the cache block,
restores the cache block to main memory, reads from HDFS if needed.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/MatrixObject.html#getBlocksize--">getBlocksize</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/MatrixObject.html#getNnz--">getNnz</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/MatrixObject.html#getPartitionFileName-org.apache.sysds.runtime.util.IndexRange-int-">getPartitionFileName</a></span>(<a href="../../../../../../org/apache/sysds/runtime/util/IndexRange.html" title="class in org.apache.sysds.runtime.util">IndexRange</a>&nbsp;pred,
int&nbsp;blen)</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/sysds/runtime/controlprogram/ParForProgramBlock.PDataPartitionFormat.html" title="enum in org.apache.sysds.runtime.controlprogram">ParForProgramBlock.PDataPartitionFormat</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/MatrixObject.html#getPartitionFormat--">getPartitionFormat</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/MatrixObject.html#getPartitionSize--">getPartitionSize</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/MatrixObject.html#getSparsity--">getSparsity</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/MatrixObject.UpdateType.html" title="enum in org.apache.sysds.runtime.controlprogram.caching">MatrixObject.UpdateType</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/MatrixObject.html#getUpdateType--">getUpdateType</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/MatrixObject.html#isDiag--">isDiag</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/MatrixObject.html#isMarked--">isMarked</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/MatrixObject.html#isPartitioned--">isPartitioned</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/sysds/runtime/matrix/data/MatrixBlock.html" title="class in org.apache.sysds.runtime.matrix.data">MatrixBlock</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/MatrixObject.html#readMatrixPartition-org.apache.sysds.runtime.util.IndexRange-">readMatrixPartition</a></span>(<a href="../../../../../../org/apache/sysds/runtime/util/IndexRange.html" title="class in org.apache.sysds.runtime.util">IndexRange</a>&nbsp;pred)</code>
<div class="block">NOTE: for reading matrix partitions, we could cache (in its real sense) the read block
with soft references (no need for eviction, as partitioning only applied for read-only matrices).</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/MatrixObject.html#refreshMetaData--">refreshMetaData</a></span>()</code>
<div class="block">Make the matrix metadata consistent with the in-memory matrix data</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/MatrixObject.html#setDiag-boolean-">setDiag</a></span>(boolean&nbsp;diag)</code>&nbsp;</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/MatrixObject.html#setInMemoryPartition-org.apache.sysds.runtime.matrix.data.MatrixBlock-">setInMemoryPartition</a></span>(<a href="../../../../../../org/apache/sysds/runtime/matrix/data/MatrixBlock.html" title="class in org.apache.sysds.runtime.matrix.data">MatrixBlock</a>&nbsp;block)</code>&nbsp;</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/MatrixObject.html#setMarkForLinCache-boolean-">setMarkForLinCache</a></span>(boolean&nbsp;mark)</code>&nbsp;</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/MatrixObject.html#setPartitioned-org.apache.sysds.runtime.controlprogram.ParForProgramBlock.PDataPartitionFormat-int-">setPartitioned</a></span>(<a href="../../../../../../org/apache/sysds/runtime/controlprogram/ParForProgramBlock.PDataPartitionFormat.html" title="enum in org.apache.sysds.runtime.controlprogram">ParForProgramBlock.PDataPartitionFormat</a>&nbsp;format,
int&nbsp;n)</code>&nbsp;</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/MatrixObject.html#setUpdateType-org.apache.sysds.runtime.controlprogram.caching.MatrixObject.UpdateType-">setUpdateType</a></span>(<a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/MatrixObject.UpdateType.html" title="enum in org.apache.sysds.runtime.controlprogram.caching">MatrixObject.UpdateType</a>&nbsp;flag)</code>&nbsp;</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/MatrixObject.html#unsetPartitioned--">unsetPartitioned</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/MatrixObject.html#updateDataCharacteristics-org.apache.sysds.runtime.meta.DataCharacteristics-">updateDataCharacteristics</a></span>(<a href="../../../../../../org/apache/sysds/runtime/meta/DataCharacteristics.html" title="class in org.apache.sysds.runtime.meta">DataCharacteristics</a>&nbsp;dc)</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.sysds.runtime.controlprogram.caching.CacheableData">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.sysds.runtime.controlprogram.caching.<a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html" title="class in org.apache.sysds.runtime.controlprogram.caching">CacheableData</a></h3>
<code><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#acquireModify-T-">acquireModify</a>, <a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#acquireReadAndRelease--">acquireReadAndRelease</a>, <a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#addBroadcastSize-long-">addBroadcastSize</a>, <a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#cleanupCacheDir--">cleanupCacheDir</a>, <a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#cleanupCacheDir-boolean-">cleanupCacheDir</a>, <a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#clearData--">clearData</a>, <a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#disableCaching--">disableCaching</a>, <a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#enableCaching--">enableCaching</a>, <a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#enableCleanup-boolean-">enableCleanup</a>, <a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#exportData--">exportData</a>, <a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#exportData-int-">exportData</a>, <a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#exportData-java.lang.String-java.lang.String-">exportData</a>, <a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#exportData-java.lang.String-java.lang.String-org.apache.sysds.runtime.io.FileFormatProperties-">exportData</a>, <a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#exportData-java.lang.String-java.lang.String-int-org.apache.sysds.runtime.io.FileFormatProperties-">exportData</a>, <a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#exportData-java.lang.String-java.lang.String-int-org.apache.sysds.runtime.io.FileFormatProperties-java.lang.String-">exportData</a>, <a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#freeEvictedBlob--">freeEvictedBlob</a>, <a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#getBroadcastHandle--">getBroadcastHandle</a>, <a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#getBroadcastSize--">getBroadcastSize</a>, <a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#getDataCharacteristics--">getDataCharacteristics</a>, <a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#getDataSize--">getDataSize</a>, <a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#getDebugName--">getDebugName</a>, <a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#getFedMapping--">getFedMapping</a>, <a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#getFileFormatProperties--">getFileFormatProperties</a>, <a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#getFileName--">getFileName</a>, <a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#getGPUObject-org.apache.sysds.runtime.instructions.gpu.context.GPUContext-">getGPUObject</a>, <a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#getMetaData--">getMetaData</a>, <a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#getNumColumns--">getNumColumns</a>, <a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#getNumRows--">getNumRows</a>, <a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#getPrivacyConstraint--">getPrivacyConstraint</a>, <a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#getRDDHandle--">getRDDHandle</a>, <a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#getStatus--">getStatus</a>, <a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#getUniqueID--">getUniqueID</a>, <a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#initCaching--">initCaching</a>, <a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#initCaching-java.lang.String-">initCaching</a>, <a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#isCached-boolean-">isCached</a>, <a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#isCachingActive--">isCachingActive</a>, <a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#isCleanupEnabled--">isCleanupEnabled</a>, <a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#isDirty--">isDirty</a>, <a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#isFederated--">isFederated</a>, <a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#isHDFSFileExists--">isHDFSFileExists</a>, <a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#moveData-java.lang.String-java.lang.String-">moveData</a>, <a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#release--">release</a>, <a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#removeMetaData--">removeMetaData</a>, <a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#setBroadcastHandle-org.apache.sysds.runtime.instructions.spark.data.BroadcastObject-">setBroadcastHandle</a>, <a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#setDirty-boolean-">setDirty</a>, <a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#setEmptyStatus--">setEmptyStatus</a>, <a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#setFedMapping-java.util.Map-">setFedMapping</a>, <a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#setFileFormatProperties-org.apache.sysds.runtime.io.FileFormatProperties-">setFileFormatProperties</a>, <a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#setFileName-java.lang.String-">setFileName</a>, <a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#setGPUObject-org.apache.sysds.runtime.instructions.gpu.context.GPUContext-org.apache.sysds.runtime.instructions.gpu.context.GPUObject-">setGPUObject</a>, <a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#setHDFSFileExists-boolean-">setHDFSFileExists</a>, <a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#setMetaData-org.apache.sysds.runtime.meta.MetaData-">setMetaData</a>, <a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#setPrivacyConstraints-org.apache.sysds.runtime.privacy.PrivacyConstraint-">setPrivacyConstraints</a>, <a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#setRDDHandle-org.apache.sysds.runtime.instructions.spark.data.RDDObject-">setRDDHandle</a>, <a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#toString--">toString</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.sysds.runtime.instructions.cp.Data">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.sysds.runtime.instructions.cp.<a href="../../../../../../org/apache/sysds/runtime/instructions/cp/Data.html" title="class in org.apache.sysds.runtime.instructions.cp">Data</a></h3>
<code><a href="../../../../../../org/apache/sysds/runtime/instructions/cp/Data.html#getDataType--">getDataType</a>, <a href="../../../../../../org/apache/sysds/runtime/instructions/cp/Data.html#getValueType--">getValueType</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="MatrixObject-org.apache.sysds.common.Types.ValueType-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>MatrixObject</h4>
<pre>public&nbsp;MatrixObject(<a href="../../../../../../org/apache/sysds/common/Types.ValueType.html" title="enum in org.apache.sysds.common">Types.ValueType</a>&nbsp;vt,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;file)</pre>
<div class="block">Constructor that takes the value type and the HDFS filename.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>vt</code> - value type</dd>
<dd><code>file</code> - file name</dd>
</dl>
</li>
</ul>
<a name="MatrixObject-org.apache.sysds.common.Types.ValueType-java.lang.String-org.apache.sysds.runtime.meta.MetaData-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>MatrixObject</h4>
<pre>public&nbsp;MatrixObject(<a href="../../../../../../org/apache/sysds/common/Types.ValueType.html" title="enum in org.apache.sysds.common">Types.ValueType</a>&nbsp;vt,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;file,
<a href="../../../../../../org/apache/sysds/runtime/meta/MetaData.html" title="class in org.apache.sysds.runtime.meta">MetaData</a>&nbsp;mtd)</pre>
<div class="block">Constructor that takes the value type, HDFS filename and associated metadata.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>vt</code> - value type</dd>
<dd><code>file</code> - file name</dd>
<dd><code>mtd</code> - metadata</dd>
</dl>
</li>
</ul>
<a name="MatrixObject-org.apache.sysds.runtime.controlprogram.caching.MatrixObject-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>MatrixObject</h4>
<pre>public&nbsp;MatrixObject(<a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/MatrixObject.html" title="class in org.apache.sysds.runtime.controlprogram.caching">MatrixObject</a>&nbsp;mo)</pre>
<div class="block">Copy constructor that copies meta data but NO data.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>mo</code> - matrix object</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="setUpdateType-org.apache.sysds.runtime.controlprogram.caching.MatrixObject.UpdateType-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setUpdateType</h4>
<pre>public&nbsp;void&nbsp;setUpdateType(<a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/MatrixObject.UpdateType.html" title="enum in org.apache.sysds.runtime.controlprogram.caching">MatrixObject.UpdateType</a>&nbsp;flag)</pre>
</li>
</ul>
<a name="getUpdateType--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUpdateType</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/MatrixObject.UpdateType.html" title="enum in org.apache.sysds.runtime.controlprogram.caching">MatrixObject.UpdateType</a>&nbsp;getUpdateType()</pre>
</li>
</ul>
<a name="isDiag--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isDiag</h4>
<pre>public&nbsp;boolean&nbsp;isDiag()</pre>
</li>
</ul>
<a name="setDiag-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDiag</h4>
<pre>public&nbsp;void&nbsp;setDiag(boolean&nbsp;diag)</pre>
</li>
</ul>
<a name="setMarkForLinCache-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMarkForLinCache</h4>
<pre>public&nbsp;void&nbsp;setMarkForLinCache(boolean&nbsp;mark)</pre>
</li>
</ul>
<a name="isMarked--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isMarked</h4>
<pre>public&nbsp;boolean&nbsp;isMarked()</pre>
</li>
</ul>
<a name="updateDataCharacteristics-org.apache.sysds.runtime.meta.DataCharacteristics-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>updateDataCharacteristics</h4>
<pre>public&nbsp;void&nbsp;updateDataCharacteristics(<a href="../../../../../../org/apache/sysds/runtime/meta/DataCharacteristics.html" title="class in org.apache.sysds.runtime.meta">DataCharacteristics</a>&nbsp;dc)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../../org/apache/sysds/runtime/instructions/cp/Data.html#updateDataCharacteristics-org.apache.sysds.runtime.meta.DataCharacteristics-">updateDataCharacteristics</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org/apache/sysds/runtime/instructions/cp/Data.html" title="class in org.apache.sysds.runtime.instructions.cp">Data</a></code></dd>
</dl>
</li>
</ul>
<a name="refreshMetaData--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>refreshMetaData</h4>
<pre>public&nbsp;void&nbsp;refreshMetaData()</pre>
<div class="block">Make the matrix metadata consistent with the in-memory matrix data</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#refreshMetaData--">refreshMetaData</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html" title="class in org.apache.sysds.runtime.controlprogram.caching">CacheableData</a>&lt;<a href="../../../../../../org/apache/sysds/runtime/matrix/data/MatrixBlock.html" title="class in org.apache.sysds.runtime.matrix.data">MatrixBlock</a>&gt;</code></dd>
</dl>
</li>
</ul>
<a name="getBlocksize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBlocksize</h4>
<pre>public&nbsp;long&nbsp;getBlocksize()</pre>
</li>
</ul>
<a name="getNnz--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNnz</h4>
<pre>public&nbsp;long&nbsp;getNnz()</pre>
</li>
</ul>
<a name="getSparsity--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSparsity</h4>
<pre>public&nbsp;double&nbsp;getSparsity()</pre>
</li>
</ul>
<a name="setPartitioned-org.apache.sysds.runtime.controlprogram.ParForProgramBlock.PDataPartitionFormat-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPartitioned</h4>
<pre>public&nbsp;void&nbsp;setPartitioned(<a href="../../../../../../org/apache/sysds/runtime/controlprogram/ParForProgramBlock.PDataPartitionFormat.html" title="enum in org.apache.sysds.runtime.controlprogram">ParForProgramBlock.PDataPartitionFormat</a>&nbsp;format,
int&nbsp;n)</pre>
</li>
</ul>
<a name="unsetPartitioned--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>unsetPartitioned</h4>
<pre>public&nbsp;void&nbsp;unsetPartitioned()</pre>
</li>
</ul>
<a name="isPartitioned--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isPartitioned</h4>
<pre>public&nbsp;boolean&nbsp;isPartitioned()</pre>
</li>
</ul>
<a name="getPartitionFormat--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPartitionFormat</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/sysds/runtime/controlprogram/ParForProgramBlock.PDataPartitionFormat.html" title="enum in org.apache.sysds.runtime.controlprogram">ParForProgramBlock.PDataPartitionFormat</a>&nbsp;getPartitionFormat()</pre>
</li>
</ul>
<a name="getPartitionSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPartitionSize</h4>
<pre>public&nbsp;int&nbsp;getPartitionSize()</pre>
</li>
</ul>
<a name="setInMemoryPartition-org.apache.sysds.runtime.matrix.data.MatrixBlock-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setInMemoryPartition</h4>
<pre>public&nbsp;void&nbsp;setInMemoryPartition(<a href="../../../../../../org/apache/sysds/runtime/matrix/data/MatrixBlock.html" title="class in org.apache.sysds.runtime.matrix.data">MatrixBlock</a>&nbsp;block)</pre>
</li>
</ul>
<a name="readMatrixPartition-org.apache.sysds.runtime.util.IndexRange-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readMatrixPartition</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/sysds/runtime/matrix/data/MatrixBlock.html" title="class in org.apache.sysds.runtime.matrix.data">MatrixBlock</a>&nbsp;readMatrixPartition(<a href="../../../../../../org/apache/sysds/runtime/util/IndexRange.html" title="class in org.apache.sysds.runtime.util">IndexRange</a>&nbsp;pred)</pre>
<div class="block">NOTE: for reading matrix partitions, we could cache (in its real sense) the read block
with soft references (no need for eviction, as partitioning only applied for read-only matrices).
However, since we currently only support row- and column-wise partitioning caching is not applied yet.
This could be changed once we also support column-block-wise and row-block-wise. Furthermore,
as we reject to partition vectors and support only full row or column indexing, no metadata (apart from
the partition flag) is required.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>pred</code> - index range</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>matrix block</dd>
</dl>
</li>
</ul>
<a name="getPartitionFileName-org.apache.sysds.runtime.util.IndexRange-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPartitionFileName</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getPartitionFileName(<a href="../../../../../../org/apache/sysds/runtime/util/IndexRange.html" title="class in org.apache.sysds.runtime.util">IndexRange</a>&nbsp;pred,
int&nbsp;blen)</pre>
</li>
</ul>
<a name="acquireRead--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>acquireRead</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/sysds/runtime/matrix/data/MatrixBlock.html" title="class in org.apache.sysds.runtime.matrix.data">MatrixBlock</a>&nbsp;acquireRead()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#acquireRead--">CacheableData</a></code></span></div>
<div class="block">Acquires a shared "read-only" lock, produces the reference to the cache block,
restores the cache block to main memory, reads from HDFS if needed.
Synchronized because there might be parallel threads (parfor local) that
access the same object (in case it was created before the loop).
In-Status: EMPTY, EVICTABLE, EVICTED, READ;
Out-Status: READ(+1).</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#acquireRead--">acquireRead</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html" title="class in org.apache.sysds.runtime.controlprogram.caching">CacheableData</a>&lt;<a href="../../../../../../org/apache/sysds/runtime/matrix/data/MatrixBlock.html" title="class in org.apache.sysds.runtime.matrix.data">MatrixBlock</a>&gt;</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>cacheable data</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/MatrixObject.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">
<li><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/LazyWriteBuffer.RPolicy.html" title="enum in org.apache.sysds.runtime.controlprogram.caching"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/MatrixObject.UpdateType.html" title="enum in org.apache.sysds.runtime.controlprogram.caching"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/sysds/runtime/controlprogram/caching/MatrixObject.html" target="_top">Frames</a></li>
<li><a href="MatrixObject.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.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>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#fields.inherited.from.class.org.apache.sysds.runtime.controlprogram.caching.CacheableData">Field</a>&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 name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>