| <!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_162) on Tue Aug 07 18:31:01 PDT 2018 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>SetOperationBuilder (com.yahoo.datasketches:sketches-core 0.12.1-SNAPSHOT API)</title> |
| <meta name="date" content="2018-08-07"> |
| <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="SetOperationBuilder (com.yahoo.datasketches:sketches-core 0.12.1-SNAPSHOT API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/SetOperationBuilder.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="../../../../com/yahoo/sketches/theta/SetOperation.html" title="class in com.yahoo.sketches.theta"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../com/yahoo/sketches/theta/SingleItemSketch.html" title="class in com.yahoo.sketches.theta"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?com/yahoo/sketches/theta/SetOperationBuilder.html" target="_top">Frames</a></li> |
| <li><a href="SetOperationBuilder.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>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 name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">com.yahoo.sketches.theta</div> |
| <h2 title="Class SetOperationBuilder" class="title">Class SetOperationBuilder</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>com.yahoo.sketches.theta.SetOperationBuilder</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">SetOperationBuilder</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">For building a new SetOperation.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Author:</span></dt> |
| <dd>Lee Rhodes</dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== 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"> </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="../../../../com/yahoo/sketches/theta/SetOperationBuilder.html#SetOperationBuilder--">SetOperationBuilder</a></span>()</code> |
| <div class="block">Constructor for building a new SetOperation.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </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="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../com/yahoo/sketches/theta/SetOperation.html" title="class in com.yahoo.sketches.theta">SetOperation</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/SetOperationBuilder.html#build-com.yahoo.sketches.Family-">build</a></span>(<a href="../../../../com/yahoo/sketches/Family.html" title="enum in com.yahoo.sketches">Family</a> family)</code> |
| <div class="block">Returns a SetOperation with the current configuration of this Builder and the given Family.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../com/yahoo/sketches/theta/SetOperation.html" title="class in com.yahoo.sketches.theta">SetOperation</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/SetOperationBuilder.html#build-com.yahoo.sketches.Family-com.yahoo.memory.WritableMemory-">build</a></span>(<a href="../../../../com/yahoo/sketches/Family.html" title="enum in com.yahoo.sketches">Family</a> family, |
| com.yahoo.memory.WritableMemory dstMem)</code> |
| <div class="block">Returns a SetOperation with the current configuration of this Builder, the given Family |
| and the given destination memory.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../com/yahoo/sketches/theta/AnotB.html" title="class in com.yahoo.sketches.theta">AnotB</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/SetOperationBuilder.html#buildANotB--">buildANotB</a></span>()</code> |
| <div class="block">Convenience method, returns a configured SetOperation ANotB with |
| <a href="../../../../resources/dictionary.html#defaultUpdateSeed">Default Update Seed</a></div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../com/yahoo/sketches/theta/Intersection.html" title="class in com.yahoo.sketches.theta">Intersection</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/SetOperationBuilder.html#buildIntersection--">buildIntersection</a></span>()</code> |
| <div class="block">Convenience method, returns a configured SetOperation Intersection with |
| <a href="../../../../resources/dictionary.html#defaultNomEntries">Default Nominal Entries</a></div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../com/yahoo/sketches/theta/Intersection.html" title="class in com.yahoo.sketches.theta">Intersection</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/SetOperationBuilder.html#buildIntersection-com.yahoo.memory.WritableMemory-">buildIntersection</a></span>(com.yahoo.memory.WritableMemory dstMem)</code> |
| <div class="block">Convenience method, returns a configured SetOperation Intersection with |
| <a href="../../../../resources/dictionary.html#defaultNomEntries">Default Nominal Entries</a> |
| and the given destination memory.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../com/yahoo/sketches/theta/Union.html" title="class in com.yahoo.sketches.theta">Union</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/SetOperationBuilder.html#buildUnion--">buildUnion</a></span>()</code> |
| <div class="block">Convenience method, returns a configured SetOperation Union with |
| <a href="../../../../resources/dictionary.html#defaultNomEntries">Default Nominal Entries</a></div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../com/yahoo/sketches/theta/Union.html" title="class in com.yahoo.sketches.theta">Union</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/SetOperationBuilder.html#buildUnion-com.yahoo.memory.WritableMemory-">buildUnion</a></span>(com.yahoo.memory.WritableMemory dstMem)</code> |
| <div class="block">Convenience method, returns a configured SetOperation Union with |
| <a href="../../../../resources/dictionary.html#defaultNomEntries">Default Nominal Entries</a> |
| and the given destination memory.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/SetOperationBuilder.html#getLgNominalEntries--">getLgNominalEntries</a></span>()</code> |
| <div class="block">Returns Log-base 2 Nominal Entries</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>com.yahoo.memory.MemoryRequestServer</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/SetOperationBuilder.html#getMemoryRequestServer--">getMemoryRequestServer</a></span>()</code> |
| <div class="block">Returns the MemoryRequestServer</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>float</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/SetOperationBuilder.html#getP--">getP</a></span>()</code> |
| <div class="block">Returns the pre-sampling probability <i>p</i></div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../com/yahoo/sketches/ResizeFactor.html" title="enum in com.yahoo.sketches">ResizeFactor</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/SetOperationBuilder.html#getResizeFactor--">getResizeFactor</a></span>()</code> |
| <div class="block">Returns the Resize Factor</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/SetOperationBuilder.html#getSeed--">getSeed</a></span>()</code> |
| <div class="block">Returns the seed</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../com/yahoo/sketches/theta/SetOperationBuilder.html" title="class in com.yahoo.sketches.theta">SetOperationBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/SetOperationBuilder.html#setMemoryRequestServer-com.yahoo.memory.MemoryRequestServer-">setMemoryRequestServer</a></span>(com.yahoo.memory.MemoryRequestServer memReqSvr)</code> |
| <div class="block">Set the MemoryRequestServer</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../com/yahoo/sketches/theta/SetOperationBuilder.html" title="class in com.yahoo.sketches.theta">SetOperationBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/SetOperationBuilder.html#setNominalEntries-int-">setNominalEntries</a></span>(int nomEntries)</code> |
| <div class="block">Sets the Nominal Entries for this set operation.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../com/yahoo/sketches/theta/SetOperationBuilder.html" title="class in com.yahoo.sketches.theta">SetOperationBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/SetOperationBuilder.html#setP-float-">setP</a></span>(float p)</code> |
| <div class="block">Sets the upfront uniform sampling probability, <i>p</i>.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../com/yahoo/sketches/theta/SetOperationBuilder.html" title="class in com.yahoo.sketches.theta">SetOperationBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/SetOperationBuilder.html#setResizeFactor-com.yahoo.sketches.ResizeFactor-">setResizeFactor</a></span>(<a href="../../../../com/yahoo/sketches/ResizeFactor.html" title="enum in com.yahoo.sketches">ResizeFactor</a> rf)</code> |
| <div class="block">Sets the cache Resize Factor</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../com/yahoo/sketches/theta/SetOperationBuilder.html" title="class in com.yahoo.sketches.theta">SetOperationBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/SetOperationBuilder.html#setSeed-long-">setSeed</a></span>(long seed)</code> |
| <div class="block">Sets the long seed value that is require by the hashing function.</div> |
| </td> |
| </tr> |
| <tr id="i17" 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="../../../../com/yahoo/sketches/theta/SetOperationBuilder.html#toString--">toString</a></span>()</code> </td> |
| </tr> |
| </table> |
| <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#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"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="SetOperationBuilder--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>SetOperationBuilder</h4> |
| <pre>public SetOperationBuilder()</pre> |
| <div class="block">Constructor for building a new SetOperation. The default configuration is |
| <ul> |
| <li>Nominal Entries: <a href="../../../../com/yahoo/sketches/Util.html#DEFAULT_NOMINAL_ENTRIES">4096</a></li> |
| <li>Seed: <a href="../../../../com/yahoo/sketches/Util.html#DEFAULT_UPDATE_SEED">9001L</a></li> |
| <li><a href="../../../../com/yahoo/sketches/ResizeFactor.html#X8"><code>ResizeFactor.X8</code></a></li> |
| <li>Input Sampling Probability: 1.0</li> |
| <li>Memory: null</li> |
| </ul></div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="setNominalEntries-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setNominalEntries</h4> |
| <pre>public <a href="../../../../com/yahoo/sketches/theta/SetOperationBuilder.html" title="class in com.yahoo.sketches.theta">SetOperationBuilder</a> setNominalEntries(int nomEntries)</pre> |
| <div class="block">Sets the Nominal Entries for this set operation. The minimum value is 16 and the maximum value |
| is 67,108,864, which is 2^26. Be aware that Unions as large as this maximum value have not |
| been thoroughly tested or characterized for performance.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>nomEntries</code> - <a href="../../../../resources/dictionary.html#nomEntries">Nominal Entres</a> |
| This will become the ceiling power of 2 if it is not.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this SetOperationBuilder</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getLgNominalEntries--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLgNominalEntries</h4> |
| <pre>public int getLgNominalEntries()</pre> |
| <div class="block">Returns Log-base 2 Nominal Entries</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Log-base 2 Nominal Entries</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setSeed-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSeed</h4> |
| <pre>public <a href="../../../../com/yahoo/sketches/theta/SetOperationBuilder.html" title="class in com.yahoo.sketches.theta">SetOperationBuilder</a> setSeed(long seed)</pre> |
| <div class="block">Sets the long seed value that is require by the hashing function.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>seed</code> - <a href="../../../../resources/dictionary.html#seed">See seed</a></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this SetOperationBuilder</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSeed--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSeed</h4> |
| <pre>public long getSeed()</pre> |
| <div class="block">Returns the seed</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the seed</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setP-float-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setP</h4> |
| <pre>public <a href="../../../../com/yahoo/sketches/theta/SetOperationBuilder.html" title="class in com.yahoo.sketches.theta">SetOperationBuilder</a> setP(float p)</pre> |
| <div class="block">Sets the upfront uniform sampling probability, <i>p</i>. Although this functionality is |
| implemented for Unions only, it rarely makes sense to use it. The proper use of upfront |
| sampling is when building the sketches.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>p</code> - <a href="../../../../resources/dictionary.html#p">See Sampling Probability, <i>p</i></a></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this SetOperationBuilder</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getP--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getP</h4> |
| <pre>public float getP()</pre> |
| <div class="block">Returns the pre-sampling probability <i>p</i></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the pre-sampling probability <i>p</i></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setResizeFactor-com.yahoo.sketches.ResizeFactor-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setResizeFactor</h4> |
| <pre>public <a href="../../../../com/yahoo/sketches/theta/SetOperationBuilder.html" title="class in com.yahoo.sketches.theta">SetOperationBuilder</a> setResizeFactor(<a href="../../../../com/yahoo/sketches/ResizeFactor.html" title="enum in com.yahoo.sketches">ResizeFactor</a> rf)</pre> |
| <div class="block">Sets the cache Resize Factor</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>rf</code> - <a href="../../../../resources/dictionary.html#resizeFactor">See Resize Factor</a></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this SetOperationBuilder</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getResizeFactor--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getResizeFactor</h4> |
| <pre>public <a href="../../../../com/yahoo/sketches/ResizeFactor.html" title="enum in com.yahoo.sketches">ResizeFactor</a> getResizeFactor()</pre> |
| <div class="block">Returns the Resize Factor</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the Resize Factor</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setMemoryRequestServer-com.yahoo.memory.MemoryRequestServer-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMemoryRequestServer</h4> |
| <pre>public <a href="../../../../com/yahoo/sketches/theta/SetOperationBuilder.html" title="class in com.yahoo.sketches.theta">SetOperationBuilder</a> setMemoryRequestServer(com.yahoo.memory.MemoryRequestServer memReqSvr)</pre> |
| <div class="block">Set the MemoryRequestServer</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>memReqSvr</code> - the given MemoryRequestServer</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this SetOperationBuilder</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMemoryRequestServer--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMemoryRequestServer</h4> |
| <pre>public com.yahoo.memory.MemoryRequestServer getMemoryRequestServer()</pre> |
| <div class="block">Returns the MemoryRequestServer</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the MemoryRequestServer</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="build-com.yahoo.sketches.Family-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>build</h4> |
| <pre>public <a href="../../../../com/yahoo/sketches/theta/SetOperation.html" title="class in com.yahoo.sketches.theta">SetOperation</a> build(<a href="../../../../com/yahoo/sketches/Family.html" title="enum in com.yahoo.sketches">Family</a> family)</pre> |
| <div class="block">Returns a SetOperation with the current configuration of this Builder and the given Family.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>family</code> - the chosen SetOperation family</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a SetOperation</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="build-com.yahoo.sketches.Family-com.yahoo.memory.WritableMemory-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>build</h4> |
| <pre>public <a href="../../../../com/yahoo/sketches/theta/SetOperation.html" title="class in com.yahoo.sketches.theta">SetOperation</a> build(<a href="../../../../com/yahoo/sketches/Family.html" title="enum in com.yahoo.sketches">Family</a> family, |
| com.yahoo.memory.WritableMemory dstMem)</pre> |
| <div class="block">Returns a SetOperation with the current configuration of this Builder, the given Family |
| and the given destination memory. Note that the destination memory cannot be used with AnotB.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>family</code> - the chosen SetOperation family</dd> |
| <dd><code>dstMem</code> - The destination Memory.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a SetOperation</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="buildUnion--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>buildUnion</h4> |
| <pre>public <a href="../../../../com/yahoo/sketches/theta/Union.html" title="class in com.yahoo.sketches.theta">Union</a> buildUnion()</pre> |
| <div class="block">Convenience method, returns a configured SetOperation Union with |
| <a href="../../../../resources/dictionary.html#defaultNomEntries">Default Nominal Entries</a></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a Union object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="buildUnion-com.yahoo.memory.WritableMemory-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>buildUnion</h4> |
| <pre>public <a href="../../../../com/yahoo/sketches/theta/Union.html" title="class in com.yahoo.sketches.theta">Union</a> buildUnion(com.yahoo.memory.WritableMemory dstMem)</pre> |
| <div class="block">Convenience method, returns a configured SetOperation Union with |
| <a href="../../../../resources/dictionary.html#defaultNomEntries">Default Nominal Entries</a> |
| and the given destination memory.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>dstMem</code> - The destination Memory.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a Union object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="buildIntersection--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>buildIntersection</h4> |
| <pre>public <a href="../../../../com/yahoo/sketches/theta/Intersection.html" title="class in com.yahoo.sketches.theta">Intersection</a> buildIntersection()</pre> |
| <div class="block">Convenience method, returns a configured SetOperation Intersection with |
| <a href="../../../../resources/dictionary.html#defaultNomEntries">Default Nominal Entries</a></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an Intersection object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="buildIntersection-com.yahoo.memory.WritableMemory-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>buildIntersection</h4> |
| <pre>public <a href="../../../../com/yahoo/sketches/theta/Intersection.html" title="class in com.yahoo.sketches.theta">Intersection</a> buildIntersection(com.yahoo.memory.WritableMemory dstMem)</pre> |
| <div class="block">Convenience method, returns a configured SetOperation Intersection with |
| <a href="../../../../resources/dictionary.html#defaultNomEntries">Default Nominal Entries</a> |
| and the given destination memory.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>dstMem</code> - The destination Memory.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an Intersection object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="buildANotB--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>buildANotB</h4> |
| <pre>public <a href="../../../../com/yahoo/sketches/theta/AnotB.html" title="class in com.yahoo.sketches.theta">AnotB</a> buildANotB()</pre> |
| <div class="block">Convenience method, returns a configured SetOperation ANotB with |
| <a href="../../../../resources/dictionary.html#defaultUpdateSeed">Default Update Seed</a></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an ANotB object</dd> |
| </dl> |
| </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/SetOperationBuilder.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="../../../../com/yahoo/sketches/theta/SetOperation.html" title="class in com.yahoo.sketches.theta"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../com/yahoo/sketches/theta/SingleItemSketch.html" title="class in com.yahoo.sketches.theta"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?com/yahoo/sketches/theta/SetOperationBuilder.html" target="_top">Frames</a></li> |
| <li><a href="SetOperationBuilder.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>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 name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2015–2018. All rights reserved.</small></p> |
| </body> |
| </html> |