Google Git
Sign in
apache / hadoop-site / 952d547359cafef280f0a0324055741b2ed55be1 / . / content / docs / r3.3.1 / hadoop-yarn / hadoop-yarn-server / hadoop-yarn-server-resourcemanager / apidocs / org / apache / hadoop / yarn / server / resourcemanager / reservation / RLESparseResourceAllocation.html
blob: be2de6f803340d25bff43fb9f1068c2d3d494930 [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 (1.8.0_292) on Tue Jun 15 06:12:11 GMT 2021 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>RLESparseResourceAllocation (Apache Hadoop YARN ResourceManager 3.3.1 API)</title>
<meta name="date" content="2021-06-15">
<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="RLESparseResourceAllocation (Apache Hadoop YARN ResourceManager 3.3.1 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":9,"i11":10,"i12":10,"i13":10,"i14":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</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/RLESparseResourceAllocation.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/hadoop/yarn/server/resourcemanager/reservation/ReservationSystemUtil.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.reservation"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/RLESparseResourceAllocation.RLEOperator.html" title="enum in org.apache.hadoop.yarn.server.resourcemanager.reservation"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/hadoop/yarn/server/resourcemanager/reservation/RLESparseResourceAllocation.html" target="_top">Frames</a></li>
<li><a href="RLESparseResourceAllocation.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="#field.summary">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><a href="#field.detail">Field</a>&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.hadoop.yarn.server.resourcemanager.reservation</div>
<h2 title="Class RLESparseResourceAllocation" class="title">Class RLESparseResourceAllocation</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>org.apache.hadoop.yarn.server.resourcemanager.reservation.RLESparseResourceAllocation</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/PeriodicRLESparseResourceAllocation.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.reservation">PeriodicRLESparseResourceAllocation</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">RLESparseResourceAllocation</span>
extends <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></pre>
<div class="block">This is a run length encoded sparse data structure that maintains resource
allocations over time.</div>
</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/hadoop/yarn/server/resourcemanager/reservation/RLESparseResourceAllocation.RLEOperator.html" title="enum in org.apache.hadoop.yarn.server.resourcemanager.reservation">RLESparseResourceAllocation.RLEOperator</a></span></code>
<div class="block">The set of operators that can be applied to two
<code>RLESparseResourceAllocation</code> during a merge operation.</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">&nbsp;</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>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/NavigableMap.html?is-external=true" title="class or interface in java.util">NavigableMap</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>,org.apache.hadoop.yarn.api.records.Resource&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/RLESparseResourceAllocation.html#cumulativeCapacity">cumulativeCapacity</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/locks/Lock.html?is-external=true" title="class or interface in java.util.concurrent.locks">Lock</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/RLESparseResourceAllocation.html#readLock">readLock</a></span></code>&nbsp;</td>
</tr>
</table>
</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/hadoop/yarn/server/resourcemanager/reservation/RLESparseResourceAllocation.html#RLESparseResourceAllocation-java.util.NavigableMap-org.apache.hadoop.yarn.util.resource.ResourceCalculator-">RLESparseResourceAllocation</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/NavigableMap.html?is-external=true" title="class or interface in java.util">NavigableMap</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>,org.apache.hadoop.yarn.api.records.Resource&gt;&nbsp;out,
org.apache.hadoop.yarn.util.resource.ResourceCalculator&nbsp;resourceCalculator)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/RLESparseResourceAllocation.html#RLESparseResourceAllocation-org.apache.hadoop.yarn.util.resource.ResourceCalculator-">RLESparseResourceAllocation</a></span>(org.apache.hadoop.yarn.util.resource.ResourceCalculator&nbsp;resourceCalculator)</code>&nbsp;</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/RLESparseResourceAllocation.html#addInterval-org.apache.hadoop.yarn.server.resourcemanager.reservation.ReservationInterval-org.apache.hadoop.yarn.api.records.Resource-">addInterval</a></span>(<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/ReservationInterval.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.reservation">ReservationInterval</a>&nbsp;reservationInterval,
org.apache.hadoop.yarn.api.records.Resource&nbsp;totCap)</code>
<div class="block">Add a resource for the specified interval.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>org.apache.hadoop.yarn.api.records.Resource</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/RLESparseResourceAllocation.html#getCapacityAtTime-long-">getCapacityAtTime</a></span>(long&nbsp;tick)</code>
<div class="block">Returns the capacity, i.e.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/NavigableMap.html?is-external=true" title="class or interface in java.util">NavigableMap</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>,org.apache.hadoop.yarn.api.records.Resource&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/RLESparseResourceAllocation.html#getCumulative--">getCumulative</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/RLESparseResourceAllocation.html#getEarliestStartTime--">getEarliestStartTime</a></span>()</code>
<div class="block">Get the timestamp of the earliest resource allocation.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/RLESparseResourceAllocation.html#getLatestNonNullTime--">getLatestNonNullTime</a></span>()</code>
<div class="block">Get the timestamp of the latest non-null resource allocation.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>org.apache.hadoop.yarn.api.records.Resource</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/RLESparseResourceAllocation.html#getMaximumPeriodicCapacity-long-long-">getMaximumPeriodicCapacity</a></span>(long&nbsp;tick,
long&nbsp;period)</code>
<div class="block">Get the maximum capacity across specified time instances.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>org.apache.hadoop.yarn.api.records.Resource</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/RLESparseResourceAllocation.html#getMinimumCapacityInInterval-org.apache.hadoop.yarn.server.resourcemanager.reservation.ReservationInterval-">getMinimumCapacityInInterval</a></span>(<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/ReservationInterval.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.reservation">ReservationInterval</a>&nbsp;interval)</code>
<div class="block">Get the minimum capacity in the specified time range.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/RLESparseResourceAllocation.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.reservation">RLESparseResourceAllocation</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/RLESparseResourceAllocation.html#getRangeOverlapping-long-long-">getRangeOverlapping</a></span>(long&nbsp;start,
long&nbsp;end)</code>
<div class="block">Get a <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/RLESparseResourceAllocation.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.reservation"><code>RLESparseResourceAllocation</code></a> view of the <code>Resource</code>
allocations between the specified start and end times.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>org.apache.hadoop.yarn.util.resource.ResourceCalculator</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/RLESparseResourceAllocation.html#getResourceCalculator--">getResourceCalculator</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/hadoop/yarn/server/resourcemanager/reservation/RLESparseResourceAllocation.html#isEmpty--">isEmpty</a></span>()</code>
<div class="block">Returns true if there are no non-zero entries.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>static <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/RLESparseResourceAllocation.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.reservation">RLESparseResourceAllocation</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/RLESparseResourceAllocation.html#merge-org.apache.hadoop.yarn.util.resource.ResourceCalculator-org.apache.hadoop.yarn.api.records.Resource-org.apache.hadoop.yarn.server.resourcemanager.reservation.RLESparseResourceAllocation-org.apache.hadoop.yarn.server.resourcemanager.reservation.RLESparseResourceAllocation-org.apache.hadoop.yarn.server.resourcemanager.reservation.RLESparseResourceAllocation.RLEOperator-long-long-">merge</a></span>(org.apache.hadoop.yarn.util.resource.ResourceCalculator&nbsp;resCalc,
org.apache.hadoop.yarn.api.records.Resource&nbsp;clusterResource,
<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/RLESparseResourceAllocation.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.reservation">RLESparseResourceAllocation</a>&nbsp;a,
<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/RLESparseResourceAllocation.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.reservation">RLESparseResourceAllocation</a>&nbsp;b,
<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/RLESparseResourceAllocation.RLEOperator.html" title="enum in org.apache.hadoop.yarn.server.resourcemanager.reservation">RLESparseResourceAllocation.RLEOperator</a>&nbsp;operator,
long&nbsp;start,
long&nbsp;end)</code>
<div class="block">Merges the range start to end of two <code>RLESparseResourceAllocation</code>
using a given <code>RLEOperator</code>.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/RLESparseResourceAllocation.html#removeInterval-org.apache.hadoop.yarn.server.resourcemanager.reservation.ReservationInterval-org.apache.hadoop.yarn.api.records.Resource-">removeInterval</a></span>(<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/ReservationInterval.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.reservation">ReservationInterval</a>&nbsp;reservationInterval,
org.apache.hadoop.yarn.api.records.Resource&nbsp;totCap)</code>
<div class="block">Removes a resource for the specified interval.</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/hadoop/yarn/server/resourcemanager/reservation/RLESparseResourceAllocation.html#shift-long-">shift</a></span>(long&nbsp;delta)</code>
<div class="block">This method shifts all the timestamp of the <code>Resource</code> entries by the
specified "delta".</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/ReservationInterval.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.reservation">ReservationInterval</a>,org.apache.hadoop.yarn.api.records.Resource&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/RLESparseResourceAllocation.html#toIntervalMap--">toIntervalMap</a></span>()</code>
<div class="block">Returns the representation of the current resources allocated over time as
an interval map (in the defined non-null range).</div>
</td>
</tr>
<tr id="i14" 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/hadoop/yarn/server/resourcemanager/reservation/RLESparseResourceAllocation.html#toString--">toString</a></span>()</code>&nbsp;</td>
</tr>
</table>
<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#clone--" title="class or interface in java.lang">clone</a>, <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#finalize--" title="class or interface in java.lang">finalize</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="cumulativeCapacity">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cumulativeCapacity</h4>
<pre>protected&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/NavigableMap.html?is-external=true" title="class or interface in java.util">NavigableMap</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>,org.apache.hadoop.yarn.api.records.Resource&gt; cumulativeCapacity</pre>
</li>
</ul>
<a name="readLock">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>readLock</h4>
<pre>protected final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/locks/Lock.html?is-external=true" title="class or interface in java.util.concurrent.locks">Lock</a> readLock</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="RLESparseResourceAllocation-org.apache.hadoop.yarn.util.resource.ResourceCalculator-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>RLESparseResourceAllocation</h4>
<pre>public&nbsp;RLESparseResourceAllocation(org.apache.hadoop.yarn.util.resource.ResourceCalculator&nbsp;resourceCalculator)</pre>
</li>
</ul>
<a name="RLESparseResourceAllocation-java.util.NavigableMap-org.apache.hadoop.yarn.util.resource.ResourceCalculator-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>RLESparseResourceAllocation</h4>
<pre>public&nbsp;RLESparseResourceAllocation(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/NavigableMap.html?is-external=true" title="class or interface in java.util">NavigableMap</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>,org.apache.hadoop.yarn.api.records.Resource&gt;&nbsp;out,
org.apache.hadoop.yarn.util.resource.ResourceCalculator&nbsp;resourceCalculator)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="addInterval-org.apache.hadoop.yarn.server.resourcemanager.reservation.ReservationInterval-org.apache.hadoop.yarn.api.records.Resource-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addInterval</h4>
<pre>public&nbsp;boolean&nbsp;addInterval(<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/ReservationInterval.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.reservation">ReservationInterval</a>&nbsp;reservationInterval,
org.apache.hadoop.yarn.api.records.Resource&nbsp;totCap)</pre>
<div class="block">Add a resource for the specified interval.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>reservationInterval</code> - the interval for which the resource is to be
added</dd>
<dd><code>totCap</code> - the resource to be added</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if addition is successful, false otherwise</dd>
</dl>
</li>
</ul>
<a name="removeInterval-org.apache.hadoop.yarn.server.resourcemanager.reservation.ReservationInterval-org.apache.hadoop.yarn.api.records.Resource-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeInterval</h4>
<pre>public&nbsp;boolean&nbsp;removeInterval(<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/ReservationInterval.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.reservation">ReservationInterval</a>&nbsp;reservationInterval,
org.apache.hadoop.yarn.api.records.Resource&nbsp;totCap)</pre>
<div class="block">Removes a resource for the specified interval.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>reservationInterval</code> - the interval for which the resource is to be
removed</dd>
<dd><code>totCap</code> - the resource to be removed</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if removal is successful, false otherwise</dd>
</dl>
</li>
</ul>
<a name="getCapacityAtTime-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCapacityAtTime</h4>
<pre>public&nbsp;org.apache.hadoop.yarn.api.records.Resource&nbsp;getCapacityAtTime(long&nbsp;tick)</pre>
<div class="block">Returns the capacity, i.e. total resources allocated at the specified point
of time.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>tick</code> - timeStap at which resource needs to be known</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the resources allocated at the specified time</dd>
</dl>
</li>
</ul>
<a name="getEarliestStartTime--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEarliestStartTime</h4>
<pre>public&nbsp;long&nbsp;getEarliestStartTime()</pre>
<div class="block">Get the timestamp of the earliest resource allocation.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the timestamp of the first resource allocation</dd>
</dl>
</li>
</ul>
<a name="getLatestNonNullTime--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLatestNonNullTime</h4>
<pre>public&nbsp;long&nbsp;getLatestNonNullTime()</pre>
<div class="block">Get the timestamp of the latest non-null resource allocation.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the timestamp of the last resource allocation</dd>
</dl>
</li>
</ul>
<a name="isEmpty--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isEmpty</h4>
<pre>public&nbsp;boolean&nbsp;isEmpty()</pre>
<div class="block">Returns true if there are no non-zero entries.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if there are no allocations or false otherwise</dd>
</dl>
</li>
</ul>
<a name="toString--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toString</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;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>&nbsp;in class&nbsp;<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>
<a name="toIntervalMap--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toIntervalMap</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/ReservationInterval.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.reservation">ReservationInterval</a>,org.apache.hadoop.yarn.api.records.Resource&gt;&nbsp;toIntervalMap()</pre>
<div class="block">Returns the representation of the current resources allocated over time as
an interval map (in the defined non-null range).</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the representation of the current resources allocated over time as
an interval map.</dd>
</dl>
</li>
</ul>
<a name="getCumulative--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCumulative</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/NavigableMap.html?is-external=true" title="class or interface in java.util">NavigableMap</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>,org.apache.hadoop.yarn.api.records.Resource&gt;&nbsp;getCumulative()</pre>
</li>
</ul>
<a name="getResourceCalculator--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getResourceCalculator</h4>
<pre>public&nbsp;org.apache.hadoop.yarn.util.resource.ResourceCalculator&nbsp;getResourceCalculator()</pre>
</li>
</ul>
<a name="merge-org.apache.hadoop.yarn.util.resource.ResourceCalculator-org.apache.hadoop.yarn.api.records.Resource-org.apache.hadoop.yarn.server.resourcemanager.reservation.RLESparseResourceAllocation-org.apache.hadoop.yarn.server.resourcemanager.reservation.RLESparseResourceAllocation-org.apache.hadoop.yarn.server.resourcemanager.reservation.RLESparseResourceAllocation.RLEOperator-long-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>merge</h4>
<pre>public static&nbsp;<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/RLESparseResourceAllocation.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.reservation">RLESparseResourceAllocation</a>&nbsp;merge(org.apache.hadoop.yarn.util.resource.ResourceCalculator&nbsp;resCalc,
org.apache.hadoop.yarn.api.records.Resource&nbsp;clusterResource,
<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/RLESparseResourceAllocation.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.reservation">RLESparseResourceAllocation</a>&nbsp;a,
<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/RLESparseResourceAllocation.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.reservation">RLESparseResourceAllocation</a>&nbsp;b,
<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/RLESparseResourceAllocation.RLEOperator.html" title="enum in org.apache.hadoop.yarn.server.resourcemanager.reservation">RLESparseResourceAllocation.RLEOperator</a>&nbsp;operator,
long&nbsp;start,
long&nbsp;end)
throws <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/exceptions/PlanningException.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.reservation.exceptions">PlanningException</a></pre>
<div class="block">Merges the range start to end of two <code>RLESparseResourceAllocation</code>
using a given <code>RLEOperator</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>resCalc</code> - the resource calculator</dd>
<dd><code>clusterResource</code> - the total cluster resources (for DRF)</dd>
<dd><code>a</code> - the left operand</dd>
<dd><code>b</code> - the right operand</dd>
<dd><code>operator</code> - the operator to be applied during merge</dd>
<dd><code>start</code> - the start-time of the range to be considered</dd>
<dd><code>end</code> - the end-time of the range to be considered</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the a merged RLESparseResourceAllocation, produced by applying
"operator" to "a" and "b"</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/exceptions/PlanningException.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.reservation.exceptions">PlanningException</a></code> - in case the operator is subtractTestPositive and
the result would contain a negative value</dd>
</dl>
</li>
</ul>
<a name="getRangeOverlapping-long-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRangeOverlapping</h4>
<pre>public&nbsp;<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/RLESparseResourceAllocation.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.reservation">RLESparseResourceAllocation</a>&nbsp;getRangeOverlapping(long&nbsp;start,
long&nbsp;end)</pre>
<div class="block">Get a <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/RLESparseResourceAllocation.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.reservation"><code>RLESparseResourceAllocation</code></a> view of the <code>Resource</code>
allocations between the specified start and end times.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>start</code> - the time from which the <code>Resource</code> allocations are
required</dd>
<dd><code>end</code> - the time upto which the <code>Resource</code> allocations are
required</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the overlapping allocations</dd>
</dl>
</li>
</ul>
<a name="shift-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>shift</h4>
<pre>public&nbsp;void&nbsp;shift(long&nbsp;delta)</pre>
<div class="block">This method shifts all the timestamp of the <code>Resource</code> entries by the
specified "delta".</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>delta</code> - the time by which to shift the <code>Resource</code> allocations</dd>
</dl>
</li>
</ul>
<a name="getMaximumPeriodicCapacity-long-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaximumPeriodicCapacity</h4>
<pre>public&nbsp;org.apache.hadoop.yarn.api.records.Resource&nbsp;getMaximumPeriodicCapacity(long&nbsp;tick,
long&nbsp;period)</pre>
<div class="block">Get the maximum capacity across specified time instances. The search-space
is specified using the starting value, tick, and the periodic interval for
search. Maximum resource allocation across tick, tick + period, tick + 2 *
period,..., tick + n * period .. is returned.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>tick</code> - the starting time instance</dd>
<dd><code>period</code> - interval at which capacity is evaluated</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>maximum resource allocation</dd>
</dl>
</li>
</ul>
<a name="getMinimumCapacityInInterval-org.apache.hadoop.yarn.server.resourcemanager.reservation.ReservationInterval-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getMinimumCapacityInInterval</h4>
<pre>public&nbsp;org.apache.hadoop.yarn.api.records.Resource&nbsp;getMinimumCapacityInInterval(<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/ReservationInterval.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.reservation">ReservationInterval</a>&nbsp;interval)</pre>
<div class="block">Get the minimum capacity in the specified time range.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>interval</code> - the <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/ReservationInterval.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.reservation"><code>ReservationInterval</code></a> to be searched</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>minimum resource allocation</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/RLESparseResourceAllocation.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/hadoop/yarn/server/resourcemanager/reservation/ReservationSystemUtil.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.reservation"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/RLESparseResourceAllocation.RLEOperator.html" title="enum in org.apache.hadoop.yarn.server.resourcemanager.reservation"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/hadoop/yarn/server/resourcemanager/reservation/RLESparseResourceAllocation.html" target="_top">Frames</a></li>
<li><a href="RLESparseResourceAllocation.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="#field.summary">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><a href="#field.detail">Field</a>&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; 2008&#x2013;2021 <a href="https://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>