<!DOCTYPE HTML> <!-- NewPage --> <html lang="en"> <head> <!-- Generated by javadoc --> <title>ActivityIndex (Plan 5.4-SNAPSHOT API)</title> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <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="ActivityIndex (Plan 5.4-SNAPSHOT API)"; } } catch(err) { } //--> var data = {"i0":10,"i1":10,"i2":9,"i3":10,"i4":10,"i5":9,"i6":10,"i7":9,"i8":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"; 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="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><a href="#field.summary">Field</a> | </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><a href="#field.detail">Field</a> | </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">com.djrapitops.plan.delivery.domain.mutators</a></div> <h2 title="Class ActivityIndex" class="title">Class ActivityIndex</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>com.djrapitops.plan.delivery.domain.mutators.ActivityIndex</li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <hr> <pre>public class <span class="typeNameLabel">ActivityIndex</span> extends java.lang.Object</pre> <div class="block">Represents Activity index of a player at a certain date. <p> Old formula for activity index was not linear and difficult to turn into a query due to conditional multipliers. Thus a new formula was written. <p> <code>T</code> - Time played after someone is considered active on a particular week <code>t1, t2, t3</code> - Time played that week <p> Activity index takes into account last 3 weeks. <p> Activity for a single week is calculated using <code>A(t) = (1 / (pi/2 * (t/T) + 1))</code>. A(t) is based on function f(x) = 1 / (x + 1), which has property f(0) = 1, decreasing from there, but not in a straight line. You can see the function plotted here https://www.wolframalpha.com/input/?i=1+%2F+(x%2B1)+from+-1+to+2 <p> To fine tune the curve pi/2 is used since it felt like a good curve. <p> Activity index A is calculated by using the formula: <code>A = 5 - 5 * [A(t1) + A(t2) + A(t3)] / 3</code> <p> Plot for A and limits https://www.wolframalpha.com/input/?i=plot+y+%3D+5+-+5+*+(1+%2F+(pi%2F2+*+x%2B1))+and+y+%3D1+and+y+%3D+2+and+y+%3D+3+and+y+%3D+3.75+from+-0.5+to+3 <p> New Limits for A would thus be <code>< 1: Inactive</code> <code>> 1: Irregular</code> <code>> 2: Regular</code> <code>> 3: Active</code> <code>> 3.75: Very Active</code></div> </li> </ul> </div> <div class="summary"> <ul class="blockList"> <li class="blockList"> <!-- =========== FIELD SUMMARY =========== --> <section role="region"> <ul class="blockList"> <li class="blockList"><a id="field.summary"> <!-- --> </a> <h3>Field Summary</h3> <table class="memberSummary"> <caption><span>Fields</span><span class="tabEnd"> </span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colSecond" scope="col">Field</th> <th class="colLast" scope="col">Description</th> </tr> <tr class="altColor"> <td class="colFirst"><code>static double</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#ACTIVE">ACTIVE</a></span></code></th> <td class="colLast"> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>static double</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#IRREGULAR">IRREGULAR</a></span></code></th> <td class="colLast"> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>static double</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#REGULAR">REGULAR</a></span></code></th> <td class="colLast"> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>static double</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#VERY_ACTIVE">VERY_ACTIVE</a></span></code></th> <td class="colLast"> </td> </tr> </table> </li> </ul> </section> <!-- ======== 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(double,long)">ActivityIndex</a></span>​(double value, long date)</code></th> <td class="colLast"> </td> </tr> <tr class="rowColor"> <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(com.djrapitops.plan.delivery.domain.container.DataContainer,long,long)">ActivityIndex</a></span>​(<a href="../container/DataContainer.html" title="interface in com.djrapitops.plan.delivery.domain.container">DataContainer</a> container, long date, long playtimeMsThreshold)</code></th> <td class="colLast"> </td> </tr> <tr class="altColor"> <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.util.List,long,long)">ActivityIndex</a></span>​(java.util.List<<a href="../../../gathering/domain/FinishedSession.html" title="class in com.djrapitops.plan.gathering.domain">FinishedSession</a>> sessions, long date, long playtimeMsThreshold)</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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>double</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#distance(com.djrapitops.plan.delivery.domain.mutators.ActivityIndex)">distance</a></span>​(<a href="ActivityIndex.html" title="class in com.djrapitops.plan.delivery.domain.mutators">ActivityIndex</a> other)</code></th> <td class="colLast"> </td> </tr> <tr id="i1" class="rowColor"> <td class="colFirst"><code>long</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDate()">getDate</a></span>()</code></th> <td class="colLast"> </td> </tr> <tr id="i2" class="altColor"> <td class="colFirst"><code>static java.lang.String[]</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDefaultGroups()">getDefaultGroups</a></span>()</code></th> <td class="colLast"> </td> </tr> <tr id="i3" class="rowColor"> <td class="colFirst"><code>java.lang.String</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFormattedValue(com.djrapitops.plan.delivery.formatting.Formatter)">getFormattedValue</a></span>​(<a href="../../formatting/Formatter.html" title="interface in com.djrapitops.plan.delivery.formatting">Formatter</a><java.lang.Double> formatter)</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="#getGroup()">getGroup</a></span>()</code></th> <td class="colLast"> </td> </tr> <tr id="i5" class="rowColor"> <td class="colFirst"><code>static java.lang.String</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getGroup(double)">getGroup</a></span>​(double value)</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="#getGroup(com.djrapitops.plan.settings.locale.Locale)">getGroup</a></span>​(<a href="../../../settings/locale/Locale.html" title="class in com.djrapitops.plan.settings.locale">Locale</a> locale)</code></th> <td class="colLast"> </td> </tr> <tr id="i7" class="rowColor"> <td class="colFirst"><code>static java.lang.String[]</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getGroups(com.djrapitops.plan.settings.locale.Locale)">getGroups</a></span>​(<a href="../../../settings/locale/Locale.html" title="class in com.djrapitops.plan.settings.locale">Locale</a> locale)</code></th> <td class="colLast"> </td> </tr> <tr id="i8" class="altColor"> <td class="colFirst"><code>double</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getValue()">getValue</a></span>()</code></th> <td class="colLast"> </td> </tr> </table> <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, toString, wait, wait, wait</code></li> </ul> </li> </ul> </section> </li> </ul> </div> <div class="details"> <ul class="blockList"> <li class="blockList"> <!-- ============ FIELD DETAIL =========== --> <section role="region"> <ul class="blockList"> <li class="blockList"><a id="field.detail"> <!-- --> </a> <h3>Field Detail</h3> <a id="VERY_ACTIVE"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>VERY_ACTIVE</h4> <pre>public static final double VERY_ACTIVE</pre> <dl> <dt><span class="seeLabel">See Also:</span></dt> <dd><a href="../../../../../../constant-values.html#com.djrapitops.plan.delivery.domain.mutators.ActivityIndex.VERY_ACTIVE">Constant Field Values</a></dd> </dl> </li> </ul> <a id="ACTIVE"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>ACTIVE</h4> <pre>public static final double ACTIVE</pre> <dl> <dt><span class="seeLabel">See Also:</span></dt> <dd><a href="../../../../../../constant-values.html#com.djrapitops.plan.delivery.domain.mutators.ActivityIndex.ACTIVE">Constant Field Values</a></dd> </dl> </li> </ul> <a id="REGULAR"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>REGULAR</h4> <pre>public static final double REGULAR</pre> <dl> <dt><span class="seeLabel">See Also:</span></dt> <dd><a href="../../../../../../constant-values.html#com.djrapitops.plan.delivery.domain.mutators.ActivityIndex.REGULAR">Constant Field Values</a></dd> </dl> </li> </ul> <a id="IRREGULAR"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>IRREGULAR</h4> <pre>public static final double IRREGULAR</pre> <dl> <dt><span class="seeLabel">See Also:</span></dt> <dd><a href="../../../../../../constant-values.html#com.djrapitops.plan.delivery.domain.mutators.ActivityIndex.IRREGULAR">Constant Field Values</a></dd> </dl> </li> </ul> </li> </ul> </section> <!-- ========= CONSTRUCTOR DETAIL ======== --> <section role="region"> <ul class="blockList"> <li class="blockList"><a id="constructor.detail"> <!-- --> </a> <h3>Constructor Detail</h3> <a id="<init>(com.djrapitops.plan.delivery.domain.container.DataContainer,long,long)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>ActivityIndex</h4> <pre>public ActivityIndex​(<a href="../container/DataContainer.html" title="interface in com.djrapitops.plan.delivery.domain.container">DataContainer</a> container, long date, long playtimeMsThreshold)</pre> </li> </ul> <a id="<init>(java.util.List,long,long)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>ActivityIndex</h4> <pre>public ActivityIndex​(java.util.List<<a href="../../../gathering/domain/FinishedSession.html" title="class in com.djrapitops.plan.gathering.domain">FinishedSession</a>> sessions, long date, long playtimeMsThreshold)</pre> </li> </ul> <a id="<init>(double,long)"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>ActivityIndex</h4> <pre>public ActivityIndex​(double value, long date)</pre> </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="getDefaultGroups()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getDefaultGroups</h4> <pre class="methodSignature">public static java.lang.String[] getDefaultGroups()</pre> </li> </ul> <a id="getGroups(com.djrapitops.plan.settings.locale.Locale)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getGroups</h4> <pre class="methodSignature">public static java.lang.String[] getGroups​(<a href="../../../settings/locale/Locale.html" title="class in com.djrapitops.plan.settings.locale">Locale</a> locale)</pre> </li> </ul> <a id="getValue()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getValue</h4> <pre class="methodSignature">public double getValue()</pre> </li> </ul> <a id="getDate()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getDate</h4> <pre class="methodSignature">public long getDate()</pre> </li> </ul> <a id="getFormattedValue(com.djrapitops.plan.delivery.formatting.Formatter)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getFormattedValue</h4> <pre class="methodSignature">public java.lang.String getFormattedValue​(<a href="../../formatting/Formatter.html" title="interface in com.djrapitops.plan.delivery.formatting">Formatter</a><java.lang.Double> formatter)</pre> </li> </ul> <a id="distance(com.djrapitops.plan.delivery.domain.mutators.ActivityIndex)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>distance</h4> <pre class="methodSignature">public double distance​(<a href="ActivityIndex.html" title="class in com.djrapitops.plan.delivery.domain.mutators">ActivityIndex</a> other)</pre> </li> </ul> <a id="getGroup(double)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getGroup</h4> <pre class="methodSignature">public static java.lang.String getGroup​(double value)</pre> </li> </ul> <a id="getGroup()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getGroup</h4> <pre class="methodSignature">public java.lang.String getGroup()</pre> </li> </ul> <a id="getGroup(com.djrapitops.plan.settings.locale.Locale)"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>getGroup</h4> <pre class="methodSignature">public java.lang.String getGroup​(<a href="../../../settings/locale/Locale.html" title="class in com.djrapitops.plan.settings.locale">Locale</a> locale)</pre> </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="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><a href="#field.summary">Field</a> | </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><a href="#field.detail">Field</a> | </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> </footer> </body> </html>