gfsmxlCascadeLookup.h

Go to the documentation of this file.

/*=============================================================================*\
 * File: gfsmxlCascadeLookup.h
 * Author: Bryan Jurish <moocow.bovine@gmail.com>
 * Description: finite state machine library: lookup cascade: lookup routines
 *
 * Copyright (c) 2007-2011 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 2.1 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 _GFSMXL_CASCADE_LOOKUP_H
#define _GFSMXL_CASCADE_LOOKUP_H

#include <gfsmxlCascade.h>
#include <gfsmxlCLCFib.h>

/*======================================================================
 * Types
 */

typedef struct gfsmxlCLCFibHeap gfsmxlFibHeap;
//typedef struct fibheap gfsmxlFibHeap;

typedef struct gfsmxlCascadeLookupBacktrace_ {
  struct gfsmxlCascadeLookupConfig_ *prev; 
  gfsmLabelId                        lo;   
  gfsmLabelId                        hi;   
  gfsmWeight                         aw;   
  gfsmWeight                         fw;   
} gfsmxlCascadeLookupBacktrace;

typedef struct gfsmxlCascadeLookupConfig_ {
  gfsmxlCascade         *csc;     
  gfsmxlCascadeStateId   qids;    
  guint32                ipos;    
  gfsmStateId            oid;     
  gfsmStateId            rid;     
  gfsmWeight             w;       
  gfsmxlCascadeLookupBacktrace bt; 
} gfsmxlCascadeLookupConfig;

typedef GSList gfsmxlCascadeLookupConfigList;

typedef GPtrArray gfsmxlPathArray;

typedef struct {
  //
  //-- user data
  gfsmxlCascade  *csc;       
  gfsmWeight     max_w;      
  guint          max_paths;  
  guint          max_ops;    
  //
  //-- low-level data
  gfsmxlFibHeap             *heap;        
  GHashTable                *configs;     
  gfsmAutomaton             *otrie;       
  gfsmxlCascadeLookupConfigList *finals;  
  guint                      n_ops;       
  gfsmxlCascadeLookupConfig  heap_neginf; 
} gfsmxlCascadeLookup;


/*======================================================================
 * Constants
 */
extern const gfsmxlCascadeLookupBacktrace gfsmxl_bt_null; /*< "empty" backtrace */

/*======================================================================
 * Constructors, etc.
 */


GFSM_INLINE
gfsmxlCascadeLookup *gfsmxl_cascade_lookup_new_full(gfsmxlCascade *csc, gfsmWeight max_w, guint max_paths, guint max_ops);

GFSM_INLINE
gfsmxlCascadeLookup *gfsmxl_cascade_lookup_new(void);

GFSM_INLINE
void gfsmxl_cascade_lookup_set_cascade(gfsmxlCascadeLookup *cl, gfsmxlCascade *csc);

GFSM_INLINE
void gfsmxl_cascade_lookup_free(gfsmxlCascadeLookup *cl);


/*======================================================================
 * gfsmxlCascadeLookup API
 */



gfsmAutomaton *gfsmxl_cascade_lookup_nbest(gfsmxlCascadeLookup *cl, gfsmLabelVector *input, gfsmAutomaton *result);

gfsmxlPathArray *gfsmxl_cascade_lookup_nbest_paths(gfsmxlCascadeLookup *cl, gfsmLabelVector *input, gfsmxlPathArray *paths);


/*======================================================================
 * gfsmxlCascadeLookup: Low-level and Debug Utilities
 */


void gfsmxl_cascade_lookup_reset(gfsmxlCascadeLookup *cl);

GFSM_INLINE
gfsmAutomaton *gfsmxl_cascade_lookup_nbest_prepare_(gfsmxlCascadeLookup *cl, gfsmAutomaton *result);

GFSM_INLINE
gfsmxlCascadeLookupConfig *gfsmxl_cascade_lookup_ensure_config(gfsmxlCascadeLookup *cl, gfsmxlCascadeLookupConfig *cfg_key);

void gfsmxl_cascade_lookup_nbest_search_(gfsmxlCascadeLookup *cl, gfsmLabelVector *input);

void gfsmxl_cascade_lookup_nbest_backtrace_(gfsmxlCascadeLookup       *cl,
                                            gfsmxlCascadeLookupConfig *cfg,
                                            gfsmxlCascadeLookupConfig *nxt,
                                            gfsmAutomaton             *result);

void gfsmxl_cascade_lookup_nbest_backtrace_path_(gfsmxlCascadeLookup       *cl,
                                                 gfsmxlCascadeLookupConfig *cfg,
                                                 gfsmPath                  *p);

gfsmAutomaton *gfsmxl_cascade_lookup_nbest_debug(gfsmxlCascadeLookup *cl, gfsmLabelVector *input, gfsmAutomaton *result);


/*======================================================================
 * gfsmxlPathList: Low-level utilities
 */

GFSM_INLINE
gfsmxlPathArray *gfsmxl_patharray_new(guint n_paths);

GFSM_INLINE
void gfsmxl_patharray_free(gfsmxlPathArray *paths);

void gfsmxl_patharray_clear(gfsmxlPathArray *paths);


/*======================================================================
 * gfsmxlCascadeLookupConfig: Low-level Utilities
 */


GFSM_INLINE
int gfsmxl_cascade_lookup_config_fh_compare(gfsmxlCascadeLookupConfig *lc1, gfsmxlCascadeLookupConfig *lc2);

guint gfsmxl_cascade_lookup_config_ht_hash(gfsmxlCascadeLookupConfig *lc);

gboolean gfsmxl_cascade_lookup_config_ht_equal(gfsmxlCascadeLookupConfig *lc1, gfsmxlCascadeLookupConfig *lc2);

GFSM_INLINE
gfsmxlCascadeLookupConfig *gfsmxl_cascade_lookup_config_new_full(gfsmxlCascade        *csc,
                                                                 gfsmxlCascadeStateId  qids,
                                                                 guint32               ipos,
                                                                 gfsmStateId           oid,
                                                                 gfsmStateId           rid,
                                                                 gfsmWeight            w,
                                                                 gfsmxlCascadeLookupBacktrace bt
                                                                 );

GFSM_INLINE
gfsmxlCascadeLookupConfig *gfsmxl_cascade_lookup_config_new(gfsmxlCascadeLookup *cl);

GFSM_INLINE
void gfsmxl_cascade_lookup_config_copy(gfsmxlCascadeLookupConfig *dst, gfsmxlCascadeLookupConfig *src);

GFSM_INLINE
gfsmxlCascadeLookupConfig *gfsmxl_cascade_lookup_config_clone(gfsmxlCascadeLookupConfig *src);

GFSM_INLINE
void gfsmxl_cascade_lookup_config_free_inline(gfsmxlCascadeLookupConfig *lc);

void gfsmxl_cascade_lookup_config_free(gfsmxlCascadeLookupConfig *lc);


/*======================================================================
 * Low-level: gfsmxlCascadeLookupConfigList
 */


void gfsmxl_cascade_lookup_config_list_free(gfsmxlCascadeLookupConfigList *lcl);



/*======================================================================
 * END
 */

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

#endif /* _GFSMXL_CASCADE_LOOKUP_H */