blob: a8dd0e0855eff16fb4dcef7dcea252f1c6bfcc62 [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_261) on Sat Sep 11 21:20:04 MSK 2021 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>PartitionContextBuilder (Ignite 2.11.0)</title>
<meta name="date" content="2021-09-11">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<link rel='shortcut icon' href='https://ignite.apache.org/favicon.ico'/>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="PartitionContextBuilder (Ignite 2.11.0)";
}
}
catch(err) {
}
//-->
var methods = {"i0":18,"i1":6,"i2":18};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default 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/PartitionContextBuilder.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/ignite/ml/dataset/DatasetFactory.html" title="class in org.apache.ignite.ml.dataset"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/ignite/ml/dataset/PartitionDataBuilder.html" title="interface in org.apache.ignite.ml.dataset"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/ignite/ml/dataset/PartitionContextBuilder.html" target="_top">Frames</a></li>
<li><a href="PartitionContextBuilder.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>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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.ignite.ml.dataset</div>
<h2 title="Interface PartitionContextBuilder" class="title">Interface PartitionContextBuilder<span class='angle_bracket'>&lt;</span>K,V,C extends <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a><span class='angle_bracket'>&gt;</span></h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>K</code> - Type of a key in <code>upstream</code> data.</dd>
<dd><code>V</code> - Type of a value in <code>upstream</code> data.</dd>
<dd><code>C</code> - Type of a partition <code>context</code>.</dd>
</dl>
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../org/apache/ignite/ml/dataset/primitive/builder/context/EmptyContextBuilder.html" title="class in org.apache.ignite.ml.dataset.primitive.builder.context">EmptyContextBuilder</a></dd>
</dl>
<dl>
<dt>Functional Interface:</dt>
<dd>This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.</dd>
</dl>
<hr>
<br>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/FunctionalInterface.html?is-external=true" title="class or interface in java.lang">@FunctionalInterface</a>
public interface <span class="typeNameLabel">PartitionContextBuilder<span class='angle_bracket'>&lt;</span>K,V,C extends <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a><span class='angle_bracket'>&gt;</span></span>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></pre>
<div class="block">Builder that accepts a partition <code>upstream</code> data and makes partition <code>context</code>. This builder is used to
build a partition <code>context</code> and assumed to be called only once for every partition during a dataset
initialization.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/ignite/ml/dataset/primitive/builder/context/EmptyContextBuilder.html" title="class in org.apache.ignite.ml.dataset.primitive.builder.context"><code>EmptyContextBuilder</code></a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default 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>default <span class='angle_bracket'>&lt;</span>C2 extends <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a><span class='angle_bracket'>&gt;</span><br><a href="../../../../../org/apache/ignite/ml/dataset/PartitionContextBuilder.html" title="interface in org.apache.ignite.ml.dataset">PartitionContextBuilder</a><span class='angle_bracket'>&lt;</span><a href="../../../../../org/apache/ignite/ml/dataset/PartitionContextBuilder.html" title="type parameter in PartitionContextBuilder">K</a>,<a href="../../../../../org/apache/ignite/ml/dataset/PartitionContextBuilder.html" title="type parameter in PartitionContextBuilder">V</a>,C2<span class='angle_bracket'>&gt;</span></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/ignite/ml/dataset/PartitionContextBuilder.html#andThen-org.apache.ignite.ml.math.functions.IgniteFunction-">andThen</a></span>(<a href="../../../../../org/apache/ignite/ml/math/functions/IgniteFunction.html" title="interface in org.apache.ignite.ml.math.functions">IgniteFunction</a><span class='angle_bracket'>&lt;</span><a href="../../../../../org/apache/ignite/ml/dataset/PartitionContextBuilder.html" title="type parameter in PartitionContextBuilder">C</a>,C2<span class='angle_bracket'>&gt;</span>&nbsp;fun)</code>
<div class="block">Makes a composed partition <code>context</code> builder that first builds a <code>context</code> and then applies the
specified function on the result.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/ignite/ml/dataset/PartitionContextBuilder.html" title="type parameter in PartitionContextBuilder">C</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/ignite/ml/dataset/PartitionContextBuilder.html#build-org.apache.ignite.ml.environment.LearningEnvironment-java.util.Iterator-long-">build</a></span>(<a href="../../../../../org/apache/ignite/ml/environment/LearningEnvironment.html" title="interface in org.apache.ignite.ml.environment">LearningEnvironment</a>&nbsp;env,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a><span class='angle_bracket'>&lt;</span><a href="../../../../../org/apache/ignite/ml/dataset/UpstreamEntry.html" title="class in org.apache.ignite.ml.dataset">UpstreamEntry</a><span class='angle_bracket'>&lt;</span><a href="../../../../../org/apache/ignite/ml/dataset/PartitionContextBuilder.html" title="type parameter in PartitionContextBuilder">K</a>,<a href="../../../../../org/apache/ignite/ml/dataset/PartitionContextBuilder.html" title="type parameter in PartitionContextBuilder">V</a><span class='angle_bracket'>&gt;</span><span class='angle_bracket'>&gt;</span>&nbsp;upstreamData,
long&nbsp;upstreamDataSize)</code>
<div class="block">Builds a new partition <code>context</code> from an <code>upstream</code> data.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>default <a href="../../../../../org/apache/ignite/ml/dataset/PartitionContextBuilder.html" title="type parameter in PartitionContextBuilder">C</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/ignite/ml/dataset/PartitionContextBuilder.html#build-org.apache.ignite.ml.environment.LearningEnvironment-java.util.stream.Stream-long-">build</a></span>(<a href="../../../../../org/apache/ignite/ml/environment/LearningEnvironment.html" title="interface in org.apache.ignite.ml.environment">LearningEnvironment</a>&nbsp;env,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/stream/Stream.html?is-external=true" title="class or interface in java.util.stream">Stream</a><span class='angle_bracket'>&lt;</span><a href="../../../../../org/apache/ignite/ml/dataset/UpstreamEntry.html" title="class in org.apache.ignite.ml.dataset">UpstreamEntry</a><span class='angle_bracket'>&lt;</span><a href="../../../../../org/apache/ignite/ml/dataset/PartitionContextBuilder.html" title="type parameter in PartitionContextBuilder">K</a>,<a href="../../../../../org/apache/ignite/ml/dataset/PartitionContextBuilder.html" title="type parameter in PartitionContextBuilder">V</a><span class='angle_bracket'>&gt;</span><span class='angle_bracket'>&gt;</span>&nbsp;upstreamData,
long&nbsp;upstreamDataSize)</code>
<div class="block">Builds a new partition <code>context</code> from an <code>upstream</code> data.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="build-org.apache.ignite.ml.environment.LearningEnvironment-java.util.Iterator-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>build</h4>
<pre><a href="../../../../../org/apache/ignite/ml/dataset/PartitionContextBuilder.html" title="type parameter in PartitionContextBuilder">C</a>&nbsp;build(<a href="../../../../../org/apache/ignite/ml/environment/LearningEnvironment.html" title="interface in org.apache.ignite.ml.environment">LearningEnvironment</a>&nbsp;env,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a><span class='angle_bracket'>&lt;</span><a href="../../../../../org/apache/ignite/ml/dataset/UpstreamEntry.html" title="class in org.apache.ignite.ml.dataset">UpstreamEntry</a><span class='angle_bracket'>&lt;</span><a href="../../../../../org/apache/ignite/ml/dataset/PartitionContextBuilder.html" title="type parameter in PartitionContextBuilder">K</a>,<a href="../../../../../org/apache/ignite/ml/dataset/PartitionContextBuilder.html" title="type parameter in PartitionContextBuilder">V</a><span class='angle_bracket'>&gt;</span><span class='angle_bracket'>&gt;</span>&nbsp;upstreamData,
long&nbsp;upstreamDataSize)</pre>
<div class="block">Builds a new partition <code>context</code> from an <code>upstream</code> data.
Important: there is no guarantee that there will be no more than one UpstreamEntry with given key,
UpstreamEntry should be thought rather as a container saving all data from upstream, but omitting uniqueness
constraint. This constraint is omitted to allow upstream data transformers in <a href="../../../../../org/apache/ignite/ml/dataset/DatasetBuilder.html" title="interface in org.apache.ignite.ml.dataset"><code>DatasetBuilder</code></a> replicating
entries. For example it can be useful for bootstrapping.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>env</code> - Learning environment.</dd>
<dd><code>upstreamData</code> - Partition <code>upstream</code> data.</dd>
<dd><code>upstreamDataSize</code> - Partition <code>upstream</code> data size.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Partition <code>context</code>.</dd>
</dl>
</li>
</ul>
<a name="build-org.apache.ignite.ml.environment.LearningEnvironment-java.util.stream.Stream-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>build</h4>
<pre>default&nbsp;<a href="../../../../../org/apache/ignite/ml/dataset/PartitionContextBuilder.html" title="type parameter in PartitionContextBuilder">C</a>&nbsp;build(<a href="../../../../../org/apache/ignite/ml/environment/LearningEnvironment.html" title="interface in org.apache.ignite.ml.environment">LearningEnvironment</a>&nbsp;env,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/stream/Stream.html?is-external=true" title="class or interface in java.util.stream">Stream</a><span class='angle_bracket'>&lt;</span><a href="../../../../../org/apache/ignite/ml/dataset/UpstreamEntry.html" title="class in org.apache.ignite.ml.dataset">UpstreamEntry</a><span class='angle_bracket'>&lt;</span><a href="../../../../../org/apache/ignite/ml/dataset/PartitionContextBuilder.html" title="type parameter in PartitionContextBuilder">K</a>,<a href="../../../../../org/apache/ignite/ml/dataset/PartitionContextBuilder.html" title="type parameter in PartitionContextBuilder">V</a><span class='angle_bracket'>&gt;</span><span class='angle_bracket'>&gt;</span>&nbsp;upstreamData,
long&nbsp;upstreamDataSize)</pre>
<div class="block">Builds a new partition <code>context</code> from an <code>upstream</code> data.
Important: there is no guarantee that there will be no more than one UpstreamEntry with given key,
UpstreamEntry should be thought rather as a container saving all data from upstream, but omitting uniqueness
constraint. This constraint is omitted to allow upstream data transformers in <a href="../../../../../org/apache/ignite/ml/dataset/DatasetBuilder.html" title="interface in org.apache.ignite.ml.dataset"><code>DatasetBuilder</code></a> replicating
entries. For example it can be useful for bootstrapping.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>env</code> - Learning environment.</dd>
<dd><code>upstreamData</code> - Partition <code>upstream</code> data.</dd>
<dd><code>upstreamDataSize</code> - Partition <code>upstream</code> data size.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Partition <code>context</code>.</dd>
</dl>
</li>
</ul>
<a name="andThen-org.apache.ignite.ml.math.functions.IgniteFunction-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>andThen</h4>
<pre>default&nbsp;<span class='angle_bracket'>&lt;</span>C2 extends <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a><span class='angle_bracket'>&gt;</span>&nbsp;<a href="../../../../../org/apache/ignite/ml/dataset/PartitionContextBuilder.html" title="interface in org.apache.ignite.ml.dataset">PartitionContextBuilder</a><span class='angle_bracket'>&lt;</span><a href="../../../../../org/apache/ignite/ml/dataset/PartitionContextBuilder.html" title="type parameter in PartitionContextBuilder">K</a>,<a href="../../../../../org/apache/ignite/ml/dataset/PartitionContextBuilder.html" title="type parameter in PartitionContextBuilder">V</a>,C2<span class='angle_bracket'>&gt;</span>&nbsp;andThen(<a href="../../../../../org/apache/ignite/ml/math/functions/IgniteFunction.html" title="interface in org.apache.ignite.ml.math.functions">IgniteFunction</a><span class='angle_bracket'>&lt;</span><a href="../../../../../org/apache/ignite/ml/dataset/PartitionContextBuilder.html" title="type parameter in PartitionContextBuilder">C</a>,C2<span class='angle_bracket'>&gt;</span>&nbsp;fun)</pre>
<div class="block">Makes a composed partition <code>context</code> builder that first builds a <code>context</code> and then applies the
specified function on the result.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>C2</code> - New type of a partition <code>context</code>.</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>fun</code> - Function that applied after first partition <code>context</code> is built.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Composed partition <code>context</code> builder.</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/PartitionContextBuilder.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/ignite/ml/dataset/DatasetFactory.html" title="class in org.apache.ignite.ml.dataset"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/ignite/ml/dataset/PartitionDataBuilder.html" title="interface in org.apache.ignite.ml.dataset"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/ignite/ml/dataset/PartitionContextBuilder.html" target="_top">Frames</a></li>
<li><a href="PartitionContextBuilder.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>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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><table width="100%" border="0" cellspacing=0 cellpadding=0 style="padding: 5px"> <tr> <td> <table style="padding-left: 0; margin: 0"> <tbody style="padding: 0; margin: 0"> <tr style="padding: 0; margin: 0"> <td> <a target=_blank href="https://ignite.apache.org"><nobr>2021 Copyright &#169; Apache Software Foundation</nobr></a> </td> </tr> </tbody> </table> </td> <td width="100%" align="right" valign="center"> <a href="https://twitter.com/ApacheIgnite" class="twitter-follow-button" data-show-count="false" data-size="large">Follow @ApacheIgnite</a> </td> </tr> <tr> <td colspan="2" valign="top" align="left"> <table style="padding-left: 0; margin: 0"> <tbody style="padding: 0; margin: 0"> <tr style="padding: 0; margin: 0"> <td> <b>Ignite Database and Caching Platform</b> </td> <td>:&nbsp;&nbsp; ver. <strong>2.11.0</strong> </td> </tr> <tr style="padding: 0; margin: 0"> <td> <b>Release Date</b> </td> <td>:&nbsp;&nbsp; September 11 2021 </td> </tr> </tbody> </table> </td> </tr> </table></small></p>
</body>
</html>