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 struct casefile_factory;
  29
  30 extern int min_buffers ;
  31 extern int max_buffers ;
  32 extern bool allow_internal_sort ;
  33
  34
  35 /* Sort direction. */
  36 enum sort_direction
  37   {
  38     SRT_ASCEND,                 /* A, B, C, ..., X, Y, Z. */
  39     SRT_DESCEND                 /* Z, Y, X, ..., C, B, A. */
  40   };
  41
  42 /* A sort criterion. */
  43 struct sort_criterion
  44   {
  45     int fv;                     /* Variable data index. */
  46     int width;                  /* 0=numeric, otherwise string width. */
  47     enum sort_direction dir;    /* Sort direction. */
  48   };
  49
  50 /* A set of sort criteria. */
  51 struct sort_criteria
  52   {
  53     struct sort_criterion *crits;
  54     size_t crit_cnt;
  55   };
  56
  57
  58 void sort_destroy_criteria (struct sort_criteria *);
  59
  60 struct casefile *sort_execute (struct casereader *,
  61                                const struct sort_criteria *,
  62                                struct casefile_factory *
  63                                );
  64
  65 struct dataset ;
  66 bool sort_active_file_in_place (struct dataset *ds,
  67                                 const struct sort_criteria *);
  68
  69 struct casefile *sort_active_file_to_casefile (struct dataset *ds,
  70                                                const struct sort_criteria *);
  71
  72 #endif /* !sort_h */