http://git-wip-us.apache.org/repos/asf/predictionio-site/blob/0927bfda/api/current/org/apache/predictionio/controller/OptionAverageMetric.html
----------------------------------------------------------------------
diff --git
a/api/current/org/apache/predictionio/controller/OptionAverageMetric.html
b/api/current/org/apache/predictionio/controller/OptionAverageMetric.html
new file mode 100644
index 0000000..40d038e
--- /dev/null
+++ b/api/current/org/apache/predictionio/controller/OptionAverageMetric.html
@@ -0,0 +1,604 @@
+<!DOCTYPE html >
+<html>
+ <head>
+ <title>OptionAverageMetric - PredictionIO Scala API
0.12.0-incubating -
org.apache.predictionio.controller.OptionAverageMetric</title>
+ <meta name="description" content="OptionAverageMetric - PredictionIO
Scala API 0.12.0 - incubating -
org.apache.predictionio.controller.OptionAverageMetric" />
+ <meta name="keywords" content="OptionAverageMetric PredictionIO
Scala API 0.12.0 incubating
org.apache.predictionio.controller.OptionAverageMetric" />
+ <meta http-equiv="content-type" content="text/html; charset=UTF-8" />
+
+ <link href="../../../../lib/template.css" media="screen" type="text/css"
rel="stylesheet" />
+ <link href="../../../../lib/diagrams.css" media="screen" type="text/css"
rel="stylesheet" id="diagrams-css" />
+ <script type="text/javascript" src="../../../../lib/jquery.js"
id="jquery-js"></script>
+ <script type="text/javascript"
src="../../../../lib/jquery-ui.js"></script>
+ <script type="text/javascript"
src="../../../../lib/template.js"></script>
+ <script type="text/javascript"
src="../../../../lib/tools.tooltip.js"></script>
+
+ <script type="text/javascript">
+ if(top === self) {
+ var url = '../../../../index.html';
+ var hash =
'org.apache.predictionio.controller.OptionAverageMetric';
+ var anchor = window.location.hash;
+ var anchor_opt = '';
+ if (anchor.length >= 1)
+ anchor_opt = '@' + anchor.substring(1);
+ window.location.href = url + '#' + hash + anchor_opt;
+ }
+ </script>
+
+ </head>
+ <body class="type">
+ <div id="definition">
+ <img alt="Class" src="../../../../lib/class_big.png" />
+ <p id="owner"><a href="../../../package.html" class="extype"
name="org">org</a>.<a href="../../package.html" class="extype"
name="org.apache">apache</a>.<a href="../package.html" class="extype"
name="org.apache.predictionio">predictionio</a>.<a href="package.html"
class="extype" name="org.apache.predictionio.controller">controller</a></p>
+ <h1>OptionAverageMetric</h1><h3><span class="morelinks"><div>Related
Doc:
+ <a href="package.html" class="extype"
name="org.apache.predictionio.controller">package controller</a>
+ </div></span></h3><span class="permalink">
+ <a
href="../../../../index.html#org.apache.predictionio.controller.OptionAverageMetric"
title="Permalink" target="_top">
+ <img src="../../../../lib/permalink.png" alt="Permalink" />
+ </a>
+ </span>
+ </div>
+
+ <h4 id="signature" class="signature">
+ <span class="modifier_kind">
+ <span class="modifier">abstract </span>
+ <span class="kind">class</span>
+ </span>
+ <span class="symbol">
+ <span class="name">OptionAverageMetric</span><span
class="tparams">[<span name="EI">EI</span>, <span name="Q">Q</span>, <span
name="P">P</span>, <span name="A">A</span>]</span><span class="result"> extends
<a href="Metric.html" class="extype"
name="org.apache.predictionio.controller.Metric">Metric</a>[<span
class="extype"
name="org.apache.predictionio.controller.OptionAverageMetric.EI">EI</span>,
<span class="extype"
name="org.apache.predictionio.controller.OptionAverageMetric.Q">Q</span>, <span
class="extype"
name="org.apache.predictionio.controller.OptionAverageMetric.P">P</span>, <span
class="extype"
name="org.apache.predictionio.controller.OptionAverageMetric.A">A</span>, <a
href="http://www.scala-lang.org/api/2.11.8/index.html#scala.Double"
class="extype" target="_top">Double</a>] with <span class="extype"
name="org.apache.predictionio.controller.StatsOptionMetricHelper">StatsOptionMetricHelper</span>[<span
class="extype" name="org.apache.predictionio.controller.OptionA
verageMetric.EI">EI</span>, <span class="extype"
name="org.apache.predictionio.controller.OptionAverageMetric.Q">Q</span>, <span
class="extype"
name="org.apache.predictionio.controller.OptionAverageMetric.P">P</span>, <span
class="extype"
name="org.apache.predictionio.controller.OptionAverageMetric.A">A</span>] with
<a href="QPAMetric.html" class="extype"
name="org.apache.predictionio.controller.QPAMetric">QPAMetric</a>[<span
class="extype"
name="org.apache.predictionio.controller.OptionAverageMetric.Q">Q</span>, <span
class="extype"
name="org.apache.predictionio.controller.OptionAverageMetric.P">P</span>, <span
class="extype"
name="org.apache.predictionio.controller.OptionAverageMetric.A">A</span>, <a
href="http://www.scala-lang.org/api/2.11.8/index.html#scala.Option"
class="extype" target="_top">Option</a>[<a
href="http://www.scala-lang.org/api/2.11.8/index.html#scala.Double"
class="extype" target="_top">Double</a>]]</span>
+ </span>
+ </h4>
+
+ <div id="comment" class="fullcommenttop"><div class="comment
cmt"><p>Returns the global average of the non-None score returned by the
calculate
+method.
+</p></div><dl class="paramcmts block"><dt class="tparam">EI</dt><dd
class="cmt"><p>Evaluation information</p></dd><dt class="tparam">Q</dt><dd
class="cmt"><p>Query</p></dd><dt class="tparam">P</dt><dd
class="cmt"><p>Predicted result</p></dd><dt class="tparam">A</dt><dd
class="cmt"><p>Actual result</p></dd></dl><div class="toggleContainer block">
+ <span class="toggle">Linear Supertypes</span>
+ <div class="superTypes hiddenContent"><a href="QPAMetric.html"
class="extype"
name="org.apache.predictionio.controller.QPAMetric">QPAMetric</a>[<span
class="extype"
name="org.apache.predictionio.controller.OptionAverageMetric.Q">Q</span>, <span
class="extype"
name="org.apache.predictionio.controller.OptionAverageMetric.P">P</span>, <span
class="extype"
name="org.apache.predictionio.controller.OptionAverageMetric.A">A</span>, <a
href="http://www.scala-lang.org/api/2.11.8/index.html#scala.Option"
class="extype" target="_top">Option</a>[<a
href="http://www.scala-lang.org/api/2.11.8/index.html#scala.Double"
class="extype" target="_top">Double</a>]], <span class="extype"
name="org.apache.predictionio.controller.StatsOptionMetricHelper">StatsOptionMetricHelper</span>[<span
class="extype"
name="org.apache.predictionio.controller.OptionAverageMetric.EI">EI</span>,
<span class="extype"
name="org.apache.predictionio.controller.OptionAverageMetric.Q">Q</span>, <span
class="extype" na
me="org.apache.predictionio.controller.OptionAverageMetric.P">P</span>, <span
class="extype"
name="org.apache.predictionio.controller.OptionAverageMetric.A">A</span>], <a
href="Metric.html" class="extype"
name="org.apache.predictionio.controller.Metric">Metric</a>[<span
class="extype"
name="org.apache.predictionio.controller.OptionAverageMetric.EI">EI</span>,
<span class="extype"
name="org.apache.predictionio.controller.OptionAverageMetric.Q">Q</span>, <span
class="extype"
name="org.apache.predictionio.controller.OptionAverageMetric.P">P</span>, <span
class="extype"
name="org.apache.predictionio.controller.OptionAverageMetric.A">A</span>, <a
href="http://www.scala-lang.org/api/2.11.8/index.html#scala.Double"
class="extype" target="_top">Double</a>], <a
href="http://www.scala-lang.org/api/2.11.8/index.html#scala.Serializable"
class="extype" target="_top">Serializable</a>, <span class="extype"
name="java.io.Serializable">Serializable</span>, <a
href="http://www.scala-lang.org/api/2.11
.8/index.html#scala.AnyRef" class="extype" target="_top">AnyRef</a>, <a
href="http://www.scala-lang.org/api/2.11.8/index.html#scala.Any" class="extype"
target="_top">Any</a></div>
+ </div></div>
+
+
+ <div id="mbrsel">
+ <div id="textfilter"><span class="pre"></span><span
class="input"><input id="mbrsel-input" type="text" accesskey="/" /></span><span
class="post"></span></div>
+ <div id="order">
+ <span class="filtertype">Ordering</span>
+ <ol>
+
+ <li class="alpha in"><span>Alphabetic</span></li>
+ <li class="inherit out"><span>By Inheritance</span></li>
+ </ol>
+ </div>
+ <div id="ancestors">
+ <span class="filtertype">Inherited<br />
+ </span>
+ <ol id="linearization">
+ <li class="in"
name="org.apache.predictionio.controller.OptionAverageMetric"><span>OptionAverageMetric</span></li><li
class="in"
name="org.apache.predictionio.controller.QPAMetric"><span>QPAMetric</span></li><li
class="in"
name="org.apache.predictionio.controller.StatsOptionMetricHelper"><span>StatsOptionMetricHelper</span></li><li
class="in"
name="org.apache.predictionio.controller.Metric"><span>Metric</span></li><li
class="in" name="scala.Serializable"><span>Serializable</span></li><li
class="in" name="java.io.Serializable"><span>Serializable</span></li><li
class="in" name="scala.AnyRef"><span>AnyRef</span></li><li class="in"
name="scala.Any"><span>Any</span></li>
+ </ol>
+ </div><div id="ancestors">
+ <span class="filtertype"></span>
+ <ol>
+ <li class="hideall out"><span>Hide All</span></li>
+ <li class="showall in"><span>Show All</span></li>
+ </ol>
+ </div>
+ <div id="visbl">
+ <span class="filtertype">Visibility</span>
+ <ol><li class="public in"><span>Public</span></li><li class="all
out"><span>All</span></li></ol>
+ </div>
+ </div>
+
+ <div id="template">
+ <div id="allMembers">
+ <div id="constructors" class="members">
+ <h3>Instance Constructors</h3>
+ <ol><li
name="org.apache.predictionio.controller.OptionAverageMetric#<init>"
visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped">
+ <a
id="<init>():org.apache.predictionio.controller.OptionAverageMetric[EI,Q,P,A]"></a>
+ <a id="<init>:OptionAverageMetric[EI,Q,P,A]"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier"></span>
+ <span class="kind">new</span>
+ </span>
+ <span class="symbol">
+ <span class="name">OptionAverageMetric</span><span
class="params">()</span>
+ </span>
+ </h4><span class="permalink">
+ <a
href="../../../../index.html#org.apache.predictionio.controller.OptionAverageMetric@<init>():org.apache.predictionio.controller.OptionAverageMetric[EI,Q,P,A]"
title="Permalink" target="_top">
+ <img src="../../../../lib/permalink.png" alt="Permalink" />
+ </a>
+ </span>
+ <p class="shortcomment cmt"></p>
+ </li></ol>
+ </div>
+
+
+
+ <div id="values" class="values members">
+ <h3>Abstract Value Members</h3>
+ <ol><li
name="org.apache.predictionio.controller.OptionAverageMetric#calculate"
visbl="pub" data-isabs="true" fullComment="yes" group="Ungrouped">
+ <a id="calculate(q:Q,p:P,a:A):Option[Double]"></a>
+ <a id="calculate(Q,P,A):Option[Double]"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier">abstract </span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span class="name">calculate</span><span class="params">(<span
name="q">q: <span class="extype"
name="org.apache.predictionio.controller.OptionAverageMetric.Q">Q</span></span>,
<span name="p">p: <span class="extype"
name="org.apache.predictionio.controller.OptionAverageMetric.P">P</span></span>,
<span name="a">a: <span class="extype"
name="org.apache.predictionio.controller.OptionAverageMetric.A">A</span></span>)</span><span
class="result">: <a
href="http://www.scala-lang.org/api/2.11.8/index.html#scala.Option"
class="extype" target="_top">Option</a>[<a
href="http://www.scala-lang.org/api/2.11.8/index.html#scala.Double"
class="extype" target="_top">Double</a>]</span>
+ </span>
+ </h4><span class="permalink">
+ <a
href="../../../../index.html#org.apache.predictionio.controller.OptionAverageMetric@calculate(q:Q,p:P,a:A):Option[Double]"
title="Permalink" target="_top">
+ <img src="../../../../lib/permalink.png" alt="Permalink" />
+ </a>
+ </span>
+ <p class="shortcomment cmt">Implement this method to return a score that
will be used for averaging
+across all QPA tuples.</p><div class="fullcomment"><div class="comment
cmt"><p>Implement this method to return a score that will be used for averaging
+across all QPA tuples.</p></div><dl class="paramcmts block"><dt
class="param">q</dt><dd class="cmt"><p>Query</p></dd><dt
class="param">p</dt><dd class="cmt"><p>Predicted result</p></dd><dt
class="param">a</dt><dd class="cmt"><p>Actual
result</p></dd><dt>returns</dt><dd class="cmt"><p>Metric
result</p></dd></dl><dl class="attributes block"> <dt>Definition
Classes</dt><dd><a href="" class="extype"
name="org.apache.predictionio.controller.OptionAverageMetric">OptionAverageMetric</a>
â <a href="QPAMetric.html" class="extype"
name="org.apache.predictionio.controller.QPAMetric">QPAMetric</a> â
StatsOptionMetricHelper</dd></dl></div>
+ </li></ol>
+ </div>
+
+ <div id="values" class="values members">
+ <h3>Concrete Value Members</h3>
+ <ol><li name="scala.AnyRef#!=" visbl="pub" data-isabs="false"
fullComment="yes" group="Ungrouped">
+ <a id="!=(x$1:Any):Boolean"></a>
+ <a id="!=(Any):Boolean"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier">final </span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span title="gt4s: $bang$eq" class="name">!=</span><span
class="params">(<span name="arg0">arg0: <a
href="http://www.scala-lang.org/api/2.11.8/index.html#scala.Any" class="extype"
target="_top">Any</a></span>)</span><span class="result">: <a
href="http://www.scala-lang.org/api/2.11.8/index.html#scala.Boolean"
class="extype" target="_top">Boolean</a></span>
+ </span>
+ </h4><span class="permalink">
+ <a
href="../../../../index.html#org.apache.predictionio.controller.OptionAverageMetric@!=(x$1:Any):Boolean"
title="Permalink" target="_top">
+ <img src="../../../../lib/permalink.png" alt="Permalink" />
+ </a>
+ </span>
+ <div class="fullcomment"><dl class="attributes block"> <dt>Definition
Classes</dt><dd>AnyRef â Any</dd></dl></div>
+ </li><li name="scala.AnyRef###" visbl="pub" data-isabs="false"
fullComment="yes" group="Ungrouped">
+ <a id="##():Int"></a>
+ <a id="##():Int"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier">final </span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span title="gt4s: $hash$hash" class="name">##</span><span
class="params">()</span><span class="result">: <a
href="http://www.scala-lang.org/api/2.11.8/index.html#scala.Int" class="extype"
target="_top">Int</a></span>
+ </span>
+ </h4><span class="permalink">
+ <a
href="../../../../index.html#org.apache.predictionio.controller.OptionAverageMetric@##():Int"
title="Permalink" target="_top">
+ <img src="../../../../lib/permalink.png" alt="Permalink" />
+ </a>
+ </span>
+ <div class="fullcomment"><dl class="attributes block"> <dt>Definition
Classes</dt><dd>AnyRef â Any</dd></dl></div>
+ </li><li name="scala.AnyRef#==" visbl="pub" data-isabs="false"
fullComment="yes" group="Ungrouped">
+ <a id="==(x$1:Any):Boolean"></a>
+ <a id="==(Any):Boolean"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier">final </span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span title="gt4s: $eq$eq" class="name">==</span><span
class="params">(<span name="arg0">arg0: <a
href="http://www.scala-lang.org/api/2.11.8/index.html#scala.Any" class="extype"
target="_top">Any</a></span>)</span><span class="result">: <a
href="http://www.scala-lang.org/api/2.11.8/index.html#scala.Boolean"
class="extype" target="_top">Boolean</a></span>
+ </span>
+ </h4><span class="permalink">
+ <a
href="../../../../index.html#org.apache.predictionio.controller.OptionAverageMetric@==(x$1:Any):Boolean"
title="Permalink" target="_top">
+ <img src="../../../../lib/permalink.png" alt="Permalink" />
+ </a>
+ </span>
+ <div class="fullcomment"><dl class="attributes block"> <dt>Definition
Classes</dt><dd>AnyRef â Any</dd></dl></div>
+ </li><li name="scala.Any#asInstanceOf" visbl="pub" data-isabs="false"
fullComment="yes" group="Ungrouped">
+ <a id="asInstanceOf[T0]:T0"></a>
+ <a id="asInstanceOf[T0]:T0"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier">final </span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span class="name">asInstanceOf</span><span class="tparams">[<span
name="T0">T0</span>]</span><span class="result">: <span class="extype"
name="scala.Any.asInstanceOf.T0">T0</span></span>
+ </span>
+ </h4><span class="permalink">
+ <a
href="../../../../index.html#org.apache.predictionio.controller.OptionAverageMetric@asInstanceOf[T0]:T0"
title="Permalink" target="_top">
+ <img src="../../../../lib/permalink.png" alt="Permalink" />
+ </a>
+ </span>
+ <div class="fullcomment"><dl class="attributes block"> <dt>Definition
Classes</dt><dd>Any</dd></dl></div>
+ </li><li
name="org.apache.predictionio.controller.OptionAverageMetric#calculate"
visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
+ <a
id="calculate(sc:org.apache.spark.SparkContext,evalDataSet:Seq[(EI,org.apache.spark.rdd.RDD[(Q,P,A)])]):Double"></a>
+ <a id="calculate(SparkContext,Seq[(EI,RDD[(Q,P,A)])]):Double"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier"></span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span class="name">calculate</span><span class="params">(<span
name="sc">sc: <span class="extype"
name="org.apache.spark.SparkContext">SparkContext</span></span>, <span
name="evalDataSet">evalDataSet: <span class="extype"
name="scala.Seq">Seq</span>[(<span class="extype"
name="org.apache.predictionio.controller.OptionAverageMetric.EI">EI</span>,
<span class="extype" name="org.apache.spark.rdd.RDD">RDD</span>[(<span
class="extype"
name="org.apache.predictionio.controller.OptionAverageMetric.Q">Q</span>, <span
class="extype"
name="org.apache.predictionio.controller.OptionAverageMetric.P">P</span>, <span
class="extype"
name="org.apache.predictionio.controller.OptionAverageMetric.A">A</span>)])]</span>)</span><span
class="result">: <a
href="http://www.scala-lang.org/api/2.11.8/index.html#scala.Double"
class="extype" target="_top">Double</a></span>
+ </span>
+ </h4><span class="permalink">
+ <a
href="../../../../index.html#org.apache.predictionio.controller.OptionAverageMetric@calculate(sc:org.apache.spark.SparkContext,evalDataSet:Seq[(EI,org.apache.spark.rdd.RDD[(Q,P,A)])]):Double"
title="Permalink" target="_top">
+ <img src="../../../../lib/permalink.png" alt="Permalink" />
+ </a>
+ </span>
+ <p class="shortcomment cmt">Calculates the result of this <a
href="Metric.html" class="extype"
name="org.apache.predictionio.controller.Metric">Metric</a>.</p><div
class="fullcomment"><div class="comment cmt"><p>Calculates the result of this
<a href="Metric.html" class="extype"
name="org.apache.predictionio.controller.Metric">Metric</a>.</p></div><dl
class="attributes block"> <dt>Definition Classes</dt><dd><a href=""
class="extype"
name="org.apache.predictionio.controller.OptionAverageMetric">OptionAverageMetric</a>
â <a href="Metric.html" class="extype"
name="org.apache.predictionio.controller.Metric">Metric</a></dd></dl></div>
+ </li><li
name="org.apache.predictionio.controller.StatsOptionMetricHelper#calculateStats"
visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
+ <a
id="calculateStats(sc:org.apache.spark.SparkContext,evalDataSet:Seq[(EI,org.apache.spark.rdd.RDD[(Q,P,A)])]):org.apache.spark.util.StatCounter"></a>
+ <a
id="calculateStats(SparkContext,Seq[(EI,RDD[(Q,P,A)])]):StatCounter"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier"></span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span class="name">calculateStats</span><span class="params">(<span
name="sc">sc: <span class="extype"
name="org.apache.spark.SparkContext">SparkContext</span></span>, <span
name="evalDataSet">evalDataSet: <span class="extype"
name="scala.Seq">Seq</span>[(<span class="extype"
name="org.apache.predictionio.controller.OptionAverageMetric.EI">EI</span>,
<span class="extype" name="org.apache.spark.rdd.RDD">RDD</span>[(<span
class="extype"
name="org.apache.predictionio.controller.OptionAverageMetric.Q">Q</span>, <span
class="extype"
name="org.apache.predictionio.controller.OptionAverageMetric.P">P</span>, <span
class="extype"
name="org.apache.predictionio.controller.OptionAverageMetric.A">A</span>)])]</span>)</span><span
class="result">: <span class="extype"
name="org.apache.spark.util.StatCounter">StatCounter</span></span>
+ </span>
+ </h4><span class="permalink">
+ <a
href="../../../../index.html#org.apache.predictionio.controller.OptionAverageMetric@calculateStats(sc:org.apache.spark.SparkContext,evalDataSet:Seq[(EI,org.apache.spark.rdd.RDD[(Q,P,A)])]):org.apache.spark.util.StatCounter"
title="Permalink" target="_top">
+ <img src="../../../../lib/permalink.png" alt="Permalink" />
+ </a>
+ </span>
+ <div class="fullcomment"><dl class="attributes block"> <dt>Definition
Classes</dt><dd>StatsOptionMetricHelper</dd></dl></div>
+ </li><li name="scala.AnyRef#clone" visbl="prt" data-isabs="false"
fullComment="yes" group="Ungrouped">
+ <a id="clone():Object"></a>
+ <a id="clone():AnyRef"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier"></span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span class="name">clone</span><span class="params">()</span><span
class="result">: <a
href="http://www.scala-lang.org/api/2.11.8/index.html#scala.AnyRef"
class="extype" target="_top">AnyRef</a></span>
+ </span>
+ </h4><span class="permalink">
+ <a
href="../../../../index.html#org.apache.predictionio.controller.OptionAverageMetric@clone():Object"
title="Permalink" target="_top">
+ <img src="../../../../lib/permalink.png" alt="Permalink" />
+ </a>
+ </span>
+ <div class="fullcomment"><dl class="attributes block">
<dt>Attributes</dt><dd>protected[<a href="../../../../java$lang.html"
class="extype" name="java.lang">java.lang</a>] </dd><dt>Definition
Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd>
+ <span class="name">@throws</span><span class="args">(<span>
+
+ <span class="defval"
name="classOf[java.lang.CloneNotSupportedException]">...</span>
+ </span>)</span>
+
+ </dd></dl></div>
+ </li><li name="org.apache.predictionio.controller.Metric#compare"
visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
+ <a id="compare(r0:R,r1:R):Int"></a>
+ <a id="compare(Double,Double):Int"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier"></span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span class="name">compare</span><span class="params">(<span
name="r0">r0: <a
href="http://www.scala-lang.org/api/2.11.8/index.html#scala.Double"
class="extype" target="_top">Double</a></span>, <span name="r1">r1: <a
href="http://www.scala-lang.org/api/2.11.8/index.html#scala.Double"
class="extype" target="_top">Double</a></span>)</span><span class="result">: <a
href="http://www.scala-lang.org/api/2.11.8/index.html#scala.Int" class="extype"
target="_top">Int</a></span>
+ </span>
+ </h4><span class="permalink">
+ <a
href="../../../../index.html#org.apache.predictionio.controller.OptionAverageMetric@compare(r0:R,r1:R):Int"
title="Permalink" target="_top">
+ <img src="../../../../lib/permalink.png" alt="Permalink" />
+ </a>
+ </span>
+ <p class="shortcomment cmt">Comparison function for R's
ordering.</p><div class="fullcomment"><div class="comment cmt"><p>Comparison
function for R's ordering.</p></div><dl class="attributes block">
<dt>Definition Classes</dt><dd><a href="Metric.html" class="extype"
name="org.apache.predictionio.controller.Metric">Metric</a></dd></dl></div>
+ </li><li name="scala.AnyRef#eq" visbl="pub" data-isabs="false"
fullComment="yes" group="Ungrouped">
+ <a id="eq(x$1:AnyRef):Boolean"></a>
+ <a id="eq(AnyRef):Boolean"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier">final </span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span class="name">eq</span><span class="params">(<span
name="arg0">arg0: <a
href="http://www.scala-lang.org/api/2.11.8/index.html#scala.AnyRef"
class="extype" target="_top">AnyRef</a></span>)</span><span class="result">: <a
href="http://www.scala-lang.org/api/2.11.8/index.html#scala.Boolean"
class="extype" target="_top">Boolean</a></span>
+ </span>
+ </h4><span class="permalink">
+ <a
href="../../../../index.html#org.apache.predictionio.controller.OptionAverageMetric@eq(x$1:AnyRef):Boolean"
title="Permalink" target="_top">
+ <img src="../../../../lib/permalink.png" alt="Permalink" />
+ </a>
+ </span>
+ <div class="fullcomment"><dl class="attributes block"> <dt>Definition
Classes</dt><dd>AnyRef</dd></dl></div>
+ </li><li name="scala.AnyRef#equals" visbl="pub" data-isabs="false"
fullComment="yes" group="Ungrouped">
+ <a id="equals(x$1:Any):Boolean"></a>
+ <a id="equals(Any):Boolean"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier"></span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span class="name">equals</span><span class="params">(<span
name="arg0">arg0: <a
href="http://www.scala-lang.org/api/2.11.8/index.html#scala.Any" class="extype"
target="_top">Any</a></span>)</span><span class="result">: <a
href="http://www.scala-lang.org/api/2.11.8/index.html#scala.Boolean"
class="extype" target="_top">Boolean</a></span>
+ </span>
+ </h4><span class="permalink">
+ <a
href="../../../../index.html#org.apache.predictionio.controller.OptionAverageMetric@equals(x$1:Any):Boolean"
title="Permalink" target="_top">
+ <img src="../../../../lib/permalink.png" alt="Permalink" />
+ </a>
+ </span>
+ <div class="fullcomment"><dl class="attributes block"> <dt>Definition
Classes</dt><dd>AnyRef â Any</dd></dl></div>
+ </li><li name="scala.AnyRef#finalize" visbl="prt" data-isabs="false"
fullComment="yes" group="Ungrouped">
+ <a id="finalize():Unit"></a>
+ <a id="finalize():Unit"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier"></span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span class="name">finalize</span><span class="params">()</span><span
class="result">: <a
href="http://www.scala-lang.org/api/2.11.8/index.html#scala.Unit"
class="extype" target="_top">Unit</a></span>
+ </span>
+ </h4><span class="permalink">
+ <a
href="../../../../index.html#org.apache.predictionio.controller.OptionAverageMetric@finalize():Unit"
title="Permalink" target="_top">
+ <img src="../../../../lib/permalink.png" alt="Permalink" />
+ </a>
+ </span>
+ <div class="fullcomment"><dl class="attributes block">
<dt>Attributes</dt><dd>protected[<a href="../../../../java$lang.html"
class="extype" name="java.lang">java.lang</a>] </dd><dt>Definition
Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd>
+ <span class="name">@throws</span><span class="args">(<span>
+
+ <span class="symbol">classOf[java.lang.Throwable]</span>
+ </span>)</span>
+
+ </dd></dl></div>
+ </li><li name="scala.AnyRef#getClass" visbl="pub" data-isabs="false"
fullComment="yes" group="Ungrouped">
+ <a id="getClass():Class[_]"></a>
+ <a id="getClass():Class[_]"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier">final </span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span class="name">getClass</span><span class="params">()</span><span
class="result">: <span class="extype"
name="java.lang.Class">Class</span>[_]</span>
+ </span>
+ </h4><span class="permalink">
+ <a
href="../../../../index.html#org.apache.predictionio.controller.OptionAverageMetric@getClass():Class[_]"
title="Permalink" target="_top">
+ <img src="../../../../lib/permalink.png" alt="Permalink" />
+ </a>
+ </span>
+ <div class="fullcomment"><dl class="attributes block"> <dt>Definition
Classes</dt><dd>AnyRef â Any</dd></dl></div>
+ </li><li name="scala.AnyRef#hashCode" visbl="pub" data-isabs="false"
fullComment="yes" group="Ungrouped">
+ <a id="hashCode():Int"></a>
+ <a id="hashCode():Int"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier"></span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span class="name">hashCode</span><span class="params">()</span><span
class="result">: <a
href="http://www.scala-lang.org/api/2.11.8/index.html#scala.Int" class="extype"
target="_top">Int</a></span>
+ </span>
+ </h4><span class="permalink">
+ <a
href="../../../../index.html#org.apache.predictionio.controller.OptionAverageMetric@hashCode():Int"
title="Permalink" target="_top">
+ <img src="../../../../lib/permalink.png" alt="Permalink" />
+ </a>
+ </span>
+ <div class="fullcomment"><dl class="attributes block"> <dt>Definition
Classes</dt><dd>AnyRef â Any</dd></dl></div>
+ </li><li name="org.apache.predictionio.controller.Metric#header"
visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
+ <a id="header:String"></a>
+ <a id="header:String"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier"></span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span class="name">header</span><span class="result">: <span
class="extype" name="scala.Predef.String">String</span></span>
+ </span>
+ </h4><span class="permalink">
+ <a
href="../../../../index.html#org.apache.predictionio.controller.OptionAverageMetric@header:String"
title="Permalink" target="_top">
+ <img src="../../../../lib/permalink.png" alt="Permalink" />
+ </a>
+ </span>
+ <p class="shortcomment cmt">Class name of this <a href="Metric.html"
class="extype"
name="org.apache.predictionio.controller.Metric">Metric</a>.</p><div
class="fullcomment"><div class="comment cmt"><p>Class name of this <a
href="Metric.html" class="extype"
name="org.apache.predictionio.controller.Metric">Metric</a>.</p></div><dl
class="attributes block"> <dt>Definition Classes</dt><dd><a href="Metric.html"
class="extype"
name="org.apache.predictionio.controller.Metric">Metric</a></dd></dl></div>
+ </li><li name="scala.Any#isInstanceOf" visbl="pub" data-isabs="false"
fullComment="yes" group="Ungrouped">
+ <a id="isInstanceOf[T0]:Boolean"></a>
+ <a id="isInstanceOf[T0]:Boolean"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier">final </span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span class="name">isInstanceOf</span><span class="tparams">[<span
name="T0">T0</span>]</span><span class="result">: <a
href="http://www.scala-lang.org/api/2.11.8/index.html#scala.Boolean"
class="extype" target="_top">Boolean</a></span>
+ </span>
+ </h4><span class="permalink">
+ <a
href="../../../../index.html#org.apache.predictionio.controller.OptionAverageMetric@isInstanceOf[T0]:Boolean"
title="Permalink" target="_top">
+ <img src="../../../../lib/permalink.png" alt="Permalink" />
+ </a>
+ </span>
+ <div class="fullcomment"><dl class="attributes block"> <dt>Definition
Classes</dt><dd>Any</dd></dl></div>
+ </li><li name="scala.AnyRef#ne" visbl="pub" data-isabs="false"
fullComment="yes" group="Ungrouped">
+ <a id="ne(x$1:AnyRef):Boolean"></a>
+ <a id="ne(AnyRef):Boolean"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier">final </span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span class="name">ne</span><span class="params">(<span
name="arg0">arg0: <a
href="http://www.scala-lang.org/api/2.11.8/index.html#scala.AnyRef"
class="extype" target="_top">AnyRef</a></span>)</span><span class="result">: <a
href="http://www.scala-lang.org/api/2.11.8/index.html#scala.Boolean"
class="extype" target="_top">Boolean</a></span>
+ </span>
+ </h4><span class="permalink">
+ <a
href="../../../../index.html#org.apache.predictionio.controller.OptionAverageMetric@ne(x$1:AnyRef):Boolean"
title="Permalink" target="_top">
+ <img src="../../../../lib/permalink.png" alt="Permalink" />
+ </a>
+ </span>
+ <div class="fullcomment"><dl class="attributes block"> <dt>Definition
Classes</dt><dd>AnyRef</dd></dl></div>
+ </li><li name="scala.AnyRef#notify" visbl="pub" data-isabs="false"
fullComment="yes" group="Ungrouped">
+ <a id="notify():Unit"></a>
+ <a id="notify():Unit"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier">final </span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span class="name">notify</span><span class="params">()</span><span
class="result">: <a
href="http://www.scala-lang.org/api/2.11.8/index.html#scala.Unit"
class="extype" target="_top">Unit</a></span>
+ </span>
+ </h4><span class="permalink">
+ <a
href="../../../../index.html#org.apache.predictionio.controller.OptionAverageMetric@notify():Unit"
title="Permalink" target="_top">
+ <img src="../../../../lib/permalink.png" alt="Permalink" />
+ </a>
+ </span>
+ <div class="fullcomment"><dl class="attributes block"> <dt>Definition
Classes</dt><dd>AnyRef</dd></dl></div>
+ </li><li name="scala.AnyRef#notifyAll" visbl="pub" data-isabs="false"
fullComment="yes" group="Ungrouped">
+ <a id="notifyAll():Unit"></a>
+ <a id="notifyAll():Unit"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier">final </span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span class="name">notifyAll</span><span class="params">()</span><span
class="result">: <a
href="http://www.scala-lang.org/api/2.11.8/index.html#scala.Unit"
class="extype" target="_top">Unit</a></span>
+ </span>
+ </h4><span class="permalink">
+ <a
href="../../../../index.html#org.apache.predictionio.controller.OptionAverageMetric@notifyAll():Unit"
title="Permalink" target="_top">
+ <img src="../../../../lib/permalink.png" alt="Permalink" />
+ </a>
+ </span>
+ <div class="fullcomment"><dl class="attributes block"> <dt>Definition
Classes</dt><dd>AnyRef</dd></dl></div>
+ </li><li name="scala.AnyRef#synchronized" visbl="pub" data-isabs="false"
fullComment="yes" group="Ungrouped">
+ <a id="synchronized[T0](x$1:=>T0):T0"></a>
+ <a id="synchronized[T0](âT0):T0"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier">final </span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span class="name">synchronized</span><span class="tparams">[<span
name="T0">T0</span>]</span><span class="params">(<span name="arg0">arg0: â
<span class="extype"
name="java.lang.AnyRef.synchronized.T0">T0</span></span>)</span><span
class="result">: <span class="extype"
name="java.lang.AnyRef.synchronized.T0">T0</span></span>
+ </span>
+ </h4><span class="permalink">
+ <a
href="../../../../index.html#org.apache.predictionio.controller.OptionAverageMetric@synchronized[T0](x$1:=>T0):T0"
title="Permalink" target="_top">
+ <img src="../../../../lib/permalink.png" alt="Permalink" />
+ </a>
+ </span>
+ <div class="fullcomment"><dl class="attributes block"> <dt>Definition
Classes</dt><dd>AnyRef</dd></dl></div>
+ </li><li name="scala.AnyRef#toString" visbl="pub" data-isabs="false"
fullComment="yes" group="Ungrouped">
+ <a id="toString():String"></a>
+ <a id="toString():String"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier"></span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span class="name">toString</span><span class="params">()</span><span
class="result">: <span class="extype"
name="java.lang.String">String</span></span>
+ </span>
+ </h4><span class="permalink">
+ <a
href="../../../../index.html#org.apache.predictionio.controller.OptionAverageMetric@toString():String"
title="Permalink" target="_top">
+ <img src="../../../../lib/permalink.png" alt="Permalink" />
+ </a>
+ </span>
+ <div class="fullcomment"><dl class="attributes block"> <dt>Definition
Classes</dt><dd>AnyRef â Any</dd></dl></div>
+ </li><li name="scala.AnyRef#wait" visbl="pub" data-isabs="false"
fullComment="yes" group="Ungrouped">
+ <a id="wait():Unit"></a>
+ <a id="wait():Unit"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier">final </span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span class="name">wait</span><span class="params">()</span><span
class="result">: <a
href="http://www.scala-lang.org/api/2.11.8/index.html#scala.Unit"
class="extype" target="_top">Unit</a></span>
+ </span>
+ </h4><span class="permalink">
+ <a
href="../../../../index.html#org.apache.predictionio.controller.OptionAverageMetric@wait():Unit"
title="Permalink" target="_top">
+ <img src="../../../../lib/permalink.png" alt="Permalink" />
+ </a>
+ </span>
+ <div class="fullcomment"><dl class="attributes block"> <dt>Definition
Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd>
+ <span class="name">@throws</span><span class="args">(<span>
+
+ <span class="defval"
name="classOf[java.lang.InterruptedException]">...</span>
+ </span>)</span>
+
+ </dd></dl></div>
+ </li><li name="scala.AnyRef#wait" visbl="pub" data-isabs="false"
fullComment="yes" group="Ungrouped">
+ <a id="wait(x$1:Long,x$2:Int):Unit"></a>
+ <a id="wait(Long,Int):Unit"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier">final </span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span class="name">wait</span><span class="params">(<span
name="arg0">arg0: <a
href="http://www.scala-lang.org/api/2.11.8/index.html#scala.Long"
class="extype" target="_top">Long</a></span>, <span name="arg1">arg1: <a
href="http://www.scala-lang.org/api/2.11.8/index.html#scala.Int" class="extype"
target="_top">Int</a></span>)</span><span class="result">: <a
href="http://www.scala-lang.org/api/2.11.8/index.html#scala.Unit"
class="extype" target="_top">Unit</a></span>
+ </span>
+ </h4><span class="permalink">
+ <a
href="../../../../index.html#org.apache.predictionio.controller.OptionAverageMetric@wait(x$1:Long,x$2:Int):Unit"
title="Permalink" target="_top">
+ <img src="../../../../lib/permalink.png" alt="Permalink" />
+ </a>
+ </span>
+ <div class="fullcomment"><dl class="attributes block"> <dt>Definition
Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd>
+ <span class="name">@throws</span><span class="args">(<span>
+
+ <span class="defval"
name="classOf[java.lang.InterruptedException]">...</span>
+ </span>)</span>
+
+ </dd></dl></div>
+ </li><li name="scala.AnyRef#wait" visbl="pub" data-isabs="false"
fullComment="yes" group="Ungrouped">
+ <a id="wait(x$1:Long):Unit"></a>
+ <a id="wait(Long):Unit"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier">final </span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span class="name">wait</span><span class="params">(<span
name="arg0">arg0: <a
href="http://www.scala-lang.org/api/2.11.8/index.html#scala.Long"
class="extype" target="_top">Long</a></span>)</span><span class="result">: <a
href="http://www.scala-lang.org/api/2.11.8/index.html#scala.Unit"
class="extype" target="_top">Unit</a></span>
+ </span>
+ </h4><span class="permalink">
+ <a
href="../../../../index.html#org.apache.predictionio.controller.OptionAverageMetric@wait(x$1:Long):Unit"
title="Permalink" target="_top">
+ <img src="../../../../lib/permalink.png" alt="Permalink" />
+ </a>
+ </span>
+ <div class="fullcomment"><dl class="attributes block"> <dt>Definition
Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd>
+ <span class="name">@throws</span><span class="args">(<span>
+
+ <span class="defval"
name="classOf[java.lang.InterruptedException]">...</span>
+ </span>)</span>
+
+ </dd></dl></div>
+ </li></ol>
+ </div>
+
+
+
+
+ </div>
+
+ <div id="inheritedMembers">
+ <div class="parent"
name="org.apache.predictionio.controller.QPAMetric">
+ <h3>Inherited from <a href="QPAMetric.html" class="extype"
name="org.apache.predictionio.controller.QPAMetric">QPAMetric</a>[<span
class="extype"
name="org.apache.predictionio.controller.OptionAverageMetric.Q">Q</span>, <span
class="extype"
name="org.apache.predictionio.controller.OptionAverageMetric.P">P</span>, <span
class="extype"
name="org.apache.predictionio.controller.OptionAverageMetric.A">A</span>, <a
href="http://www.scala-lang.org/api/2.11.8/index.html#scala.Option"
class="extype" target="_top">Option</a>[<a
href="http://www.scala-lang.org/api/2.11.8/index.html#scala.Double"
class="extype" target="_top">Double</a>]]</h3>
+ </div><div class="parent"
name="org.apache.predictionio.controller.StatsOptionMetricHelper">
+ <h3>Inherited from <span class="extype"
name="org.apache.predictionio.controller.StatsOptionMetricHelper">StatsOptionMetricHelper</span>[<span
class="extype"
name="org.apache.predictionio.controller.OptionAverageMetric.EI">EI</span>,
<span class="extype"
name="org.apache.predictionio.controller.OptionAverageMetric.Q">Q</span>, <span
class="extype"
name="org.apache.predictionio.controller.OptionAverageMetric.P">P</span>, <span
class="extype"
name="org.apache.predictionio.controller.OptionAverageMetric.A">A</span>]</h3>
+ </div><div class="parent"
name="org.apache.predictionio.controller.Metric">
+ <h3>Inherited from <a href="Metric.html" class="extype"
name="org.apache.predictionio.controller.Metric">Metric</a>[<span
class="extype"
name="org.apache.predictionio.controller.OptionAverageMetric.EI">EI</span>,
<span class="extype"
name="org.apache.predictionio.controller.OptionAverageMetric.Q">Q</span>, <span
class="extype"
name="org.apache.predictionio.controller.OptionAverageMetric.P">P</span>, <span
class="extype"
name="org.apache.predictionio.controller.OptionAverageMetric.A">A</span>, <a
href="http://www.scala-lang.org/api/2.11.8/index.html#scala.Double"
class="extype" target="_top">Double</a>]</h3>
+ </div><div class="parent" name="scala.Serializable">
+ <h3>Inherited from <a
href="http://www.scala-lang.org/api/2.11.8/index.html#scala.Serializable"
class="extype" target="_top">Serializable</a></h3>
+ </div><div class="parent" name="java.io.Serializable">
+ <h3>Inherited from <span class="extype"
name="java.io.Serializable">Serializable</span></h3>
+ </div><div class="parent" name="scala.AnyRef">
+ <h3>Inherited from <a
href="http://www.scala-lang.org/api/2.11.8/index.html#scala.AnyRef"
class="extype" target="_top">AnyRef</a></h3>
+ </div><div class="parent" name="scala.Any">
+ <h3>Inherited from <a
href="http://www.scala-lang.org/api/2.11.8/index.html#scala.Any" class="extype"
target="_top">Any</a></h3>
+ </div>
+
+ </div>
+
+ <div id="groupedMembers">
+ <div class="group" name="Ungrouped">
+ <h3>Ungrouped</h3>
+
+ </div>
+ </div>
+
+ </div>
+
+ <div id="tooltip"></div>
+
+ <div id="footer"> </div>
+
+
+ </body>
+ </html>