libSBML C API  libSBML 5.20.4 C API
Loading...
Searching...
No Matches
List.cpp File Reference

Simple, generic list class. More...

Include dependency graph for List.cpp:

Functions

void List_add (List_t *lst, void *item)
 @_tendcond_t
 
unsigned int List_countIf (const List_t *lst, ListItemPredicate predicate)
 @_tif_t _tconly_t @_tmemberof_t _tList_t_t @_tendif_t
 
List_tList_create (void)
 @_tcond_t _tdoxygenIgnored_t
 
void * List_find (const List_t *lst, const void *item1, ListItemComparator comparator)
 @_tif_t _tconly_t @_tmemberof_t _tList_t_t @_tendif_t
 
List_tList_findIf (const List_t *lst, ListItemPredicate predicate)
 @_tif_t _tconly_t @_tmemberof_t _tList_t_t @_tendif_t
 
void List_free (List_t *lst)
 @_tendcond_t
 
void * List_get (const List_t *lst, unsigned int n)
 @_tif_t _tconly_t @_tmemberof_t _tList_t_t @_tendif_t
 
void List_prepend (List_t *lst, void *item)
 @_tif_t _tconly_t @_tmemberof_t _tList_t_t @_tendif_t
 
void * List_remove (List_t *lst, unsigned int n)
 @_tif_t _tconly_t @_tmemberof_t _tList_t_t @_tendif_t
 
unsigned int List_size (const List_t *lst)
 @_tif_t _tconly_t @_tmemberof_t _tList_t_t @_tendif_t
 
ListNode_t * ListNode_create (void *item)
 @_tcond_t _tdoxygenLibsbmlInternal_t
 
void ListNode_free (ListNode_t *node)
 @_tcond_t _tdoxygenLibsbmlInternal_t
 

Detailed Description

Simple, generic list class.

Author
Ben Bornstein

Function Documentation

◆ List_add()

void List_add ( List_t lst,
void *  item 
)

@_tendcond_t

@_tif_t _tconly_t @_tmemberof_t _tList_t_t @_tendif_t

◆ List_countIf()

unsigned int List_countIf ( const List_t lst,
ListItemPredicate  predicate 
)

@_tif_t _tconly_t @_tmemberof_t _tList_t_t @_tendif_t

@_treturn_t _tthe_t _tnumber_t _tof_t _titems_t _tin_t _tthis_t _tList_t_t _tfor_t _twhich_t <_tcode_t>_tpredicate_t(_titem_t)</_tcode_t> _treturns_t _ttrue_t.

◆ List_create()

List_t * List_create ( void  )

@_tcond_t _tdoxygenIgnored_t

_tCreates_t _ta_t _tnew_t _tList_t_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.

@_tif_t _tconly_t @_tmemberof_t _tList_t_t @_tendif_t

◆ List_find()

void * List_find ( const List_t lst,
const void *  item1,
ListItemComparator  comparator 
)

@_tif_t _tconly_t @_tmemberof_t _tList_t_t @_tendif_t

_tSearches_t _tthe_t _tList_t_t _tfor_t _tan_t _tentry_t _tthat_t _tmatches_t @_tp_t _titem1_t, _taccording_t _tto_t @_tp_t _tcomparator_t.

◆ List_findIf()

List_t * List_findIf ( const List_t lst,
ListItemPredicate  predicate 
)

@_tif_t _tconly_t @_tmemberof_t _tList_t_t @_tendif_t

_tCreate_t _tand_t _treturn_t _ta_t _tnew_t _tList_t_t _twith_t _tthe_t _tsubset_t _tof_t _titems_t _tfor_t _twhich_t <_tcode_t>_tpredicate_t(_titem_t)</_tcode_t> _treturns_t _ttrue_t.

◆ List_free()

void List_free ( List_t lst)

@_tendcond_t

@_tif_t _tconly_t @_tmemberof_t _tList_t_t @_tendif_t

Examples
printRegisteredPackages.c.

◆ List_get()

void * List_get ( const List_t lst,
unsigned int  n 
)

@_tif_t _tconly_t @_tmemberof_t _tList_t_t @_tendif_t

_tReturns_t _tthe_t _tnth_t _titem_t _tin_t _tthis_t _tList_t_t.

Examples
printRegisteredPackages.c.

◆ List_prepend()

void List_prepend ( List_t lst,
void *  item 
)

@_tif_t _tconly_t @_tmemberof_t _tList_t_t @_tendif_t

_tAdds_t _titem_t _tto_t _tthe_t _tbeginning_t _tof_t _tthis_t _tList_t_t.

◆ List_remove()

void * List_remove ( List_t lst,
unsigned int  n 
)

@_tif_t _tconly_t @_tmemberof_t _tList_t_t @_tendif_t

_tRemoves_t _tthe_t _tnth_t _titem_t _tfrom_t _tthis_t _tList_t_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.

◆ List_size()

unsigned int List_size ( const List_t lst)

@_tif_t _tconly_t @_tmemberof_t _tList_t_t @_tendif_t

_tThe_t _tnumber_t _tof_t _telements_t _tin_t @_tp_t _tlst_t.

Examples
printRegisteredPackages.c.

◆ ListNode_create()

ListNode_t * ListNode_create ( void *  item)

@_tcond_t _tdoxygenLibsbmlInternal_t

_tCreates_t _ta_t _tnew_t _tListNode_t_t (_twith_t @_tp_t _titem_t) _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tthe_t _tnode_t.

@_tparam_t _titem_t _tthe_t _titem_t _tto_t _tcreate_t _ta_t _tListNode_t_t _tfor_t.

_tThe_t _tpointer_t _tthat_t _tis_t _treturned_t _tby_t _tthis_t _tfunction_t _tis_t _towned_t _tby_t _tthe_t _tcaller_t, _twho_t _tis_t _tresponsible_t _tfor_t _tdeleting_t _tit_t.

@_tif_t _tconly_t @_tmemberof_t _tListNode_t_t @_tendif_t

◆ ListNode_free()

void ListNode_free ( ListNode_t *  node)

@_tcond_t _tdoxygenLibsbmlInternal_t

_tFrees_t _tthe_t _tgiven_t _tListNode_t_t.

@_tparam_t _tnode_t _tthe_t _tListNode_t_t _tstructure_t.

@_tmemberof_t _tListNode_t_t