gfsmLookup.h

Go to the documentation of this file.

/*=============================================================================*\
 * File: gfsmLookup.h
 * Author: Bryan Jurish <moocow.bovine@gmail.com>
 * Description: finite state machine library
 *
 * Copyright (c) 2005-2014 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_LOOKUP_H
#define _GFSM_LOOKUP_H

#include <gfsmAutomaton.h>
#include <gfsmUtils.h>

/*======================================================================
 * Types: lookup
 */

typedef struct {
  gfsmStateId qt;  
  gfsmStateId qr;  
  guint32     i;   
} gfsmLookupConfig;


//------------------------------

typedef GPtrArray gfsmViterbiTable;

typedef GTree gfsmViterbiMap;

typedef gfsmStateId gfsmViterbiMapKey;

typedef gfsmStateId gfsmViterbiMapValue;

typedef GSList gfsmViterbiColumn;

typedef gfsmState gfsmViterbiNode;


/*======================================================================
 * Constants
 */

extern const gfsmStateId gfsmLookupStateMapGet;

extern const gfsmStateId gfsmLookupMaxResultStates;

/*======================================================================
 * Methods: lookup
 */


//------------------------------
#define gfsm_automaton_lookup(fst,input,result) \
  gfsm_automaton_lookup_full((fst),(input),(result),NULL,gfsmLookupMaxResultStates)

//------------------------------
gfsmAutomaton *gfsm_automaton_lookup_full(gfsmAutomaton     *fst,
                                          gfsmLabelVector   *input,
                                          gfsmAutomaton     *result,
                                          gfsmStateIdVector *statemap,
                                          gfsmStateId        max_result_states);



/*======================================================================
 * Methods: Viterbi
 */


//------------------------------
#define gfsm_automaton_lookup_viterbi(fst,input,trellis) \
   gfsm_automaton_lookup_viterbi_full((fst),(input),(trellis),NULL)

//------------------------------
gfsmAutomaton *gfsm_automaton_lookup_viterbi_full(gfsmAutomaton     *fst,
                                                  gfsmLabelVector   *input,
                                                  gfsmAutomaton     *trellis,
                                                  gfsmStateIdVector *trellis2fst);


/*======================================================================
 * Viterbi: Utilities
 */



//------------------------------
// expand_column()

void _gfsm_viterbi_expand_column(gfsmAutomaton      *fst,
                                 gfsmAutomaton      *trellis,
                                 gfsmViterbiColumn  *col,
                                 gfsmStateIdVector  *trellis2fst,
                                 gfsmViterbiMap     *fst2trellis);


//------------------------------
// gfsmViterbiMap

#define gfsm_viterbi_map_new() \
  g_tree_new_full((GCompareDataFunc)gfsm_uint_compare, NULL, NULL, NULL)


#define gfsm_viterbi_map_free(vmap) g_tree_destroy(vmap)


#define gfsm_viterbi_map_lookup(vmap,key) g_tree_lookup((vmap),(key))

#define gfsm_viterbi_map_insert(vmap,key,val) g_tree_insert((vmap),(gpointer)(key),(gpointer)(val))


//------------------------------
// gfsmViterbiNode

//#define gfsm_viterbi_node_arc(nod) ((gfsmArc*)((nod)->arcs->data))
#define gfsm_viterbi_node_arc(nod) gfsm_arclist_arc((nod)->arcs)

#define gfsm_viterbi_node_best_prevstate(nod) gfsm_viterbi_node_arc(nod)->target

#define gfsm_viterbi_node_best_weight(nod) gfsm_viterbi_node_arc(nod)->weight


#endif /* _GFSM_LOOKUP_H */