af443edc34b8b4f5b5003b2d73d8f805b29003ce
[pspp] / src / sort.h
1 /* PSPP - computes sample statistics.
2    Copyright (C) 1997-9, 2000 Free Software Foundation, Inc.
3    Written by Ben Pfaff <blp@gnu.org>.
4
5    This program is free software; you can redistribute it and/or
6    modify it under the terms of the GNU General Public License as
7    published by the Free Software Foundation; either version 2 of the
8    License, or (at your option) any later version.
9
10    This program is distributed in the hope that it will be useful, but
11    WITHOUT ANY WARRANTY; without even the implied warranty of
12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13    General Public License for more details.
14
15    You should have received a copy of the GNU General Public License
16    along with this program; if not, write to the Free Software
17    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
18    02110-1301, USA. */
19
20 #if !sort_h
21 #define sort_h 1
22
23 #include <stddef.h>
24 #include <stdbool.h>
25
26 struct casereader;
27 struct dictionary;
28 struct variable;
29
30
31 /* Sort direction. */
32 enum sort_direction
33   {
34     SRT_ASCEND,                 /* A, B, C, ..., X, Y, Z. */
35     SRT_DESCEND                 /* Z, Y, X, ..., C, B, A. */
36   };
37
38 /* A sort criterion. */
39 struct sort_criterion
40   {
41     int fv;                     /* Variable data index. */
42     int width;                  /* 0=numeric, otherwise string width. */
43     enum sort_direction dir;    /* Sort direction. */
44   };
45
46 /* A set of sort criteria. */
47 struct sort_criteria 
48   {
49     struct sort_criterion *crits;
50     size_t crit_cnt;
51   };
52
53
54 void sort_destroy_criteria (struct sort_criteria *);
55
56 struct casefile *sort_execute (struct casereader *,
57                                const struct sort_criteria *);
58
59 int sort_active_file_in_place (const struct sort_criteria *);
60
61 struct casefile *sort_active_file_to_casefile (const struct sort_criteria *);
62
63 #endif /* !sort_h */