dict.h

/*  File: dict.h
 *  Author: Richard Durbin (rd@sanger.ac.uk)
 *  Copyright (C) Genome Research Limited, 2003-2008
 *-------------------------------------------------------------------
 * Description: header file for DICT package, string hash tables
                developed from the corresponding functions in acedb
		Jean Thierry-Mieg and Richard Durbin 1989-
 * Exported functions:
 * HISTORY:
 * Last edited: May 29 12:50 2023 (rd109)
 * Created: Sat Dec 20 09:34:14 2008 (rd)
 *-------------------------------------------------------------------
 */

#ifndef DICT_DEFINED
#define DICT_DEFINED

#include "utils.h"

typedef struct {
  char* *names ;
  U64 *table ;
  U64 max ;			/* current number of entries */
  U64 dim ;
  U64 size ;			/* 2^dim = size of tables */
} DICT ;

DICT *dictCreate (U64 size) ;
void dictDestroy (DICT *dict) ;
bool dictWrite (DICT *dict, FILE *f) ; /* return success or failure */
DICT *dictRead (FILE *f) ;	       /* return 0 on failure */
bool dictAdd (DICT *dict, char* string, U64 *index) ; /* return TRUE if added, always fill index */
bool dictFind (DICT *dict, char *string, U64 *index) ; /* return TRUE if found */
char* dictName (DICT *dict, U64 i) ;

#define dictMax(dict)  ((dict)->max)

#endif

/*********** end of file ***********/