From 643aab2249992f4c4ad75e98ef3d43f3c6700895 Mon Sep 17 00:00:00 2001 From: Damien Lespiau Date: Thu, 2 Jul 2015 00:16:07 +0100 Subject: 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 --- lib/igt_stats.c | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) (limited to 'lib') 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. -- cgit v1.2.3