mode: New order statistic.
[pspp] / src / math / mode.c
1 /* PSPP - a program for statistical analysis.
2    Copyright (C) 2008, 2009, 2011, 2022 Free Software Foundation, Inc.
3
4    This program is free software: you can redistribute it and/or modify
5    it under the terms of the GNU General Public License as published by
6    the Free Software Foundation, either version 3 of the License, or
7    (at your option) any later version.
8
9    This program is distributed in the hope that it will be useful,
10    but WITHOUT ANY WARRANTY; without even the implied warranty of
11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12    GNU General Public License for more details.
13
14    You should have received a copy of the GNU General Public License
15    along with this program.  If not, see <http://www.gnu.org/licenses/>. */
16
17 #include <config.h>
18
19 #include "math/mode.h"
20
21 #include "data/casereader.h"
22 #include "data/val-type.h"
23 #include "data/variable.h"
24 #include "libpspp/assertion.h"
25 #include "libpspp/cast.h"
26
27 #include "gl/xalloc.h"
28
29
30 static void
31 mode_destroy (struct statistic *stat)
32 {
33   struct mode *mode = UP_CAST (stat, struct mode, parent.parent);
34   free (mode);
35 }
36
37 static void
38 mode_accumulate (struct statistic *stat, const struct ccase *cx UNUSED,
39                  double c, double cc UNUSED, double y)
40 {
41   struct mode *mode = UP_CAST (stat, struct mode, parent.parent);
42   if (c > mode->mode_weight)
43     {
44       mode->mode = y;
45       mode->mode_weight = c;
46       mode->n_modes = 1;
47     }
48   else if (c == mode->mode_weight)
49     mode->n_modes++;
50 }
51
52 struct mode *
53 mode_create (void)
54 {
55   struct mode *mode = xmalloc (sizeof *mode);
56   *mode = (struct mode) {
57     .parent = {
58       .parent = {
59         mode_destroy,
60       },
61       .accumulate = mode_accumulate,
62     },
63     .mode = SYSMIS,
64   };
65   return mode;
66 }