| <!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>CacheableData (SystemDS 2.1.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="CacheableData (SystemDS 2.1.0-SNAPSHOT API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":9,"i4":9,"i5":9,"i6":10,"i7":10,"i8":9,"i9":9,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":9,"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":9,"i36":9,"i37":9,"i38":10,"i39":9,"i40":10,"i41":10,"i42":10,"i43":10,"i44":10,"i45":10,"i46":6,"i47":10,"i48":10,"i49":10,"i50":10,"i51":10,"i52":10,"i53":10,"i54":10,"i55":10,"i56":10,"i57":10,"i58":10,"i59":10,"i60":10,"i61":10}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/CacheableData.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/ByteBuffer.html" title="class in org.apache.sysds.runtime.controlprogram.caching"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.CacheStatus.html" title="enum in org.apache.sysds.runtime.controlprogram.caching"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/sysds/runtime/controlprogram/caching/CacheableData.html" target="_top">Frames</a></li> |
| <li><a href="CacheableData.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../allclasses-noframe.html">All 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: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li>Constr | </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 CacheableData" class="title">Class CacheableData<T extends <a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheBlock.html" title="interface in org.apache.sysds.runtime.controlprogram.caching">CacheBlock</a>></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>org.apache.sysds.runtime.controlprogram.caching.CacheableData<T></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> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/FrameObject.html" title="class in org.apache.sysds.runtime.controlprogram.caching">FrameObject</a>, <a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/MatrixObject.html" title="class in org.apache.sysds.runtime.controlprogram.caching">MatrixObject</a>, <a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/TensorObject.html" title="class in org.apache.sysds.runtime.controlprogram.caching">TensorObject</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public abstract class <span class="typeNameLabel">CacheableData<T extends <a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheBlock.html" title="interface in org.apache.sysds.runtime.controlprogram.caching">CacheBlock</a>></span> |
| extends <a href="../../../../../../org/apache/sysds/runtime/instructions/cp/Data.html" title="class in org.apache.sysds.runtime.instructions.cp">Data</a></pre> |
| <div class="block">Each object of this class is a cache envelope for some large piece of data |
| called "cache block". For example, the body of a matrix can be the cache block. |
| The term cache block refers strictly to the cacheable portion of the data object, |
| often excluding metadata and auxiliary parameters, as defined in the subclasses. |
| Under the protection of the envelope, the data blob may be evicted to |
| the file system; then the subclass must set its reference to <code>null</code> |
| to allow Java garbage collection. If other parts of the system continue |
| keep references to the cache block, its eviction will not release any memory.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../serialized-form.html#org.apache.sysds.runtime.controlprogram.caching.CacheableData">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"> </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 </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.CacheStatus.html" title="enum in org.apache.sysds.runtime.controlprogram.caching">CacheableData.CacheStatus</a></span></code> |
| <div class="block">Defines all possible cache status types for a data blob.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <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/CacheableData.html#cacheEvictionLocalFilePath">cacheEvictionLocalFilePath</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <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/CacheableData.html#cacheEvictionLocalFilePrefix">cacheEvictionLocalFilePrefix</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#CACHING_ASYNC_FILECLEANUP">CACHING_ASYNC_FILECLEANUP</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#CACHING_ASYNC_SERIALIZE">CACHING_ASYNC_SERIALIZE</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#CACHING_BUFFER_PAGECACHE">CACHING_BUFFER_PAGECACHE</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/LazyWriteBuffer.RPolicy.html" title="enum in org.apache.sysds.runtime.controlprogram.caching">LazyWriteBuffer.RPolicy</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#CACHING_BUFFER_POLICY">CACHING_BUFFER_POLICY</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static double</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#CACHING_BUFFER_SIZE">CACHING_BUFFER_SIZE</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <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/CacheableData.html#CACHING_COUNTER_GROUP_NAME">CACHING_COUNTER_GROUP_NAME</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <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/CacheableData.html#CACHING_EVICTION_FILEEXTENSION">CACHING_EVICTION_FILEEXTENSION</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#CACHING_THRESHOLD">CACHING_THRESHOLD</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#CACHING_WRITE_CACHE_ON_READ">CACHING_WRITE_CACHE_ON_READ</a></span></code> </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"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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/controlprogram/caching/CacheableData.html" title="type parameter in CacheableData">T</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#acquireModify-T-">acquireModify</a></span>(<a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html" title="type parameter in CacheableData">T</a> newData)</code> |
| <div class="block">Acquires the exclusive "write" lock for a thread that wants to throw away the |
| old cache block data and link up with new cache block data.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html" title="type parameter in CacheableData">T</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.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="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html" title="type parameter in CacheableData">T</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#acquireReadAndRelease--">acquireReadAndRelease</a></span>()</code> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#addBroadcastSize-long-">addBroadcastSize</a></span>(long size)</code> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#cleanupCacheDir--">cleanupCacheDir</a></span>()</code> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#cleanupCacheDir-boolean-">cleanupCacheDir</a></span>(boolean withDir)</code> |
| <div class="block">Deletes the DML-script-specific caching working dir.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#clearData--">clearData</a></span>()</code> </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#clearData-long-">clearData</a></span>(long tid)</code> |
| <div class="block">Sets the cache block reference to <code>null</code>, abandons the old block.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#disableCaching--">disableCaching</a></span>()</code> </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#enableCaching--">enableCaching</a></span>()</code> </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#enableCleanup-boolean-">enableCleanup</a></span>(boolean flag)</code> |
| <div class="block">Enables or disables the cleanup of the associated |
| data object on clearData().</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#exportData--">exportData</a></span>()</code> </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/CacheableData.html#exportData-int-">exportData</a></span>(int replication)</code> |
| <div class="block">Writes, or flushes, the cache block data to HDFS.</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/CacheableData.html#exportData-java.lang.String-java.lang.String-">exportData</a></span>(<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> fName, |
| <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> outputFormat)</code> </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/CacheableData.html#exportData-java.lang.String-java.lang.String-org.apache.sysds.runtime.io.FileFormatProperties-">exportData</a></span>(<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> fName, |
| <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> outputFormat, |
| <a href="../../../../../../org/apache/sysds/runtime/io/FileFormatProperties.html" title="class in org.apache.sysds.runtime.io">FileFormatProperties</a> formatProperties)</code> </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/CacheableData.html#exportData-java.lang.String-java.lang.String-int-org.apache.sysds.runtime.io.FileFormatProperties-">exportData</a></span>(<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> fName, |
| <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> outputFormat, |
| int replication, |
| <a href="../../../../../../org/apache/sysds/runtime/io/FileFormatProperties.html" title="class in org.apache.sysds.runtime.io">FileFormatProperties</a> formatProperties)</code> </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/CacheableData.html#exportData-java.lang.String-java.lang.String-int-org.apache.sysds.runtime.io.FileFormatProperties-java.lang.String-">exportData</a></span>(<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> fName, |
| <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> outputFormat, |
| int replication, |
| <a href="../../../../../../org/apache/sysds/runtime/io/FileFormatProperties.html" title="class in org.apache.sysds.runtime.io">FileFormatProperties</a> formatProperties, |
| <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> opcode)</code> |
| <div class="block">Synchronized because there might be parallel threads (parfor local) that |
| access the same object (in case it was created before the loop).</div> |
| </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/CacheableData.html#freeEvictedBlob--">freeEvictedBlob</a></span>()</code> |
| <div class="block">Low-level cache I/O method that deletes the file containing the |
| evicted data blob, without reading it.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/sysds/runtime/instructions/spark/data/BroadcastObject.html" title="class in org.apache.sysds.runtime.instructions.spark.data">BroadcastObject</a><<a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html" title="type parameter in CacheableData">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#getBroadcastHandle--">getBroadcastHandle</a></span>()</code> </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>static long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#getBroadcastSize--">getBroadcastSize</a></span>()</code> </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/sysds/runtime/lineage/LineageItem.html" title="class in org.apache.sysds.runtime.lineage">LineageItem</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#getCacheLineage--">getCacheLineage</a></span>()</code> </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/sysds/runtime/meta/DataCharacteristics.html" title="class in org.apache.sysds.runtime.meta">DataCharacteristics</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#getDataCharacteristics--">getDataCharacteristics</a></span>()</code> </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#getDataSize--">getDataSize</a></span>()</code> </td> |
| </tr> |
| <tr id="i23" 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/CacheableData.html#getDebugName--">getDebugName</a></span>()</code> </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/sysds/runtime/controlprogram/federated/FederationMap.html" title="class in org.apache.sysds.runtime.controlprogram.federated">FederationMap</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#getFedMapping--">getFedMapping</a></span>()</code> |
| <div class="block">Gets the mapping of indices ranges to federated objects.</div> |
| </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/sysds/runtime/io/FileFormatProperties.html" title="class in org.apache.sysds.runtime.io">FileFormatProperties</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#getFileFormatProperties--">getFileFormatProperties</a></span>()</code> </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <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/CacheableData.html#getFileName--">getFileName</a></span>()</code> </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/sysds/runtime/instructions/gpu/context/GPUObject.html" title="class in org.apache.sysds.runtime.instructions.gpu.context">GPUObject</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#getGPUObject-org.apache.sysds.runtime.instructions.gpu.context.GPUContext-">getGPUObject</a></span>(<a href="../../../../../../org/apache/sysds/runtime/instructions/gpu/context/GPUContext.html" title="class in org.apache.sysds.runtime.instructions.gpu.context">GPUContext</a> gCtx)</code> </td> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/sysds/runtime/meta/MetaData.html" title="class in org.apache.sysds.runtime.meta">MetaData</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#getMetaData--">getMetaData</a></span>()</code> </td> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#getNumColumns--">getNumColumns</a></span>()</code> </td> |
| </tr> |
| <tr id="i30" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#getNumRows--">getNumRows</a></span>()</code> </td> |
| </tr> |
| <tr id="i31" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/sysds/runtime/instructions/spark/data/RDDObject.html" title="class in org.apache.sysds.runtime.instructions.spark.data">RDDObject</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#getRDDHandle--">getRDDHandle</a></span>()</code> </td> |
| </tr> |
| <tr id="i32" class="altColor"> |
| <td class="colFirst"><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></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#getStatus--">getStatus</a></span>()</code> </td> |
| </tr> |
| <tr id="i33" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#getUniqueID--">getUniqueID</a></span>()</code> </td> |
| </tr> |
| <tr id="i34" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#hasValidLineage--">hasValidLineage</a></span>()</code> </td> |
| </tr> |
| <tr id="i35" class="rowColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#initCaching--">initCaching</a></span>()</code> |
| <div class="block">Inits caching with the default uuid of DMLScript</div> |
| </td> |
| </tr> |
| <tr id="i36" class="altColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#initCaching-java.lang.String-">initCaching</a></span>(<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> uuid)</code> |
| <div class="block">Creates the DML-script-specific caching working dir.</div> |
| </td> |
| </tr> |
| <tr id="i37" class="rowColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#isBelowCachingThreshold-org.apache.sysds.runtime.controlprogram.caching.CacheBlock-">isBelowCachingThreshold</a></span>(<a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheBlock.html" title="interface in org.apache.sysds.runtime.controlprogram.caching">CacheBlock</a> data)</code> </td> |
| </tr> |
| <tr id="i38" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#isCached-boolean-">isCached</a></span>(boolean inclCachedNoWrite)</code> </td> |
| </tr> |
| <tr id="i39" class="rowColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#isCachingActive--">isCachingActive</a></span>()</code> </td> |
| </tr> |
| <tr id="i40" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#isCleanupEnabled--">isCleanupEnabled</a></span>()</code> |
| <div class="block">Indicates if cleanup of the associated data object |
| is enabled on clearData().</div> |
| </td> |
| </tr> |
| <tr id="i41" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#isDirty--">isDirty</a></span>()</code> |
| <div class="block"><code>true</code> if the in-memory or evicted matrix may be different from |
| the matrix located at <a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#Z:Z_hdfsFileName"><code>_hdfsFileName</code></a>; <code>false</code> if the two |
| matrices are supposed to be the same.</div> |
| </td> |
| </tr> |
| <tr id="i42" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#isFederated--">isFederated</a></span>()</code> |
| <div class="block">Check if object is federated.</div> |
| </td> |
| </tr> |
| <tr id="i43" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#isFederated-org.apache.sysds.runtime.controlprogram.federated.FederationMap.FType-">isFederated</a></span>(<a href="../../../../../../org/apache/sysds/runtime/controlprogram/federated/FederationMap.FType.html" title="enum in org.apache.sysds.runtime.controlprogram.federated">FederationMap.FType</a> type)</code> </td> |
| </tr> |
| <tr id="i44" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#isHDFSFileExists--">isHDFSFileExists</a></span>()</code> </td> |
| </tr> |
| <tr id="i45" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#moveData-java.lang.String-java.lang.String-">moveData</a></span>(<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> fName, |
| <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> outputFormat)</code> </td> |
| </tr> |
| <tr id="i46" class="altColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#refreshMetaData--">refreshMetaData</a></span>()</code> </td> |
| </tr> |
| <tr id="i47" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#release--">release</a></span>()</code> |
| <div class="block">Releases the shared ("read-only") or exclusive ("write") lock.</div> |
| </td> |
| </tr> |
| <tr id="i48" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#removeGPUObject-org.apache.sysds.runtime.instructions.gpu.context.GPUContext-">removeGPUObject</a></span>(<a href="../../../../../../org/apache/sysds/runtime/instructions/gpu/context/GPUContext.html" title="class in org.apache.sysds.runtime.instructions.gpu.context">GPUContext</a> gCtx)</code> </td> |
| </tr> |
| <tr id="i49" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#removeMetaData--">removeMetaData</a></span>()</code> </td> |
| </tr> |
| <tr id="i50" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#setBroadcastHandle-org.apache.sysds.runtime.instructions.spark.data.BroadcastObject-">setBroadcastHandle</a></span>(<a href="../../../../../../org/apache/sysds/runtime/instructions/spark/data/BroadcastObject.html" title="class in org.apache.sysds.runtime.instructions.spark.data">BroadcastObject</a> bc)</code> </td> |
| </tr> |
| <tr id="i51" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#setCacheLineage-org.apache.sysds.runtime.lineage.LineageItem-">setCacheLineage</a></span>(<a href="../../../../../../org/apache/sysds/runtime/lineage/LineageItem.html" title="class in org.apache.sysds.runtime.lineage">LineageItem</a> li)</code> </td> |
| </tr> |
| <tr id="i52" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#setDirty-boolean-">setDirty</a></span>(boolean flag)</code> </td> |
| </tr> |
| <tr id="i53" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#setEmptyStatus--">setEmptyStatus</a></span>()</code> </td> |
| </tr> |
| <tr id="i54" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#setFedMapping-org.apache.sysds.runtime.controlprogram.federated.FederationMap-">setFedMapping</a></span>(<a href="../../../../../../org/apache/sysds/runtime/controlprogram/federated/FederationMap.html" title="class in org.apache.sysds.runtime.controlprogram.federated">FederationMap</a> fedMapping)</code> |
| <div class="block">Sets the mapping of indices ranges to federated objects.</div> |
| </td> |
| </tr> |
| <tr id="i55" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#setFileFormatProperties-org.apache.sysds.runtime.io.FileFormatProperties-">setFileFormatProperties</a></span>(<a href="../../../../../../org/apache/sysds/runtime/io/FileFormatProperties.html" title="class in org.apache.sysds.runtime.io">FileFormatProperties</a> props)</code> </td> |
| </tr> |
| <tr id="i56" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#setFileName-java.lang.String-">setFileName</a></span>(<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> file)</code> </td> |
| </tr> |
| <tr id="i57" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><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></span>(<a href="../../../../../../org/apache/sysds/runtime/instructions/gpu/context/GPUContext.html" title="class in org.apache.sysds.runtime.instructions.gpu.context">GPUContext</a> gCtx, |
| <a href="../../../../../../org/apache/sysds/runtime/instructions/gpu/context/GPUObject.html" title="class in org.apache.sysds.runtime.instructions.gpu.context">GPUObject</a> gObj)</code> </td> |
| </tr> |
| <tr id="i58" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#setHDFSFileExists-boolean-">setHDFSFileExists</a></span>(boolean flag)</code> </td> |
| </tr> |
| <tr id="i59" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#setMetaData-org.apache.sysds.runtime.meta.MetaData-">setMetaData</a></span>(<a href="../../../../../../org/apache/sysds/runtime/meta/MetaData.html" title="class in org.apache.sysds.runtime.meta">MetaData</a> md)</code> </td> |
| </tr> |
| <tr id="i60" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#setRDDHandle-org.apache.sysds.runtime.instructions.spark.data.RDDObject-">setRDDHandle</a></span>(<a href="../../../../../../org/apache/sysds/runtime/instructions/spark/data/RDDObject.html" title="class in org.apache.sysds.runtime.instructions.spark.data">RDDObject</a> rdd)</code> </td> |
| </tr> |
| <tr id="i61" 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/CacheableData.html#toString--">toString</a></span>()</code> </td> |
| </tr> |
| </table> |
| <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 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#getPrivacyConstraint--">getPrivacyConstraint</a>, <a href="../../../../../../org/apache/sysds/runtime/instructions/cp/Data.html#getValueType--">getValueType</a>, <a href="../../../../../../org/apache/sysds/runtime/instructions/cp/Data.html#setPrivacyConstraints-org.apache.sysds.runtime.privacy.PrivacyConstraint-">setPrivacyConstraints</a>, <a href="../../../../../../org/apache/sysds/runtime/instructions/cp/Data.html#updateDataCharacteristics-org.apache.sysds.runtime.meta.DataCharacteristics-">updateDataCharacteristics</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 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"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="CACHING_THRESHOLD"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>CACHING_THRESHOLD</h4> |
| <pre>public static final long CACHING_THRESHOLD</pre> |
| </li> |
| </ul> |
| <a name="CACHING_BUFFER_SIZE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>CACHING_BUFFER_SIZE</h4> |
| <pre>public static final double CACHING_BUFFER_SIZE</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../constant-values.html#org.apache.sysds.runtime.controlprogram.caching.CacheableData.CACHING_BUFFER_SIZE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="CACHING_BUFFER_POLICY"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>CACHING_BUFFER_POLICY</h4> |
| <pre>public static final <a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/LazyWriteBuffer.RPolicy.html" title="enum in org.apache.sysds.runtime.controlprogram.caching">LazyWriteBuffer.RPolicy</a> CACHING_BUFFER_POLICY</pre> |
| </li> |
| </ul> |
| <a name="CACHING_BUFFER_PAGECACHE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>CACHING_BUFFER_PAGECACHE</h4> |
| <pre>public static final boolean CACHING_BUFFER_PAGECACHE</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../constant-values.html#org.apache.sysds.runtime.controlprogram.caching.CacheableData.CACHING_BUFFER_PAGECACHE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="CACHING_WRITE_CACHE_ON_READ"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>CACHING_WRITE_CACHE_ON_READ</h4> |
| <pre>public static final boolean CACHING_WRITE_CACHE_ON_READ</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../constant-values.html#org.apache.sysds.runtime.controlprogram.caching.CacheableData.CACHING_WRITE_CACHE_ON_READ">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="CACHING_COUNTER_GROUP_NAME"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>CACHING_COUNTER_GROUP_NAME</h4> |
| <pre>public static final <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> CACHING_COUNTER_GROUP_NAME</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../constant-values.html#org.apache.sysds.runtime.controlprogram.caching.CacheableData.CACHING_COUNTER_GROUP_NAME">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="CACHING_EVICTION_FILEEXTENSION"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>CACHING_EVICTION_FILEEXTENSION</h4> |
| <pre>public static final <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> CACHING_EVICTION_FILEEXTENSION</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../constant-values.html#org.apache.sysds.runtime.controlprogram.caching.CacheableData.CACHING_EVICTION_FILEEXTENSION">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="CACHING_ASYNC_FILECLEANUP"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>CACHING_ASYNC_FILECLEANUP</h4> |
| <pre>public static final boolean CACHING_ASYNC_FILECLEANUP</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../constant-values.html#org.apache.sysds.runtime.controlprogram.caching.CacheableData.CACHING_ASYNC_FILECLEANUP">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="CACHING_ASYNC_SERIALIZE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>CACHING_ASYNC_SERIALIZE</h4> |
| <pre>public static final boolean CACHING_ASYNC_SERIALIZE</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../constant-values.html#org.apache.sysds.runtime.controlprogram.caching.CacheableData.CACHING_ASYNC_SERIALIZE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="cacheEvictionLocalFilePath"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>cacheEvictionLocalFilePath</h4> |
| <pre>public static <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> cacheEvictionLocalFilePath</pre> |
| </li> |
| </ul> |
| <a name="cacheEvictionLocalFilePrefix"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>cacheEvictionLocalFilePrefix</h4> |
| <pre>public static <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> cacheEvictionLocalFilePrefix</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="enableCleanup-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>enableCleanup</h4> |
| <pre>public void enableCleanup(boolean flag)</pre> |
| <div class="block">Enables or disables the cleanup of the associated |
| data object on clearData().</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>flag</code> - true if cleanup</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isCleanupEnabled--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isCleanupEnabled</h4> |
| <pre>public boolean isCleanupEnabled()</pre> |
| <div class="block">Indicates if cleanup of the associated data object |
| is enabled on clearData().</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if cleanup enabled</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getStatus--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStatus</h4> |
| <pre>public <a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.CacheStatus.html" title="enum in org.apache.sysds.runtime.controlprogram.caching">CacheableData.CacheStatus</a> getStatus()</pre> |
| </li> |
| </ul> |
| <a name="isHDFSFileExists--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isHDFSFileExists</h4> |
| <pre>public boolean isHDFSFileExists()</pre> |
| </li> |
| </ul> |
| <a name="setHDFSFileExists-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setHDFSFileExists</h4> |
| <pre>public void setHDFSFileExists(boolean flag)</pre> |
| </li> |
| </ul> |
| <a name="getFileName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFileName</h4> |
| <pre>public <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> getFileName()</pre> |
| </li> |
| </ul> |
| <a name="getUniqueID--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getUniqueID</h4> |
| <pre>public long getUniqueID()</pre> |
| </li> |
| </ul> |
| <a name="setFileName-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setFileName</h4> |
| <pre>public void setFileName(<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> file)</pre> |
| </li> |
| </ul> |
| <a name="isDirty--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isDirty</h4> |
| <pre>public boolean isDirty()</pre> |
| <div class="block"><code>true</code> if the in-memory or evicted matrix may be different from |
| the matrix located at <a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html#Z:Z_hdfsFileName"><code>_hdfsFileName</code></a>; <code>false</code> if the two |
| matrices are supposed to be the same.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if dirty</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setDirty-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDirty</h4> |
| <pre>public void setDirty(boolean flag)</pre> |
| </li> |
| </ul> |
| <a name="getFileFormatProperties--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFileFormatProperties</h4> |
| <pre>public <a href="../../../../../../org/apache/sysds/runtime/io/FileFormatProperties.html" title="class in org.apache.sysds.runtime.io">FileFormatProperties</a> getFileFormatProperties()</pre> |
| </li> |
| </ul> |
| <a name="setFileFormatProperties-org.apache.sysds.runtime.io.FileFormatProperties-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setFileFormatProperties</h4> |
| <pre>public void setFileFormatProperties(<a href="../../../../../../org/apache/sysds/runtime/io/FileFormatProperties.html" title="class in org.apache.sysds.runtime.io">FileFormatProperties</a> props)</pre> |
| </li> |
| </ul> |
| <a name="setMetaData-org.apache.sysds.runtime.meta.MetaData-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMetaData</h4> |
| <pre>public void setMetaData(<a href="../../../../../../org/apache/sysds/runtime/meta/MetaData.html" title="class in org.apache.sysds.runtime.meta">MetaData</a> md)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/sysds/runtime/instructions/cp/Data.html#setMetaData-org.apache.sysds.runtime.meta.MetaData-">setMetaData</a></code> in class <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="getMetaData--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMetaData</h4> |
| <pre>public <a href="../../../../../../org/apache/sysds/runtime/meta/MetaData.html" title="class in org.apache.sysds.runtime.meta">MetaData</a> getMetaData()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/sysds/runtime/instructions/cp/Data.html#getMetaData--">getMetaData</a></code> in class <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="removeMetaData--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeMetaData</h4> |
| <pre>public void removeMetaData()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/sysds/runtime/instructions/cp/Data.html#removeMetaData--">removeMetaData</a></code> in class <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="getDataCharacteristics--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDataCharacteristics</h4> |
| <pre>public <a href="../../../../../../org/apache/sysds/runtime/meta/DataCharacteristics.html" title="class in org.apache.sysds.runtime.meta">DataCharacteristics</a> getDataCharacteristics()</pre> |
| </li> |
| </ul> |
| <a name="getNumRows--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getNumRows</h4> |
| <pre>public long getNumRows()</pre> |
| </li> |
| </ul> |
| <a name="getNumColumns--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getNumColumns</h4> |
| <pre>public long getNumColumns()</pre> |
| </li> |
| </ul> |
| <a name="refreshMetaData--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>refreshMetaData</h4> |
| <pre>public abstract void refreshMetaData()</pre> |
| </li> |
| </ul> |
| <a name="getCacheLineage--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCacheLineage</h4> |
| <pre>public <a href="../../../../../../org/apache/sysds/runtime/lineage/LineageItem.html" title="class in org.apache.sysds.runtime.lineage">LineageItem</a> getCacheLineage()</pre> |
| </li> |
| </ul> |
| <a name="setCacheLineage-org.apache.sysds.runtime.lineage.LineageItem-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCacheLineage</h4> |
| <pre>public void setCacheLineage(<a href="../../../../../../org/apache/sysds/runtime/lineage/LineageItem.html" title="class in org.apache.sysds.runtime.lineage">LineageItem</a> li)</pre> |
| </li> |
| </ul> |
| <a name="hasValidLineage--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasValidLineage</h4> |
| <pre>public boolean hasValidLineage()</pre> |
| </li> |
| </ul> |
| <a name="isFederated--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isFederated</h4> |
| <pre>public boolean isFederated()</pre> |
| <div class="block">Check if object is federated.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if federated else false</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isFederated-org.apache.sysds.runtime.controlprogram.federated.FederationMap.FType-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isFederated</h4> |
| <pre>public boolean isFederated(<a href="../../../../../../org/apache/sysds/runtime/controlprogram/federated/FederationMap.FType.html" title="enum in org.apache.sysds.runtime.controlprogram.federated">FederationMap.FType</a> type)</pre> |
| </li> |
| </ul> |
| <a name="getFedMapping--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFedMapping</h4> |
| <pre>public <a href="../../../../../../org/apache/sysds/runtime/controlprogram/federated/FederationMap.html" title="class in org.apache.sysds.runtime.controlprogram.federated">FederationMap</a> getFedMapping()</pre> |
| <div class="block">Gets the mapping of indices ranges to federated objects.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>fedMapping mapping</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setFedMapping-org.apache.sysds.runtime.controlprogram.federated.FederationMap-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setFedMapping</h4> |
| <pre>public void setFedMapping(<a href="../../../../../../org/apache/sysds/runtime/controlprogram/federated/FederationMap.html" title="class in org.apache.sysds.runtime.controlprogram.federated">FederationMap</a> fedMapping)</pre> |
| <div class="block">Sets the mapping of indices ranges to federated objects.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fedMapping</code> - mapping</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getRDDHandle--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRDDHandle</h4> |
| <pre>public <a href="../../../../../../org/apache/sysds/runtime/instructions/spark/data/RDDObject.html" title="class in org.apache.sysds.runtime.instructions.spark.data">RDDObject</a> getRDDHandle()</pre> |
| </li> |
| </ul> |
| <a name="setRDDHandle-org.apache.sysds.runtime.instructions.spark.data.RDDObject-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setRDDHandle</h4> |
| <pre>public void setRDDHandle(<a href="../../../../../../org/apache/sysds/runtime/instructions/spark/data/RDDObject.html" title="class in org.apache.sysds.runtime.instructions.spark.data">RDDObject</a> rdd)</pre> |
| </li> |
| </ul> |
| <a name="getBroadcastHandle--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBroadcastHandle</h4> |
| <pre>public <a href="../../../../../../org/apache/sysds/runtime/instructions/spark/data/BroadcastObject.html" title="class in org.apache.sysds.runtime.instructions.spark.data">BroadcastObject</a><<a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html" title="type parameter in CacheableData">T</a>> getBroadcastHandle()</pre> |
| </li> |
| </ul> |
| <a name="setBroadcastHandle-org.apache.sysds.runtime.instructions.spark.data.BroadcastObject-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setBroadcastHandle</h4> |
| <pre>public void setBroadcastHandle(<a href="../../../../../../org/apache/sysds/runtime/instructions/spark/data/BroadcastObject.html" title="class in org.apache.sysds.runtime.instructions.spark.data">BroadcastObject</a> bc)</pre> |
| </li> |
| </ul> |
| <a name="getGPUObject-org.apache.sysds.runtime.instructions.gpu.context.GPUContext-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getGPUObject</h4> |
| <pre>public <a href="../../../../../../org/apache/sysds/runtime/instructions/gpu/context/GPUObject.html" title="class in org.apache.sysds.runtime.instructions.gpu.context">GPUObject</a> getGPUObject(<a href="../../../../../../org/apache/sysds/runtime/instructions/gpu/context/GPUContext.html" title="class in org.apache.sysds.runtime.instructions.gpu.context">GPUContext</a> gCtx)</pre> |
| </li> |
| </ul> |
| <a name="setGPUObject-org.apache.sysds.runtime.instructions.gpu.context.GPUContext-org.apache.sysds.runtime.instructions.gpu.context.GPUObject-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setGPUObject</h4> |
| <pre>public void setGPUObject(<a href="../../../../../../org/apache/sysds/runtime/instructions/gpu/context/GPUContext.html" title="class in org.apache.sysds.runtime.instructions.gpu.context">GPUContext</a> gCtx, |
| <a href="../../../../../../org/apache/sysds/runtime/instructions/gpu/context/GPUObject.html" title="class in org.apache.sysds.runtime.instructions.gpu.context">GPUObject</a> gObj)</pre> |
| </li> |
| </ul> |
| <a name="removeGPUObject-org.apache.sysds.runtime.instructions.gpu.context.GPUContext-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeGPUObject</h4> |
| <pre>public void removeGPUObject(<a href="../../../../../../org/apache/sysds/runtime/instructions/gpu/context/GPUContext.html" title="class in org.apache.sysds.runtime.instructions.gpu.context">GPUContext</a> gCtx)</pre> |
| </li> |
| </ul> |
| <a name="acquireReadAndRelease--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>acquireReadAndRelease</h4> |
| <pre>public <a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html" title="type parameter in CacheableData">T</a> acquireReadAndRelease()</pre> |
| </li> |
| </ul> |
| <a name="acquireRead--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>acquireRead</h4> |
| <pre>public <a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html" title="type parameter in CacheableData">T</a> acquireRead()</pre> |
| <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="returnLabel">Returns:</span></dt> |
| <dd>cacheable data</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="acquireModify-org.apache.sysds.runtime.controlprogram.caching.CacheBlock-"> |
| <!-- --> |
| </a><a name="acquireModify-T-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>acquireModify</h4> |
| <pre>public <a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html" title="type parameter in CacheableData">T</a> acquireModify(<a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.html" title="type parameter in CacheableData">T</a> newData)</pre> |
| <div class="block">Acquires the exclusive "write" lock for a thread that wants to throw away the |
| old cache block data and link up with new cache block data. Abandons the old data |
| without reading it and sets the new data reference. |
| |
| In-Status: EMPTY, EVICTABLE, EVICTED; |
| Out-Status: MODIFY.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>newData</code> - new data</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>cacheable data</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="release--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>release</h4> |
| <pre>public void release()</pre> |
| <div class="block">Releases the shared ("read-only") or exclusive ("write") lock. Updates |
| size information, last-access time, metadata, etc. |
| |
| Synchronized because there might be parallel threads (parfor local) that |
| access the same object (in case it was created before the loop). |
| |
| In-Status: READ, MODIFY; |
| Out-Status: READ(-1), EVICTABLE, EMPTY.</div> |
| </li> |
| </ul> |
| <a name="clearData--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>clearData</h4> |
| <pre>public void clearData()</pre> |
| </li> |
| </ul> |
| <a name="clearData-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>clearData</h4> |
| <pre>public void clearData(long tid)</pre> |
| <div class="block">Sets the cache block reference to <code>null</code>, abandons the old block. |
| Makes the "envelope" empty. Run it to finalize the object (otherwise the |
| evicted cache block file may remain undeleted). |
| |
| In-Status: EMPTY, EVICTABLE, EVICTED; |
| Out-Status: EMPTY.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>tid</code> - thread ID</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="exportData--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>exportData</h4> |
| <pre>public void exportData()</pre> |
| </li> |
| </ul> |
| <a name="exportData-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>exportData</h4> |
| <pre>public void exportData(int replication)</pre> |
| <div class="block">Writes, or flushes, the cache block data to HDFS. |
| |
| In-Status: EMPTY, EVICTABLE, EVICTED, READ; |
| Out-Status: EMPTY, EVICTABLE, EVICTED, READ.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>replication</code> - ?</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="exportData-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>exportData</h4> |
| <pre>public void exportData(<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> fName, |
| <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> outputFormat)</pre> |
| </li> |
| </ul> |
| <a name="exportData-java.lang.String-java.lang.String-org.apache.sysds.runtime.io.FileFormatProperties-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>exportData</h4> |
| <pre>public void exportData(<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> fName, |
| <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> outputFormat, |
| <a href="../../../../../../org/apache/sysds/runtime/io/FileFormatProperties.html" title="class in org.apache.sysds.runtime.io">FileFormatProperties</a> formatProperties)</pre> |
| </li> |
| </ul> |
| <a name="exportData-java.lang.String-java.lang.String-int-org.apache.sysds.runtime.io.FileFormatProperties-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>exportData</h4> |
| <pre>public void exportData(<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> fName, |
| <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> outputFormat, |
| int replication, |
| <a href="../../../../../../org/apache/sysds/runtime/io/FileFormatProperties.html" title="class in org.apache.sysds.runtime.io">FileFormatProperties</a> formatProperties)</pre> |
| </li> |
| </ul> |
| <a name="exportData-java.lang.String-java.lang.String-int-org.apache.sysds.runtime.io.FileFormatProperties-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>exportData</h4> |
| <pre>public void exportData(<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> fName, |
| <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> outputFormat, |
| int replication, |
| <a href="../../../../../../org/apache/sysds/runtime/io/FileFormatProperties.html" title="class in org.apache.sysds.runtime.io">FileFormatProperties</a> formatProperties, |
| <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> opcode)</pre> |
| <div class="block">Synchronized because there might be parallel threads (parfor local) that |
| access the same object (in case it was created before the loop). |
| If all threads export the same data object concurrently it results in errors |
| because they all write to the same file. Efficiency for loops and parallel threads |
| is achieved by checking if the in-memory block is dirty. |
| |
| NOTE: MB: we do not use dfs copy from local (evicted) to HDFS because this would ignore |
| the output format and most importantly would bypass reblocking during write (which effects the |
| potential degree of parallelism). However, we copy files on HDFS if certain criteria are given.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fName</code> - file name</dd> |
| <dd><code>outputFormat</code> - format</dd> |
| <dd><code>replication</code> - ?</dd> |
| <dd><code>formatProperties</code> - file format properties</dd> |
| <dd><code>opcode</code> - instruction opcode if available</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="freeEvictedBlob--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>freeEvictedBlob</h4> |
| <pre>public final void freeEvictedBlob()</pre> |
| <div class="block">Low-level cache I/O method that deletes the file containing the |
| evicted data blob, without reading it. |
| Must be defined by a subclass, never called by users.</div> |
| </li> |
| </ul> |
| <a name="isBelowCachingThreshold-org.apache.sysds.runtime.controlprogram.caching.CacheBlock-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isBelowCachingThreshold</h4> |
| <pre>public static boolean isBelowCachingThreshold(<a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheBlock.html" title="interface in org.apache.sysds.runtime.controlprogram.caching">CacheBlock</a> data)</pre> |
| </li> |
| </ul> |
| <a name="getDataSize--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDataSize</h4> |
| <pre>public long getDataSize()</pre> |
| </li> |
| </ul> |
| <a name="getDebugName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDebugName</h4> |
| <pre>public <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> getDebugName()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/sysds/runtime/instructions/cp/Data.html#getDebugName--">getDebugName</a></code> in class <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="isCached-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isCached</h4> |
| <pre>public boolean isCached(boolean inclCachedNoWrite)</pre> |
| </li> |
| </ul> |
| <a name="setEmptyStatus--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setEmptyStatus</h4> |
| <pre>public void setEmptyStatus()</pre> |
| </li> |
| </ul> |
| <a name="addBroadcastSize-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addBroadcastSize</h4> |
| <pre>public static void addBroadcastSize(long size)</pre> |
| </li> |
| </ul> |
| <a name="getBroadcastSize--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBroadcastSize</h4> |
| <pre>public static long getBroadcastSize()</pre> |
| </li> |
| </ul> |
| <a name="cleanupCacheDir--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>cleanupCacheDir</h4> |
| <pre>public static void cleanupCacheDir()</pre> |
| </li> |
| </ul> |
| <a name="cleanupCacheDir-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>cleanupCacheDir</h4> |
| <pre>public static void cleanupCacheDir(boolean withDir)</pre> |
| <div class="block">Deletes the DML-script-specific caching working dir.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>withDir</code> - if true, delete directory</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="initCaching--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>initCaching</h4> |
| <pre>public static void initCaching() |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Inits caching with the default uuid of DMLScript</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if IOException occurs</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="initCaching-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>initCaching</h4> |
| <pre>public static void initCaching(<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> uuid) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Creates the DML-script-specific caching working dir. |
| |
| Takes the UUID in order to allow for custom uuid, e.g., for remote parfor caching</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>uuid</code> - ID</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if IOException occurs</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isCachingActive--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isCachingActive</h4> |
| <pre>public static boolean isCachingActive()</pre> |
| </li> |
| </ul> |
| <a name="disableCaching--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>disableCaching</h4> |
| <pre>public static void disableCaching()</pre> |
| </li> |
| </ul> |
| <a name="enableCaching--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>enableCaching</h4> |
| <pre>public static void enableCaching()</pre> |
| </li> |
| </ul> |
| <a name="moveData-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>moveData</h4> |
| <pre>public boolean moveData(<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> fName, |
| <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> outputFormat)</pre> |
| </li> |
| </ul> |
| <a name="toString--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre>public <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> toString()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a></code> in class <code><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></code></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/CacheableData.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/ByteBuffer.html" title="class in org.apache.sysds.runtime.controlprogram.caching"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/sysds/runtime/controlprogram/caching/CacheableData.CacheStatus.html" title="enum in org.apache.sysds.runtime.controlprogram.caching"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/sysds/runtime/controlprogram/caching/CacheableData.html" target="_top">Frames</a></li> |
| <li><a href="CacheableData.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../allclasses-noframe.html">All 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: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li>Constr | </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 © 2021 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
