gfsmIndexed.h

Go to the documentation of this file.

/*=============================================================================*\
 * File: gfsmIndexed.h
 * Author: Bryan Jurish <moocow.bovine@gmail.com>
 * Description: finite state machine library: arc indices
 *
 * Copyright (c) 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_INDEXED_H
#define _GFSM_INDEXED_H

#include <gfsmArcIndex.h>

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

typedef struct {
  //-- gfsmAutomaton compatibility
  gfsmAutomatonFlags  flags;              
  gfsmSemiring       *sr;                 
  gfsmStateId         root_id;            
  //
  //-- Basic data
  //gfsmBitVector      *state_is_valid;     /* per-state validity flags */
  gfsmWeightVector   *state_final_weight; 
  gfsmArcTableIndex  *arcs;               
} gfsmIndexedAutomaton;

/*======================================================================
 * Methods: gfsmIndexedAutomaton: constructors, etc.
 */


GFSM_INLINE
gfsmIndexedAutomaton *gfsm_indexed_automaton_new_full(gfsmAutomatonFlags flags,
                                                      gfsmSRType         srtype,
                                                      gfsmStateId        n_states,
                                                      guint              n_arcs);

GFSM_INLINE
gfsmIndexedAutomaton *gfsm_indexed_automaton_new(void);

gfsmIndexedAutomaton *gfsm_indexed_automaton_copy(gfsmIndexedAutomaton *dst, gfsmIndexedAutomaton *src);

GFSM_INLINE
gfsmIndexedAutomaton *gfsm_indexed_automaton_clone(gfsmIndexedAutomaton *xfsm);

GFSM_INLINE
void gfsm_indexed_automaton_clear(gfsmIndexedAutomaton *xfsm);

GFSM_INLINE
void gfsm_indexed_automaton_free(gfsmIndexedAutomaton *xfsm);


/*======================================================================
 * Methods: Import & Export
 */


gfsmIndexedAutomaton *gfsm_automaton_to_indexed(gfsmAutomaton *fsm, gfsmIndexedAutomaton *xfsm);

gfsmAutomaton *gfsm_indexed_to_automaton(gfsmIndexedAutomaton *xfsm, gfsmAutomaton *fsm);


/*======================================================================
 * Methods: Accessors: gfsmIndexedAutomaton
 */


GFSM_INLINE
void gfsm_indexed_automaton_reserve_states(gfsmIndexedAutomaton *xfsm, gfsmStateId n_states);

GFSM_INLINE
void gfsm_indexed_automaton_reserve_arcs(gfsmIndexedAutomaton *xfsm, guint n_arcs);

GFSM_INLINE
void gfsm_indexed_automaton_sort(gfsmIndexedAutomaton *xfsm, gfsmArcCompMask sort_mask);


/*======================================================================
 * gfsmAutomaton API: Automaton properties
 */


#define gfsm_indexed_automaton_get_semiring(xfsm) (xfsm->sr)

GFSM_INLINE
gfsmSemiring *gfsm_indexed_automaton_set_semiring(gfsmIndexedAutomaton *xfsm, gfsmSemiring *sr);

GFSM_INLINE
void gfsm_indexed_automaton_set_semiring_type(gfsmIndexedAutomaton *xfsm, gfsmSRType srtype);

GFSM_INLINE
gfsmStateId gfsm_indexed_automaton_n_states(gfsmIndexedAutomaton *xfsm);

GFSM_INLINE
guint gfsm_indexed_automaton_n_arcs(gfsmIndexedAutomaton *xfsm);

GFSM_INLINE
gfsmStateId gfsm_indexed_automaton_get_root(gfsmIndexedAutomaton *xfsm);

GFSM_INLINE
void gfsm_indexed_automaton_set_root(gfsmIndexedAutomaton *xfsm, gfsmStateId qid);


/*======================================================================
 * Methods: Accessors: gfsmAutomaton API: States
 */


GFSM_INLINE
gboolean gfsm_indexed_automaton_has_state(gfsmIndexedAutomaton *xfsm, gfsmStateId qid);

GFSM_INLINE
gfsmStateId gfsm_indexed_automaton_ensure_state(gfsmIndexedAutomaton *xfsm, gfsmStateId qid);

/* Remove the state with id \a qid, if any.
 * Currently does nothing.
 */
GFSM_INLINE
void gfsm_indexed_automaton_remove_state(gfsmIndexedAutomaton *fsm, gfsmStateId qid);

#define gfsm_indexed_automaton_set_final_state(xfsm,qid,is_final) \
  gfsm_indexed_automaton_set_final_state_full((xfsm),(qid),(is_final),(xfsm)->sr->one)

GFSM_INLINE
void gfsm_indexed_automaton_set_final_state_full(gfsmIndexedAutomaton *fsm,
                                                 gfsmStateId    qid,
                                                 gboolean       is_final,
                                                 gfsmWeight     final_weight);

GFSM_INLINE
gboolean gfsm_indexed_automaton_lookup_final(gfsmIndexedAutomaton *fsm, gfsmStateId id, gfsmWeight *wp);

GFSM_INLINE
gboolean gfsm_indexed_automaton_state_is_final(gfsmIndexedAutomaton *xfsm, gfsmStateId qid);

GFSM_INLINE
gfsmWeight gfsm_indexed_automaton_get_final_weight(gfsmIndexedAutomaton *xfsm, gfsmStateId qid);

GFSM_INLINE
guint gfsm_indexed_automaton_out_degree(gfsmIndexedAutomaton *fsm, gfsmStateId qid);


/*======================================================================
 * ArcRange
 */


GFSM_INLINE
void gfsm_arcrange_open_indexed(gfsmArcRange *range, gfsmIndexedAutomaton *xfsm, gfsmStateId qid);


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

#endif /* _GFSM_INDEXED_H */