From patchwork Wed Jul 1 23:21:40 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Lespiau, Damien" X-Patchwork-Id: 6707061 Return-Path: X-Original-To: patchwork-intel-gfx@patchwork.kernel.org Delivered-To: patchwork-parsemail@patchwork2.web.kernel.org Received: from mail.kernel.org (mail.kernel.org [198.145.29.136]) by patchwork2.web.kernel.org (Postfix) with ESMTP id 68C57C05AC for ; Wed, 1 Jul 2015 23:21:50 +0000 (UTC) Received: from mail.kernel.org (localhost [127.0.0.1]) by mail.kernel.org (Postfix) with ESMTP id A1DF120708 for ; Wed, 1 Jul 2015 23:21:49 +0000 (UTC) Received: from gabe.freedesktop.org (gabe.freedesktop.org [131.252.210.177]) by mail.kernel.org (Postfix) with ESMTP id 8D846206BE for ; Wed, 1 Jul 2015 23:21:48 +0000 (UTC) Received: from gabe.freedesktop.org (localhost [127.0.0.1]) by gabe.freedesktop.org (Postfix) with ESMTP id DF8266EBFE; Wed, 1 Jul 2015 16:21:47 -0700 (PDT) X-Original-To: intel-gfx@lists.freedesktop.org Delivered-To: intel-gfx@lists.freedesktop.org Received: from mga01.intel.com (mga01.intel.com [192.55.52.88]) by gabe.freedesktop.org (Postfix) with ESMTP id F15486EBFE for ; Wed, 1 Jul 2015 16:21:45 -0700 (PDT) Received: from orsmga002.jf.intel.com ([10.7.209.21]) by fmsmga101.fm.intel.com with ESMTP; 01 Jul 2015 16:21:45 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.15,389,1432623600"; d="scan'208";a="756864271" Received: from oritm-mobl2.ger.corp.intel.com (HELO strange.ger.corp.intel.com) ([10.252.17.214]) by orsmga002.jf.intel.com with ESMTP; 01 Jul 2015 16:21:45 -0700 From: Damien Lespiau To: intel-gfx@lists.freedesktop.org Date: Thu, 2 Jul 2015 00:21:40 +0100 Message-Id: <1435792903-11552-1-git-send-email-damien.lespiau@intel.com> X-Mailer: git-send-email 2.1.0 Subject: [Intel-gfx] [PATCH i-g-t 1/4] stats: Add wikipedia links to get_trimean() and get_iqm() X-BeenThere: intel-gfx@lists.freedesktop.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: Intel graphics driver community testing & development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Errors-To: intel-gfx-bounces@lists.freedesktop.org Sender: "Intel-gfx" X-Spam-Status: No, score=-4.8 required=5.0 tests=BAYES_00, RCVD_IN_DNSWL_MED, RP_MATCHES_RCVD, UNPARSEABLE_RELAY autolearn=unavailable version=3.3.1 X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on mail.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP 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(-) diff --git a/lib/igt_stats.c b/lib/igt_stats.c index b7053c3..70650ec 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.