src/math/sort.h

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