Upstream/Plan
1
0
Fork 0
mirror of https://github.com/plan-player-analytics/Plan.git synced 2024-11-01 16:29:31 +01:00
Code Issues Projects Releases Wiki Activity
dd315e724f
Plan/all/com/djrapitops/plan/delivery/domain/mutators/RetentionData.html
Rsl1122 dd315e724f Updated javadocs
2020-03-21 16:43:05 +02:00

380 lines
17 KiB
HTML
Raw Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="fi">
<head>
<!-- Generated by javadoc -->
<title>RetentionData (Plan 5.1-SNAPSHOT API)</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="RetentionData (Plan 5.1-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":9,"i2":10,"i3":10,"i4":10,"i5":10,"i6":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="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/djrapitops/plan/delivery/domain/mutators/PlayerVersusMutator.html" title="class in com.djrapitops.plan.delivery.domain.mutators"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../com/djrapitops/plan/delivery/domain/mutators/SessionsMutator.html" title="class in com.djrapitops.plan.delivery.domain.mutators"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?com/djrapitops/plan/delivery/domain/mutators/RetentionData.html" target="_top">Frames</a></li>
<li><a href="RetentionData.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><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>Field&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">com.djrapitops.plan.delivery.domain.mutators</div>
<h2 title="Class RetentionData" class="title">Class RetentionData</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.djrapitops.plan.delivery.domain.mutators.RetentionData</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">RetentionData</span>
extends java.lang.Object</pre>
<div class="block">Utility class for player retention calculations.
<p>
Previously known as StickyData.</div>
</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">&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="../../../../../../com/djrapitops/plan/delivery/domain/mutators/RetentionData.html#RetentionData-double-double-">RetentionData</a></span>(double&nbsp;activityIndex,
double&nbsp;onlineOnJoin)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../com/djrapitops/plan/delivery/domain/mutators/RetentionData.html#RetentionData-com.djrapitops.plan.delivery.domain.container.PlayerContainer-com.djrapitops.plan.delivery.domain.mutators.PlayersOnlineResolver-long-">RetentionData</a></span>(<a href="../../../../../../com/djrapitops/plan/delivery/domain/container/PlayerContainer.html" title="class in com.djrapitops.plan.delivery.domain.container">PlayerContainer</a>&nbsp;player,
<a href="../../../../../../com/djrapitops/plan/delivery/domain/mutators/PlayersOnlineResolver.html" title="class in com.djrapitops.plan.delivery.domain.mutators">PlayersOnlineResolver</a>&nbsp;onlineOnJoin,
long&nbsp;activityMsThreshold)</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>static <a href="../../../../../../com/djrapitops/plan/delivery/domain/mutators/RetentionData.html" title="class in com.djrapitops.plan.delivery.domain.mutators">RetentionData</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/djrapitops/plan/delivery/domain/mutators/RetentionData.html#average-java.util.Collection-">average</a></span>(java.util.Collection&lt;<a href="../../../../../../com/djrapitops/plan/delivery/domain/mutators/RetentionData.html" title="class in com.djrapitops.plan.delivery.domain.mutators">RetentionData</a>&gt;&nbsp;stuck)</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/djrapitops/plan/delivery/domain/mutators/RetentionData.html#countRetentionPrediction-java.util.Collection-com.djrapitops.plan.delivery.domain.mutators.ActivityIndex-com.djrapitops.plan.delivery.domain.mutators.ActivityIndex-">countRetentionPrediction</a></span>(java.util.Collection&lt;<a href="../../../../../../com/djrapitops/plan/delivery/domain/mutators/ActivityIndex.html" title="class in com.djrapitops.plan.delivery.domain.mutators">ActivityIndex</a>&gt;&nbsp;newPlayers,
<a href="../../../../../../com/djrapitops/plan/delivery/domain/mutators/ActivityIndex.html" title="class in com.djrapitops.plan.delivery.domain.mutators">ActivityIndex</a>&nbsp;retained,
<a href="../../../../../../com/djrapitops/plan/delivery/domain/mutators/ActivityIndex.html" title="class in com.djrapitops.plan.delivery.domain.mutators">ActivityIndex</a>&nbsp;nonRetained)</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/djrapitops/plan/delivery/domain/mutators/RetentionData.html#distance-com.djrapitops.plan.delivery.domain.mutators.RetentionData-">distance</a></span>(<a href="../../../../../../com/djrapitops/plan/delivery/domain/mutators/RetentionData.html" title="class in com.djrapitops.plan.delivery.domain.mutators">RetentionData</a>&nbsp;data)</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/djrapitops/plan/delivery/domain/mutators/RetentionData.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object&nbsp;o)</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/djrapitops/plan/delivery/domain/mutators/RetentionData.html#getActivityIndex--">getActivityIndex</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/djrapitops/plan/delivery/domain/mutators/RetentionData.html#getOnlineOnJoin--">getOnlineOnJoin</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/djrapitops/plan/delivery/domain/mutators/RetentionData.html#hashCode--">hashCode</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.Object</h3>
<code>clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait</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="RetentionData-double-double-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>RetentionData</h4>
<pre>public&nbsp;RetentionData(double&nbsp;activityIndex,
double&nbsp;onlineOnJoin)</pre>
</li>
</ul>
<a name="RetentionData-com.djrapitops.plan.delivery.domain.container.PlayerContainer-com.djrapitops.plan.delivery.domain.mutators.PlayersOnlineResolver-long-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>RetentionData</h4>
<pre>public&nbsp;RetentionData(<a href="../../../../../../com/djrapitops/plan/delivery/domain/container/PlayerContainer.html" title="class in com.djrapitops.plan.delivery.domain.container">PlayerContainer</a>&nbsp;player,
<a href="../../../../../../com/djrapitops/plan/delivery/domain/mutators/PlayersOnlineResolver.html" title="class in com.djrapitops.plan.delivery.domain.mutators">PlayersOnlineResolver</a>&nbsp;onlineOnJoin,
long&nbsp;activityMsThreshold)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="average-java.util.Collection-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>average</h4>
<pre>public static&nbsp;<a href="../../../../../../com/djrapitops/plan/delivery/domain/mutators/RetentionData.html" title="class in com.djrapitops.plan.delivery.domain.mutators">RetentionData</a>&nbsp;average(java.util.Collection&lt;<a href="../../../../../../com/djrapitops/plan/delivery/domain/mutators/RetentionData.html" title="class in com.djrapitops.plan.delivery.domain.mutators">RetentionData</a>&gt;&nbsp;stuck)</pre>
</li>
</ul>
<a name="countRetentionPrediction-java.util.Collection-com.djrapitops.plan.delivery.domain.mutators.ActivityIndex-com.djrapitops.plan.delivery.domain.mutators.ActivityIndex-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>countRetentionPrediction</h4>
<pre>public static&nbsp;int&nbsp;countRetentionPrediction(java.util.Collection&lt;<a href="../../../../../../com/djrapitops/plan/delivery/domain/mutators/ActivityIndex.html" title="class in com.djrapitops.plan.delivery.domain.mutators">ActivityIndex</a>&gt;&nbsp;newPlayers,
<a href="../../../../../../com/djrapitops/plan/delivery/domain/mutators/ActivityIndex.html" title="class in com.djrapitops.plan.delivery.domain.mutators">ActivityIndex</a>&nbsp;retained,
<a href="../../../../../../com/djrapitops/plan/delivery/domain/mutators/ActivityIndex.html" title="class in com.djrapitops.plan.delivery.domain.mutators">ActivityIndex</a>&nbsp;nonRetained)</pre>
</li>
</ul>
<a name="distance-com.djrapitops.plan.delivery.domain.mutators.RetentionData-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>distance</h4>
<pre>public&nbsp;double&nbsp;distance(<a href="../../../../../../com/djrapitops/plan/delivery/domain/mutators/RetentionData.html" title="class in com.djrapitops.plan.delivery.domain.mutators">RetentionData</a>&nbsp;data)</pre>
</li>
</ul>
<a name="equals-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre>public&nbsp;boolean&nbsp;equals(java.lang.Object&nbsp;o)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>equals</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
<a name="hashCode--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hashCode</h4>
<pre>public&nbsp;int&nbsp;hashCode()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>hashCode</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
<a name="getOnlineOnJoin--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOnlineOnJoin</h4>
<pre>public&nbsp;double&nbsp;getOnlineOnJoin()</pre>
</li>
</ul>
<a name="getActivityIndex--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getActivityIndex</h4>
<pre>public&nbsp;double&nbsp;getActivityIndex()</pre>
</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="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/djrapitops/plan/delivery/domain/mutators/PlayerVersusMutator.html" title="class in com.djrapitops.plan.delivery.domain.mutators"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../com/djrapitops/plan/delivery/domain/mutators/SessionsMutator.html" title="class in com.djrapitops.plan.delivery.domain.mutators"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?com/djrapitops/plan/delivery/domain/mutators/RetentionData.html" target="_top">Frames</a></li>
<li><a href="RetentionData.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><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>Field&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 ======= -->
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink