summaryrefslogtreecommitdiff
path: root/lib/igt_stats.c
diff options
context:
space:
mode:
authorDamien Lespiau <damien.lespiau@intel.com>2015-07-02 00:16:07 +0100
committerDamien Lespiau <damien.lespiau@intel.com>2015-07-02 11:20:42 +0100
commit643aab2249992f4c4ad75e98ef3d43f3c6700895 (patch)
treecb1872a16925e0464833f6f4ab7538ec675681c5 /lib/igt_stats.c
parentd01ebbd97ddb323564c75bfaaa374011fde4cd38 (diff)
stats: Add wikipedia links to get_trimean() and get_iqm()
Useful knowledge for anyone looking at the documentation and following the linkes. Signed-off-by: Damien Lespiau <damien.lespiau@intel.com>
Diffstat (limited to 'lib/igt_stats.c')
-rw-r--r--lib/igt_stats.c9
1 files changed, 7 insertions, 2 deletions
diff --git a/lib/igt_stats.c b/lib/igt_stats.c
index b7053c3c..70650ec7 100644
--- a/lib/igt_stats.c
+++ b/lib/igt_stats.c
@@ -496,11 +496,15 @@ double igt_stats_get_std_deviation(igt_stats_t *stats)
* igt_stats_get_iqm:
* @stats: An #igt_stats_t instance
*
- * Retrieves the interquartile mean of the @stats dataset.
+ * Retrieves the
+ * [interquartile mean](https://en.wikipedia.org/wiki/Interquartile_mean) (IQM)
+ * of the @stats dataset.
*
* The interquartile mean is a "statistical measure of central tendency".
* It is a truncated mean that discards the lowest and highest 25% of values,
* and calculates the mean value of the remaining central values.
+ *
+ * It's useful to hide outliers in measurements (due to cold cache etc).
*/
double igt_stats_get_iqm(igt_stats_t *stats)
{
@@ -533,7 +537,8 @@ double igt_stats_get_iqm(igt_stats_t *stats)
* igt_stats_get_trimean:
* @stats: An #igt_stats_t instance
*
- * Retrieves the trimean of the @stats dataset.
+ * Retrieves the [trimean](https://en.wikipedia.org/wiki/Trimean) of the @stats
+ * dataset.
*
* The trimean is a the most efficient 3-point L-estimator, even more
* robust than the median at estimating the average of a sample population.