gfsmxlCascade.h

Go to the documentation of this file.

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

#include <gfsm.h>
#include <gfsmxlLabelIndex.h>
#include <gfsmxlSuffixIndex.h>

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

typedef gfsmStateId* gfsmxlCascadeStateId;

//#define CASCADE_USE_RAW_BSEARCH 1
#define CASCADE_USE_BLOCK_INDEX 1
/*-- uhura, r616M, Wed, 03 Feb 2010 14:29:57 +0100: CASCADE_EXPAND_BLOCK_BSEARCH was defined --*/
//#define CASCADE_EXPAND_BLOCK_BSEARCH 1
//#define CASCADE_USE_BLOCK_HASH 1
//#define CASCADE_USE_SUFFIX_INDEX 1

//-- sort temporary arc-lists on creation?
//   : this is pointless unless we're storing arc-lists with configs!
//#define CASCADE_SORT_ARCITER 1

#if !defined(CASCADE_USE_BLOCK_INDEX)
# define CASCADE_USE_BLOCK_INDEX 1
#endif

#if defined(CASCADE_USE_BLOCK_INDEX) || defined(CASCADE_USE_BLOCK_HASH)
# define CASCADE_USE_BLOCKS 1
#else
# undef CASCADE_USE_BLOCKS
#endif

typedef struct {
  guint                   depth;  
  gfsmSemiring           *sr;     
  GPtrArray              *xfsms;  
#if   defined(CASCADE_USE_BLOCK_INDEX)
  GPtrArray              *xblks;  
#elif defined(CASCADE_USE_BLOCK_HASH)
  GPtrArray              *xblks;  
#endif
#if   defined(CASCADE_USE_SUFFIX_INDEX)
  GPtrArray              *xslxs;   
#endif
  GArray                  *roots;  
} gfsmxlCascade;

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


GFSM_INLINE
gfsmxlCascade *gfsmxl_cascade_new_full(guint depth, gfsmSRType srtype);

GFSM_INLINE
gfsmxlCascade *gfsmxl_cascade_new(void);

GFSM_INLINE
void gfsmxl_cascade_free(gfsmxlCascade *csc, gboolean free_automata);

void gfsmxl_cascade_clear(gfsmxlCascade *csc, gboolean free_automata);

void gfsmxl_cascade_clear_nth(gfsmxlCascade *csc, guint n, gboolean free_automaton);

GFSM_INLINE
gfsmIndexedAutomaton *gfsmxl_cascade_pop(gfsmxlCascade *csc);

GFSM_INLINE
void gfsmxl_cascade_set_nth_indexed(gfsmxlCascade *csc, guint n, gfsmIndexedAutomaton *xfsm, gboolean free_old_automaton);

GFSM_INLINE
void gfsmxl_cascade_append_indexed(gfsmxlCascade *csc, gfsmIndexedAutomaton *xfsm);

GFSM_INLINE
void gfsmxl_cascade_append(gfsmxlCascade *csc, gfsmAutomaton *fsm);


/*======================================================================
 * High-level Access
 */


#define gfsmxl_cascade_index(csc_,index_) \
  ((gfsmIndexedAutomaton*)g_ptr_array_index((csc_)->xfsms,(index_)))

GFSM_INLINE
void gfsmxl_cascade_set_semiring_type(gfsmxlCascade *csc, gfsmSRType srtype);

GFSM_INLINE
void gfsmxl_cascade_set_semiring(gfsmxlCascade *csc, gfsmSemiring *sr);

void gfsmxl_cascade_sort_all(gfsmxlCascade *csc, gfsmArcCompMask sort_mask);


/*======================================================================
 * State Utilities
 */


GFSM_INLINE
gfsmxlCascadeStateId gfsmxl_cascade_get_root(gfsmxlCascade *csc);

GFSM_INLINE
gfsmxlCascadeStateId gfsmxl_cascade_stateid_sized_new(guint depth);

GFSM_INLINE
gfsmxlCascadeStateId gfsmxl_cascade_stateid_new(gfsmxlCascade *csc);

GFSM_INLINE
gfsmxlCascadeStateId gfsmxl_cascade_stateid_sized_copy(gfsmxlCascadeStateId dst, gfsmxlCascadeStateId src, guint depth);

GFSM_INLINE
gfsmxlCascadeStateId gfsmxl_cascade_stateid_sized_clone(gfsmxlCascadeStateId src, guint depth);

GFSM_INLINE
void gfsmxl_cascade_stateid_free(gfsmxlCascadeStateId qids, guint depth);


/*======================================================================
 * Arc Utilities
 */


typedef gfsmArc** gfsmxlArcPP;

GFSM_INLINE
gfsmxlArcPP gfsmxl_arcpp_sized_new(guint depth);

GFSM_INLINE
gfsmxlArcPP gfsmxl_arcpp_sized_copy(gfsmxlArcPP dst, gfsmxlArcPP src, guint depth);

GFSM_INLINE
gfsmxlArcPP gfsmxl_arcpp_sized_clone(gfsmxlArcPP src, guint depth);

GFSM_INLINE
void gfsmxl_arcpp_free(gfsmxlArcPP arcpp, guint depth);

GFSM_INLINE
gfsmLabelId gfsmxl_arcpp_lower(gfsmxlArcPP arcpp);

GFSM_INLINE
gfsmLabelId gfsmxl_arcpp_upper(gfsmxlArcPP arcpp, guint depth);

GFSM_INLINE
gfsmWeight gfsmxl_arcpp_weight(gfsmxlArcPP arcpp, guint depth, gfsmSemiring *sr);

GFSM_INLINE
void gfsmxl_arcpp_target(gfsmxlArcPP arcpp, gfsmxlCascadeStateId src, gfsmxlCascadeStateId dst, guint depth);


/*======================================================================
 * Arc Utilities
 */


typedef struct {
  gfsmLabelId         lower;   
  gfsmLabelId         upper;   
  gfsmWeight          weight;  
  gfsmxlCascadeStateId targets; 
} gfsmxlCascadeArc;

GFSM_INLINE
gfsmxlCascadeArc* gfsmxl_cascade_arc_sized_new(guint depth);

GFSM_INLINE
gfsmxlCascadeArc* gfsmxl_cascade_arc_sized_copy(gfsmxlCascadeArc *dst, gfsmxlCascadeArc *src, guint depth);

GFSM_INLINE
gfsmxlCascadeArc* gfsmxl_cascade_arc_sized_clone(gfsmxlCascadeArc *src, guint depth);

GFSM_INLINE
void gfsmxl_cascade_arc_free(gfsmxlCascadeArc *arc, guint depth);



/*======================================================================
 * Arc Iteration & Low-level Access
 */


gfsmWeight gfsmxl_cascade_get_final_weight(gfsmxlCascade *csc, gfsmxlCascadeStateId qids);

gboolean gfsmxl_cascade_state_is_terminable(gfsmxlCascade *csc, gfsmxlCascadeStateId qids, gfsmxlSuffixLength ilen);

typedef struct {
  gfsmxlCascade         *csc;     
  gfsmxlCascadeStateId   qids;    
  GSList               *arclist; 
  GSList               *cur;     
  gfsmArcRange         *ranges;  
} gfsmxlCascadeArcIter;

void gfsmxl_cascade_arciter_open(gfsmxlCascadeArcIter *cai, gfsmxlCascade *csc, gfsmxlCascadeStateId qids, gfsmLabelId lo); 

void gfsmxl_cascade_arciter_close(gfsmxlCascadeArcIter *cai);

GFSM_INLINE
gboolean gfsmxl_cascade_arciter_ok(gfsmxlCascadeArcIter *cai);

GFSM_INLINE
gfsmxlCascadeArc *gfsmxl_cascade_arciter_arc(gfsmxlCascadeArcIter *cai);

GFSM_INLINE
void gfsmxl_cascade_arciter_next(gfsmxlCascadeArcIter *cai);

GFSM_INLINE
void gfsmxl_cascade_arciter_reset(gfsmxlCascadeArcIter *cai);

#ifdef CASCADE_SORT_ARCITER

GFSM_INLINE
void gfsmxl_cascade_arciter_insert_arc_(gfsmxlCascadeArcIter *cai, gfsmxlCascadeArc *carc);
#else

GFSM_INLINE
void gfsmxl_cascade_arciter_insert_arc_(gfsmxlCascadeArcIter *cai, gfsmxlCascadeArc *carc);
#endif



/*======================================================================
 * I/O
 */


typedef struct {
  gchar              magic[16];    
  gfsmVersionInfo    version;      
  gfsmVersionInfo    version_min;  
  gfsmAutomatonFlags _flags;       
  gfsmStateId        _root_id;     
  gfsmStateId        _n_states;    
  gfsmStateId        _n_arcs;      
  guint32            srtype;       
  guint32            _unused1;     
  guint32            depth;        
  guint32            _unused3;     
} gfsmxlCascadeHeader;

extern const gchar gfsm_cascade_header_magic[16];

extern const gfsmVersionInfo gfsm_cascade_version_bincompat_min_store;

extern const gfsmVersionInfo gfsm_cascade_version_bincompat_min_check;

/*--------------------------------------------------------------*/

gboolean gfsmxl_cascade_load_header(gfsmxlCascadeHeader *hdr, gfsmIOHandle *ioh, gfsmError **errp);

gboolean gfsmxl_cascade_load_bin_handle(gfsmxlCascade *csc, gfsmIOHandle *ioh, gfsmError **errp);

gboolean gfsmxl_cascade_load_bin_file(gfsmxlCascade *csc, FILE *f, gfsmError **errp);

gboolean gfsmxl_cascade_load_bin_filename(gfsmxlCascade *csc, const gchar *filename, gfsmError **errp);

gboolean gfsmxl_cascade_load_bin_gstring(gfsmxlCascade *csc, GString *gs, gfsmError **errp);

/*--------------------------------------------------------------*/

gboolean gfsmxl_cascade_save_bin_handle(gfsmxlCascade *csc, gfsmIOHandle *ioh, gfsmError **errp);

gboolean gfsmxl_cascade_save_bin_file(gfsmxlCascade *csc, FILE *f, gfsmError **errp);

gboolean gfsmxl_cascade_save_bin_filename_nc(gfsmxlCascade *csc, const gchar *filename, gfsmError **errp);

gboolean gfsmxl_cascade_save_bin_filename(gfsmxlCascade *csc, const gchar *filename, int zlevel, gfsmError **errp);

gboolean gfsmxl_cascade_save_bin_gstring(gfsmxlCascade *csc, GString *gs, gfsmError **errp);


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

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

#endif /* _GFSMXL_CASCADE_H */