| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.9.1) on Fri Sep 09 19:30:40 KST 2022 --> |
| <title>SamplingVertex (Nemo Project 0.4 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2022-09-09"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../jquery/jquery-ui.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../../../../jquery/jquery-3.5.1.js"></script> |
| <script type="text/javascript" src="../../../../../../../jquery/jquery-ui.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="SamplingVertex (Nemo Project 0.4 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../../../../"; |
| var useModuleDirectories = true; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/SamplingVertex.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.nemo.common.ir.vertex.utility</a></div> |
| <h2 title="Class SamplingVertex" class="title">Class SamplingVertex</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../dag/Vertex.html" title="class in org.apache.nemo.common.dag">org.apache.nemo.common.dag.Vertex</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../IRVertex.html" title="class in org.apache.nemo.common.ir.vertex">org.apache.nemo.common.ir.vertex.IRVertex</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.nemo.common.ir.vertex.utility.SamplingVertex</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code>java.io.Serializable</code>, <code><a href="../../../Cloneable.html" title="interface in org.apache.nemo.common">Cloneable</a><<a href="../IRVertex.html" title="class in org.apache.nemo.common.ir.vertex">IRVertex</a>></code></dd> |
| </dl> |
| <hr> |
| <pre>public final class <span class="typeNameLabel">SamplingVertex</span> |
| extends <a href="../IRVertex.html" title="class in org.apache.nemo.common.ir.vertex">IRVertex</a></pre> |
| <div class="block">Executes the original IRVertex using a subset of input data partitions.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../../serialized-form.html#org.apache.nemo.common.ir.vertex.utility.SamplingVertex">Serialized Form</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.nemo.common.ir.vertex.IRVertex,float)">SamplingVertex</a></span>​(<a href="../IRVertex.html" title="class in org.apache.nemo.common.ir.vertex">IRVertex</a> originalVertex, |
| float desiredSampleRate)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance 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="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="../IRVertex.html" title="class in org.apache.nemo.common.ir.vertex">IRVertex</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getClone()">getClone</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Creates and returns a copy of this object.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../edge/IREdge.html" title="class in org.apache.nemo.common.ir.edge">IREdge</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCloneOfOriginalEdge(org.apache.nemo.common.ir.edge.IREdge)">getCloneOfOriginalEdge</a></span>​(<a href="../../edge/IREdge.html" title="class in org.apache.nemo.common.ir.edge">IREdge</a> originalEdge)</code></th> |
| <td class="colLast"> |
| <div class="block">Obtains a clone of an original edge that is attached to this sampling vertex.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../IRVertex.html" title="class in org.apache.nemo.common.ir.vertex">IRVertex</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCloneOfOriginalVertex()">getCloneOfOriginalVertex</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>float</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDesiredSampleRate()">getDesiredSampleRate</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getOriginalVertexId()">getOriginalVertexId</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>com.fasterxml.jackson.databind.node.ObjectNode</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPropertiesAsJsonNode()">getPropertiesAsJsonNode</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toString()">toString</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.apache.nemo.common.ir.vertex.IRVertex"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.nemo.common.ir.vertex.<a href="../IRVertex.html" title="class in org.apache.nemo.common.ir.vertex">IRVertex</a></h3> |
| <code><a href="../IRVertex.html#copyExecutionPropertiesTo(org.apache.nemo.common.ir.vertex.IRVertex)">copyExecutionPropertiesTo</a>, <a href="../IRVertex.html#getExecutionProperties()">getExecutionProperties</a>, <a href="../IRVertex.html#getIRVertexPropertiesAsJsonNode()">getIRVertexPropertiesAsJsonNode</a>, <a href="../IRVertex.html#getPropertyValue(java.lang.Class)">getPropertyValue</a>, <a href="../IRVertex.html#isUtilityVertex()">isUtilityVertex</a>, <a href="../IRVertex.html#setProperty(org.apache.nemo.common.ir.executionproperty.VertexExecutionProperty)">setProperty</a>, <a href="../IRVertex.html#setPropertyPermanently(org.apache.nemo.common.ir.executionproperty.VertexExecutionProperty)">setPropertyPermanently</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.apache.nemo.common.dag.Vertex"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.nemo.common.dag.<a href="../../../dag/Vertex.html" title="class in org.apache.nemo.common.dag">Vertex</a></h3> |
| <code><a href="../../../dag/Vertex.html#getId()">getId</a>, <a href="../../../dag/Vertex.html#getNumericId()">getNumericId</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a id="<init>(org.apache.nemo.common.ir.vertex.IRVertex,float)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>SamplingVertex</h4> |
| <pre>public SamplingVertex​(<a href="../IRVertex.html" title="class in org.apache.nemo.common.ir.vertex">IRVertex</a> originalVertex, |
| float desiredSampleRate)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>originalVertex</code> - to clone.</dd> |
| <dd><code>desiredSampleRate</code> - percentage of tasks to execute. |
| The actual sample rate may vary depending on neighboring sampling vertices.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="getOriginalVertexId()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOriginalVertexId</h4> |
| <pre class="methodSignature">public java.lang.String getOriginalVertexId()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the id of the original vertex for reference.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getCloneOfOriginalVertex()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCloneOfOriginalVertex</h4> |
| <pre class="methodSignature">public <a href="../IRVertex.html" title="class in org.apache.nemo.common.ir.vertex">IRVertex</a> getCloneOfOriginalVertex()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the clone of the original vertex. |
| This clone is intended to be used during the actual execution, as the sampling vertex itself is not executable |
| and the original vertex should not be executed again.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getDesiredSampleRate()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDesiredSampleRate</h4> |
| <pre class="methodSignature">public float getDesiredSampleRate()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the desired sample rate.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getCloneOfOriginalEdge(org.apache.nemo.common.ir.edge.IREdge)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCloneOfOriginalEdge</h4> |
| <pre class="methodSignature">public <a href="../../edge/IREdge.html" title="class in org.apache.nemo.common.ir.edge">IREdge</a> getCloneOfOriginalEdge​(<a href="../../edge/IREdge.html" title="class in org.apache.nemo.common.ir.edge">IREdge</a> originalEdge)</pre> |
| <div class="block">Obtains a clone of an original edge that is attached to this sampling vertex. |
| <p> |
| Original edge: src - to - dst |
| When src == originalVertex, return thisSamplingVertex - to - dst |
| When dst == originalVertex, return src - to - thisSamplingVertex</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>originalEdge</code> - to clone.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a clone of the edge.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="toString()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre class="methodSignature">public java.lang.String toString()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>toString</code> in class <code>java.lang.Object</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getClone()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getClone</h4> |
| <pre class="methodSignature">public <a href="../IRVertex.html" title="class in org.apache.nemo.common.ir.vertex">IRVertex</a> getClone()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../Cloneable.html#getClone()">Cloneable</a></code></span></div> |
| <div class="block">Creates and returns a copy of this object. |
| <p> |
| The precise meaning of "copy" may depend on the class of the object. |
| The general intent is that, all fields of the object are copied. |
| </p></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a clone of this object.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getPropertiesAsJsonNode()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getPropertiesAsJsonNode</h4> |
| <pre class="methodSignature">public com.fasterxml.jackson.databind.node.ObjectNode getPropertiesAsJsonNode()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../dag/Vertex.html#getPropertiesAsJsonNode()">getPropertiesAsJsonNode</a></code> in class <code><a href="../../../dag/Vertex.html" title="class in org.apache.nemo.common.dag">Vertex</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>JSON representation of additional properties</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/SamplingVertex.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |
