gfsmArcList.h

Go to the documentation of this file.

/*=============================================================================*\
 * File: gfsmArcList.h
 * Author: Bryan Jurish <moocow.bovine@gmail.com>
 * Description: finite state machine library: arc lists
 *  + formerly defined in gfsmArc.h
 *
 * 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_ARC_LIST_H
#define _GFSM_ARC_LIST_H

#include <gfsmArc.h>
#include <gfsmMem.h>

typedef struct gfsmArcListNode_ {
  gfsmArc arc;                    
  struct gfsmArcListNode_ *next;  
} gfsmArcListNode;

typedef gfsmArcListNode gfsmArcList;


/*======================================================================
 * Methods: Arc List: Constructors etc.
 */


GFSM_INLINE
gfsmArcList *gfsm_arclist_prepend_node(gfsmArcList *al, gfsmArcList *nod);

GFSM_INLINE
gfsmArcList *gfsm_arclist_new_full(gfsmStateId  src,
                                   gfsmStateId  dst,
                                   gfsmLabelVal lo,
                                   gfsmLabelVal hi,
                                   gfsmWeight   wt,
                                   gfsmArcList  *nxt);


GFSM_INLINE
gfsmArcList *gfsm_arclist_insert(gfsmArcList *al,
                                 gfsmStateId  src,
                                 gfsmStateId  dst,
                                 gfsmLabelVal lo,
                                 gfsmLabelVal hi,
                                 gfsmWeight   wt,
                                 gfsmArcCompData *acdata);


GFSM_INLINE
gfsmArcList *gfsm_arclist_insert_node(gfsmArcList *al, gfsmArcList *nod, gfsmArcCompData *acdata);

gfsmArcList *gfsm_arclist_insert_node_sorted(gfsmArcList *al, gfsmArcList *link, gfsmArcCompData *acdata);

gfsmArcList *gfsm_arclist_clone(gfsmArcList *src);


void gfsm_arclist_free(gfsmArcList *al);

/* Free a single node of an arc-list */
GFSM_INLINE
void gfsm_arclist_free_1(gfsmArcList *nod);


/*======================================================================
 * Methods: Arc List: Accessors
 */


#define gfsm_arclist_arc(al) \
  ((al) ? (&(al->arc)) : NULL)

//  ((al) ? ((gfsmArc*)((al)->data)) : NULL)

gfsmArcList *gfsm_arclist_concat(gfsmArcList *al1, gfsmArcList *al2);

gfsmArcList *gfsm_arclist_remove_node(gfsmArcList *al, gfsmArcList *nod);

GFSM_INLINE
gfsmArcList *gfsm_arclist_delete_node(gfsmArcList *al, gfsmArcList *nod);

gfsmArcList *gfsm_arclist_reverse(gfsmArcList *al);



/*======================================================================
 * Methods: Arc List: Utilities
 */


guint gfsm_arclist_length(gfsmArcList *al);
 //  Signature: <tt>guint gfsm_arclist_length(gfsmArcList *al)</tt>
//#define gfsm_arclist_length g_slist_length

GFSM_INLINE
gfsmArcList *gfsm_arclist_sort(gfsmArcList *al, gfsmArcCompData *acdata);

GFSM_INLINE
gfsmArcList *gfsm_arclist_sort_with_data(gfsmArcList *al, GCompareDataFunc cmpfunc, gpointer data);

#define gfsm_arclist_sort_full gfsm_arclist_sort_with_data

gfsmArcList *gfsm_arclist_sort_real (gfsmArcList *list, GFunc compare_func, gpointer user_data);



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

#endif /* _GFSM_ARC_LIST_H */