netcdf-c/include/nclist.h
Dennis Heimbigner 25f062528b This completes (for now) the refactoring of libsrc4.
The file docs/indexing.dox tries to provide design
information for the refactoring.

The primary change is to replace all walking of linked
lists with the use of the NCindex data structure.
Ncindex is a combination of a hash table (for name-based
lookup) and a vector (for walking the elements in the index).
Additionally, global vectors are added to NC_HDF5_FILE_INFO_T
to support direct mapping of an e.g. dimid to the NC_DIM_INFO_T
object. These global vectors exist for dimensions, types, and groups
because they have globally unique id numbers.

WARNING:
1. since libsrc4 and libsrchdf4 share code, there are also
   changes in libsrchdf4.
2. Any outstanding pull requests that change libsrc4 or libhdf4
   are likely to cause conflicts with this code.
3. The original reason for doing this was for performance improvements,
   but as noted elsewhere, this may not be significant because
   the meta-data read performance apparently is being dominated
   by the hdf5 library because we do bulk meta-data reading rather
   than lazy reading.
2018-03-16 11:46:18 -06:00

68 lines
1.9 KiB
C

/* Copyright 2009, UCAR/Unidata and OPeNDAP, Inc.
See the COPYRIGHT file for more information. */
#ifndef NCLIST_H
#define NCLIST_H 1
/* Define the type of the elements in the list*/
#if defined(_CPLUSPLUS_) || defined(__CPLUSPLUS__)
extern "C" {
#endif
extern int nclistnull(void*);
typedef struct NClist {
size_t alloc;
size_t length;
void** content;
} NClist;
extern NClist* nclistnew(void);
extern int nclistfree(NClist*);
extern int nclistfreeall(NClist*);
extern int nclistsetalloc(NClist*,size_t);
extern int nclistsetlength(NClist*,size_t);
/* Set the ith element; will overwrite previous contents; expand if needed */
extern int nclistset(NClist*,size_t,void*);
/* Get value at position i */
extern void* nclistget(NClist*,size_t);/* Return the ith element of l */
/* Insert at position i; will push up elements i..|seq|. */
extern int nclistinsert(NClist*,size_t,void*);
/* Remove element at position i; will move higher elements down */
extern void* nclistremove(NClist* l, size_t i);
/* Tail operations */
extern int nclistpush(NClist*,void*); /* Add at Tail */
extern void* nclistpop(NClist*);
extern void* nclisttop(NClist*);
/* Duplicate and return the content (null terminate) */
extern void** nclistdup(NClist*);
/* Look for value match */
extern int nclistcontains(NClist*, void*);
/* Remove element by value; only removes first encountered */
extern int nclistelemremove(NClist* l, void* elem);
/* remove duplicates */
extern int nclistunique(NClist*);
/* Create a clone of a list */
extern NClist* nclistclone(NClist*);
extern void* nclistextract(NClist*);
/* Following are always "in-lined"*/
#define nclistclear(l) nclistsetlength((l),0)
#define nclistextend(l,len) nclistsetalloc((l),(len)+(l->alloc))
#define nclistcontents(l) ((l)==NULL?NULL:(l)->content)
#define nclistlength(l) ((l)==NULL?0:(l)->length)
#if defined(_CPLUSPLUS_) || defined(__CPLUSPLUS__)
}
#endif
#endif /*NCLIST_H*/