gfsmCompound.h

Go to the documentation of this file.

/*=============================================================================*\
 * File: gfsmCompound.h
 * Author: Bryan Jurish <moocow.bovine@gmail.com>
 * Description: finite state machine library: basic compound types
 *
 * Copyright (c) 2004-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 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_COMPOUND_H
#define _GFSM_COMPOUND_H

#include <gfsmEnum.h>
#include <gfsmWeightMap.h>

/*======================================================================
 * Compound Types
 */
typedef guint32 gfsmLabelPair;

typedef struct {
  gfsmStateId  id1;  
  gfsmStateId  id2;  
} gfsmStatePair;


typedef guint8 gfsmComposeFilterState;


typedef struct {
  gfsmStateId            id1;  
  gfsmStateId            id2;  
  gfsmComposeFilterState idf;  
} gfsmComposeState;

typedef struct {
  gfsmStateId id; 
  gfsmWeight   w; 
} gfsmStateWeightPair;

typedef gfsmEnum gfsmStatePairEnum;

typedef gfsmEnum gfsmComposeStateEnum;

typedef gfsmWeightHash gfsmStatePair2WeightHash;


/*======================================================================
 * LabelPair: Methods
 */


GFSM_INLINE
gfsmLabelPair gfsm_labelpair_new(guint32 lo, guint32 hi);

GFSM_INLINE
gfsmLabelId gfsm_labelpair_lower(gfsmLabelPair lp);

GFSM_INLINE
gfsmLabelId gfsm_labelpair_upper(gfsmLabelPair lp);

#define gfsm_labelpair_hash g_direct_hash

#define gfsm_labelpair_equal g_direct_equal

gint gfsm_labelpair_compare(gfsmLabelPair lp1, gfsmLabelPair lp2);

gint gfsm_labelpair_compare_with_data(gfsmLabelPair lp1, gfsmLabelPair lp2, gpointer data);

/*======================================================================
 * Methods: gfsmStatePair
 */


GFSM_INLINE
gfsmStatePair *gfsm_statepair_new(gfsmStateId id1, gfsmStateId id2);

GFSM_INLINE
gfsmStatePair *gfsm_statepair_clone(gfsmStatePair *sp);

GFSM_INLINE
void gfsm_statepair_free(gfsmStatePair *sp);

guint gfsm_statepair_hash(gfsmStatePair *sp);

gint gfsm_statepair_compare(const gfsmStatePair *sp1, const gfsmStatePair *sp2);

gboolean gfsm_statepair_equal(const gfsmStatePair *sp1, const gfsmStatePair *sp2);


/*======================================================================
 * Methods: gfsmComposeState
 */


GFSM_INLINE
gfsmComposeState *gfsm_compose_state_new(gfsmStateId id1, gfsmStateId id2, gfsmComposeFilterState idf);

GFSM_INLINE
gfsmComposeState *gfsm_compose_state_clone(gfsmComposeState *sp);

GFSM_INLINE
void gfsm_compose_state_free(gfsmComposeState *csp);

guint gfsm_compose_state_hash(gfsmComposeState *sp);

gint gfsm_compose_state_compare(const gfsmComposeState *sp1, const gfsmComposeState *sp2);

gboolean gfsm_compose_state_equal(const gfsmComposeState *sp1, const gfsmComposeState *sp2);



/*======================================================================
 * Methods: gfsmStateWeightPair
 */


GFSM_INLINE
gfsmStateWeightPair *gfsm_state_weight_pair_new(gfsmStateId id, gfsmWeight w);

GFSM_INLINE
gfsmStateWeightPair *gfsm_state_weight_pair_clone(const gfsmStateWeightPair *swp);

GFSM_INLINE
void gfsm_state_weight_pair_free(gfsmStateWeightPair *swp);

guint gfsm_state_weight_pair_hash(gfsmStateWeightPair *sp);

gint gfsm_state_weight_pair_compare(const gfsmStateWeightPair *swp1, const gfsmStateWeightPair *swp2, gfsmSemiring *sr);

gint gfsm_state_weight_pair_compare_q(const gfsmStateWeightPair *swp1, const gfsmStateWeightPair *swp2, gpointer data);

gboolean gfsm_state_weight_pair_equal(const gfsmStateWeightPair *swp1, const gfsmStateWeightPair *swp2);


/*======================================================================
 * Methods: gfsmStatePairEnum
 */


GFSM_INLINE
gfsmStatePairEnum *gfsm_statepair_enum_new(void);

#define gfsm_statepair_enum_clear gfsm_enum_clear

#define gfsm_statepair_enum_free  gfsm_enum_free


/*======================================================================
 * Methods: gfsmComposeStateEnum
 */


GFSM_INLINE
gfsmComposeStateEnum *gfsm_compose_state_enum_new(void);

#define gfsm_compose_state_enum_clear gfsm_enum_clear

#define gfsm_compose_state_enum_free  gfsm_enum_free



/*======================================================================
 * Methods: gfsmStatePair2WeightHash
 */


GFSM_INLINE
gfsmStatePair2WeightHash *gfsm_statepair2weighthash_new(void);


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

#endif /* _GFSM_COMPOUND_H */