gfsmWeightMap.h

Go to the documentation of this file.

/*=============================================================================*\
 * File: gfsmWeightMap.h
 * Author: Bryan Jurish <moocow.bovine@gmail.com>
 * Description: finite state machine library
 *
 * Copyright (c) 2005-2007 Bryan Jurish.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 * 
 * This library 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
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 *=============================================================================*/

#ifndef _GFSM_WEIGHTMAP_H
#define _GFSM_WEIGHTMAP_H

#include <gfsmSet.h>
#include <gfsmSemiring.h>

/*======================================================================
 * Types
 */
typedef GTree gfsmWeightMap;

typedef struct {
  GHashTable   *table;   
  gfsmDupFunc   key_dup; 
} gfsmWeightHash;

typedef union {
  gfsmWeight w; 
  gpointer   p; 
} gfsmWeightOrPointer;

typedef GArray gfsmStateWeightPairArray;

/*======================================================================
 * gfsmWeight <-> gpointer conversions
 */



GFSM_INLINE
gfsmWeight gfsm_ptr2weight(const gpointer p);

GFSM_INLINE
gpointer gfsm_weight2ptr(const gfsmWeight w);


/*======================================================================
 * gfsmWeightMap: Constructors etc.
 */



GFSM_INLINE
gfsmWeightMap *gfsm_weightmap_new_full(GCompareDataFunc key_cmp_func,
                                       gpointer         key_cmp_data,
                                       GDestroyNotify   key_free_func);

GFSM_INLINE
gfsmWeightMap *gfsm_weightmap_new(GCompareFunc key_cmp_func);

GFSM_INLINE
gfsmWeightMap *gfsm_weightmap_copy(gfsmWeightMap *dst, gfsmWeightMap *src);

GFSM_INLINE
void gfsm_weightmap_clear(gfsmWeightMap *wm);

GFSM_INLINE
void gfsm_weightmap_free(gfsmWeightMap *wm);


/*======================================================================
 * Accessors
 */


GFSM_INLINE
gboolean gfsm_weightmap_contains(gfsmWeightMap *weightmap, gconstpointer key);

GFSM_INLINE
gboolean gfsm_weightmap_lookup(gfsmWeightMap *weightmap, gconstpointer key, gfsmWeight *wp);

//#define _gfsm_weightmap_insert(weightmap,key,w) g_tree_insert((weightmap),((gpointer)(key)),gfsm_weight2ptr(w))

GFSM_INLINE
void gfsm_weightmap_insert(gfsmWeightMap *weightmap, gconstpointer key, gfsmWeight w);

GFSM_INLINE
gfsmWeight gfsm_weightmap_insert_sum(gfsmWeightMap *weightmap, gconstpointer key, gfsmWeight w, gfsmSemiring *sr);

#define gfsm_weightmap_size(weightmap) g_tree_nnodes(weightmap)

#define gfsm_weightmap_remove(weightmap,key) g_tree_remove((weightmap),((gpointer)(key)))

#define gfsm_weightmap_foreach(weightmap,func,data) g_tree_foreach((weightmap),(func),(data))

gfsmStateWeightPairArray *gfsm_weightmap_to_array(gfsmWeightMap *weightmap, gfsmStateWeightPairArray *array);




/*======================================================================
 * gfsmWeightHash: Constructors etc.
 */


GFSM_INLINE
gfsmWeightHash *gfsm_weighthash_new_full(gfsmDupFunc key_dup_func,
                                         GHashFunc   key_hash_func,
                                         GEqualFunc  key_equal_func,
                                         GDestroyNotify key_destroy_func);

#define gfsm_weighthash_new(key_hash_f,key_equal_f) \
  gfsm_weighthash_new_full(NULL,(key_hash_f),(key_equal_f),NULL)

GFSM_INLINE
void gfsm_weighthash_clear(gfsmWeightHash *wh);

GFSM_INLINE
void gfsm_weighthash_free(gfsmWeightHash *wh);


/*======================================================================
 * gfsmWeightHash: Accessors
 */


GFSM_INLINE
gboolean gfsm_weighthash_lookup(gfsmWeightHash *wh, gconstpointer key, gfsmWeight *wp);

GFSM_INLINE
void gfsm_weighthash_insert(gfsmWeightHash *wh, gconstpointer key, gfsmWeight w);

GFSM_INLINE
gboolean gfsm_weighthash_insert_if_less(gfsmWeightHash *wh, gconstpointer key, gfsmWeight w, gfsmSemiring *sr);

GFSM_INLINE
gboolean gfsm_weighthash_insert_sum_if_less(gfsmWeightHash *wh, gconstpointer key, gfsmWeight w, gfsmSemiring *sr);

#define gfsm_weighthash_foreach(wh,func,data) \
  g_hash_table_foreach((wh)->table,(func),(data))


//-- inline definitions
#ifdef GFSM_INLINE_ENABLED
# include <gfsmWeightMap.hi>
#endif

#endif /* _GFSM_WEIGHTMAP_H */