begin refactoring how to do grouping
[pspp] / src / libpspp / sparse-array.h
index f2e91a603c7f3eb695ea52c39f3a460c6c29b54b..69e2ed9546f95a80966fd70113b1ce2c68777e7f 100644 (file)
@@ -1,26 +1,24 @@
-/* PSPP - computes sample statistics.
-   Copyright (C) 2007 Free Software Foundation, Inc.
+/* PSPP - a program for statistical analysis.
+   Copyright (C) 2007, 2009 Free Software Foundation, Inc.
 
 
-   This program is free software; you can redistribute it and/or
-   modify it under the terms of the GNU General Public License as
-   published by the Free Software Foundation; either version 2 of the
-   License, or (at your option) any later version.
+   This program is free software: you can redistribute it and/or modify
+   it under the terms of the GNU General Public License as published by
+   the Free Software Foundation, either version 3 of the License, or
+   (at your option) any later version.
 
 
-   This program is distributed in the hope that it will be useful, but
-   WITHOUT ANY WARRANTY; without even the implied warranty of
-   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-   General Public License for more details.
+   This program is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
 
    You should have received a copy of the GNU General Public License
 
    You should have received a copy of the GNU General Public License
-   along with this program; if not, write to the Free Software
-   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
-   02110-1301, USA. */
+   along with this program.  If not, see <http://www.gnu.org/licenses/>. */
 
 /* Sparse array data structure.
 
    Implements a dictionary that associates a "unsigned long int"
    key with fixed-size values (elements).
 
 /* Sparse array data structure.
 
    Implements a dictionary that associates a "unsigned long int"
    key with fixed-size values (elements).
-   
+
    The implementation allocates elements in groups of moderate
    size, so it achieves maximum space efficiency when elements
    are clustered into groups of consecutive keys.  For the same
    The implementation allocates elements in groups of moderate
    size, so it achieves maximum space efficiency when elements
    are clustered into groups of consecutive keys.  For the same
@@ -38,7 +36,7 @@
 #include <stddef.h>
 #include <stdbool.h>
 
 #include <stddef.h>
 #include <stdbool.h>
 
-#include <libpspp/hash.h>
+struct pool;
 
 struct sparse_array *sparse_array_create (size_t elem_size);
 struct sparse_array *sparse_array_create_pool (struct pool *,
 
 struct sparse_array *sparse_array_create (size_t elem_size);
 struct sparse_array *sparse_array_create_pool (struct pool *,
@@ -51,8 +49,13 @@ void *sparse_array_insert (struct sparse_array *, unsigned long int key);
 void *sparse_array_get (const struct sparse_array *, unsigned long int key);
 bool sparse_array_remove (struct sparse_array *, unsigned long int key);
 
 void *sparse_array_get (const struct sparse_array *, unsigned long int key);
 bool sparse_array_remove (struct sparse_array *, unsigned long int key);
 
-void *sparse_array_scan (const struct sparse_array *,
-                         unsigned long int *skip,
-                         unsigned long int *key);
+void *sparse_array_first (const struct sparse_array *,
+                          unsigned long int *idxp);
+void *sparse_array_next (const struct sparse_array *,
+                         unsigned long int skip, unsigned long int *idxp);
+void *sparse_array_last (const struct sparse_array *,
+                          unsigned long int *idxp);
+void *sparse_array_prev (const struct sparse_array *,
+                         unsigned long int skip, unsigned long int *idxp);
 
 #endif /* libpspp/sparse-array.h */
 
 #endif /* libpspp/sparse-array.h */