Datatypes:
AjPList | Lists |
AjIList | List iterators |
AjPList | String lists |
AjIList | String list iterators |
Sections:
Constructors | Constructors |
Adding values | Modifiers |
Modifiers | Modifiers |
Removing data | Casts |
Element retrieval | Casts |
Trace functions | Miscellaneous |
Destructors | Destructors |
unused | Miscellaneous |
exit | Miscellaneous |
Functions:
ajListNew | Creates a new general list. |
ajListNewListref | Copy a list. |
ajListNewRef | Makes a reference-counted copy of any list |
AjPList ajListNew ( void );
Type | Name | Read/Write | Description |
---|---|---|---|
AjPList | RETURN | new list; |
From EMBOSS 1.0.0
AjPList ajListNewListref ( const AjPList list );
Type | Name | Read/Write | Description |
---|---|---|---|
const AjPList | list | Input | list to be copied |
AjPList | RETURN | new copied list. |
From EMBOSS 5.0.0
AjPList ajListNewRef ( AjPList list );
Type | Name | Read/Write | Description |
---|---|---|---|
AjPList | list | Modify | list to be given a new reference |
AjPList | RETURN | new list; |
From EMBOSS 6.4.0
Functions:
ajListPush | Add a new node at the start of the list and add the data pointer. |
ajListPushAppend | Add a new node at the end of the list and add the data pointer. |
ajListPushlist | Adds a list to the start of the current list, then deletes the second list. |
void ajListPush ( AjPList list, void* x );
Type | Name | Read/Write | Description |
---|---|---|---|
AjPList | list | Modify | list to be changed. |
void* | x | Modify | Pointer to data. |
void | RETURN |
From EMBOSS 1.0.0
void ajListPushAppend ( AjPList list, void* x );
Type | Name | Read/Write | Description |
---|---|---|---|
AjPList | list | Modify | List to be changed. |
void* | x | Modify | Pointer to data to append. |
void | RETURN |
From EMBOSS 5.0.0
void ajListPushlist ( AjPList list, AjPList* Plist );
Type | Name | Read/Write | Description |
---|---|---|---|
AjPList | list | Modify | List. |
AjPList* | Plist | Delete | List to be merged. |
void | RETURN |
From EMBOSS 5.0.0
Functions:
ajListMap | For each node in the list call function apply. |
ajListPurge | Garbage collect a list |
ajListReverse | Reverse the order of the nodes in an abstract list. |
ajListSort | Sort the items in a list. |
ajListSortTwo | Sort the items in a list using 2 fields in the same object hierarchy. |
ajListSortTwoThree | Sort the items in a list using 3 fields in the same object hierarchy. |
ajListSortTwoUnique | Double-sort the items in a list, and remove duplicates |
ajListSortUnique | Sort the items in a list, and remove duplicates |
void ajListMap ( AjPList list, void function apply, void* cl );
Type | Name | Read/Write | Description |
---|---|---|---|
AjPList | list | Modify | List. |
void function | apply | Function | Function to call for each list item. |
void* | cl | Modify | Standard, usually NULL. |
void | RETURN |
From EMBOSS 1.0.0
void ajListPurge ( AjPList list, AjBool* function test, void* function nodedelete );
Type | Name | Read/Write | Description |
---|---|---|---|
AjPList | list | Modify | List. |
AjBool* function | test | Function | Function to test whether to delete |
void* function | nodedelete | Function | Wrapper function for item destructor |
void | RETURN |
From EMBOSS 5.0.0
void ajListReverse ( AjPList list );
Type | Name | Read/Write | Description |
---|---|---|---|
AjPList | list | Modify | List |
void | RETURN |
From EMBOSS 1.0.0
void ajListSort ( AjPList list, int* function sort1 );
Type | Name | Read/Write | Description |
---|---|---|---|
AjPList | list | Modify | List. |
int* function | sort1 | Function | Function to compare two list items. |
void | RETURN |
From EMBOSS 1.0.0
void ajListSortTwo ( AjPList list, int* function sort1, int* function sort2 );
Type | Name | Read/Write | Description |
---|---|---|---|
AjPList | list | Modify | List. |
int* function | sort1 | Function | 1st function to compare two list items. |
int* function | sort2 | Function | 2nd function to compare two list items. |
void | RETURN |
From EMBOSS 5.0.0
void ajListSortTwoThree ( AjPList list, int* function sort1, int* function sort2, int* function sort3 );
Type | Name | Read/Write | Description |
---|---|---|---|
AjPList | list | Modify | List. |
int* function | sort1 | Function | 1st function to compare two list items. |
int* function | sort2 | Function | 2nd function to compare two list items. |
int* function | sort3 | Function | 3rd function to compare two list items. |
void | RETURN |
From EMBOSS 5.0.0
void ajListSortTwoUnique ( AjPList list, int* function sort1, int* function sort2, void* function nodedelete );
Type | Name | Read/Write | Description |
---|---|---|---|
AjPList | list | Modify | List. |
int* function | sort1 | Function | Function to compare two list items. |
int* function | sort2 | Function | Function to compare two list items. |
void* function | nodedelete | Function | Function to delete an item |
void | RETURN |
From EMBOSS 5.0.0
void ajListSortUnique ( AjPList list, int* function sort1, void* function nodedelete );
Type | Name | Read/Write | Description |
---|---|---|---|
AjPList | list | Modify | List. |
int* function | sort1 | Function | Function to compare two list items. |
void* function | nodedelete | Function | Function to delete an item |
void | RETURN |
From EMBOSS 5.0.0
Functions:
ajListPop | remove the first node but set pointer to data first. |
ajListPopLast | remove the last node but set pointer to data first. |
AjBool ajListPop ( AjPList list, void** x );
Type | Name | Read/Write | Description |
---|---|---|---|
AjPList | list | Modify | List |
void** | x | Output | pointer to pointer to data |
AjBool | RETURN | ajTrue on success. |
From EMBOSS 1.0.0
AjBool ajListPopLast ( AjPList list, void** x );
Type | Name | Read/Write | Description |
---|---|---|---|
AjPList | list | Modify | List |
void** | x | Output | pointer to pointer to data |
AjBool | RETURN | ajTrue on success. |
From EMBOSS 5.0.0
Functions:
ajListGetLength | get the number of nodes in the linked list. |
ajListMapfind | For each node in the list call function 'apply' and return ajTrue when any node is matched by the function. |
ajListMapread | For each node in the list call function apply. The apply function must not modify the list elements. |
ajListPeek | Return the first node but keep it on the list |
ajListPeekFirst | Set pointer to first node's data. Does NOT remove the first node. |
ajListPeekLast | Set pointer to last node's data. Does NOT remove the last node. |
ajListPeekNumber | Set pointer to last node's nth data item. 0 <= n < number of elements. |
ajListToarray | Create an array of the pointers to the data. |
ajListToindex | Create an array of the pointers to the data. |
ajuint ajListGetLength ( const AjPList list );
Type | Name | Read/Write | Description |
---|---|---|---|
const AjPList | list | Input | List |
ajuint | RETURN | Number of nodes in list. |
From EMBOSS 5.0.0
AjBool ajListMapfind ( const AjPList list, AjBool function apply, void* cl );
Type | Name | Read/Write | Description |
---|---|---|---|
const AjPList | list | Input | List |
AjBool function | apply | Function | Function to call to test each list item. |
void* | cl | Modify | Standard, usually NULL. |
AjBool | RETURN | ajTrue on success. |
From EMBOSS 5.0.0
void ajListMapread ( const AjPList list, void function apply, void* cl );
Type | Name | Read/Write | Description |
---|---|---|---|
const AjPList | list | Input | List. |
void function | apply | Function | Function to call for each list item. |
void* | cl | Modify | Standard, usually NULL. |
void | RETURN |
From EMBOSS 5.0.0
AjBool ajListPeek ( const AjPList list, void** x );
Type | Name | Read/Write | Description |
---|---|---|---|
const AjPList | list | Input | List |
void** | x | Output | pointer to pointer to data |
AjBool | RETURN | ajTrue on success. |
From EMBOSS 2.7.0
AjBool ajListPeekFirst ( const AjPList list, void** x );
Type | Name | Read/Write | Description |
---|---|---|---|
const AjPList | list | Input | List |
void** | x | Output | pointer to pointer to data |
AjBool | RETURN | ajTrue on success. |
From EMBOSS 5.0.0
AjBool ajListPeekLast ( const AjPList list, void** x );
Type | Name | Read/Write | Description |
---|---|---|---|
const AjPList | list | Input | List |
void** | x | Output | pointer to pointer to data |
AjBool | RETURN | ajTrue on success. |
From EMBOSS 5.0.0
AjBool ajListPeekNumber ( const AjPList list, ajuint ipos, void** x );
Type | Name | Read/Write | Description |
---|---|---|---|
const AjPList | list | Input | List |
ajuint | ipos | Input | element of the list |
void** | x | Output | pointer to pointer to data |
AjBool | RETURN | ajTrue on success. |
From EMBOSS 5.0.0
ajuint ajListToarray ( const AjPList list, void*** array );
Type | Name | Read/Write | Description |
---|---|---|---|
const AjPList | list | Input | List |
void*** | array | Output | Array of pointers to list items. |
ajuint | RETURN | Size of array of pointers. |
From EMBOSS 5.0.0
ajuint ajListToindex ( const AjPList list, ajuint* lind, int* function sort1 );
Type | Name | Read/Write | Description |
---|---|---|---|
const AjPList | list | Input | List |
ajuint* | lind | Output | Populated ndex array to be sorted |
int* function | sort1 | Function | Function to compare two list items. |
ajuint | RETURN | Size of index array. |
From EMBOSS 6.3.0
Functions:
ajListProbe | Test list for memory allocation conflicts |
ajListProbeData | Test list and data for memory allocation conflicts |
ajListTrace | Traces through a list and validates it |
void ajListProbe ( AjPList const* Plist );
Type | Name | Read/Write | Description |
---|---|---|---|
AjPList const* | Plist | Input | List |
void | RETURN |
From EMBOSS 6.0.0
void ajListProbeData ( AjPList const* Plist );
Type | Name | Read/Write | Description |
---|---|---|---|
AjPList const* | Plist | Input | List |
void | RETURN |
From EMBOSS 6.0.0
void ajListTrace ( const AjPList list );
Type | Name | Read/Write | Description |
---|---|---|---|
const AjPList | list | Input | list to be traced. |
void | RETURN |
From EMBOSS 1.0.0
Functions:
ajListFree | Free all nodes in the list. NOTE: The data is only freed with a specified list type. For undefined data types we recommend you to use ajListMap with a routine to free the memory. |
ajListFreeData | Free all nodes in the list. Free all the data values. For more complex data objects use ajListMap with a routine to free the object memory. |
void ajListFree ( AjPList* Plist );
Type | Name | Read/Write | Description |
---|---|---|---|
AjPList* | Plist | Delete | List |
void | RETURN |
From EMBOSS 1.0.0
void ajListFreeData ( AjPList* Plist );
Type | Name | Read/Write | Description |
---|---|---|---|
AjPList* | Plist | Delete | List |
void | RETURN |
From EMBOSS 4.1.0
Functions:
ajListUnused | Dummy function to catch all unused functions defined in ajlist |
void ajListUnused ( void** array );
Type | Name | Read/Write | Description |
---|---|---|---|
void** | array | Input | Array needed by ajListArrayTrace |
void | RETURN |
From EMBOSS 5.0.0
Functions:
ajListExit | Prints a summary of list usage with debug calls |
void ajListExit ( void );
Type | Name | Read/Write | Description |
---|---|---|---|
void | RETURN |
From EMBOSS 2.8.0
Sections:
constructors | Constructors |
tests | General use |
destructors | Destructors |
stepping | Modifiers |
modifiers | Modifiers |
Trace functions | Miscellaneous |
Functions:
ajListIterNew | Creates an iterator to operate from start to end of list. |
ajListIterNewBack | Creates an iterator to operate from end to start of the list. |
ajListIterNewread | Creates an iterator to operate from start to end of read-only list. |
ajListIterNewreadBack | Creates an iterator to operate from end to start of the list. |
AjIList ajListIterNew ( AjPList list );
Type | Name | Read/Write | Description |
---|---|---|---|
AjPList | list | Modify | List Not const in practice - the iterator can insert and delete entries |
AjIList | RETURN | New list iterator |
From EMBOSS 5.0.0
AjIList ajListIterNewBack ( AjPList list );
Type | Name | Read/Write | Description |
---|---|---|---|
AjPList | list | Modify | List Not const - the iterator can insert and delete entries |
AjIList | RETURN | New list iterator |
From EMBOSS 5.0.0
AjIList ajListIterNewread ( const AjPList list );
Type | Name | Read/Write | Description |
---|---|---|---|
const AjPList | list | Input | List Not const in practice - the iterator can insert and delete entries |
AjIList | RETURN | New list iterator |
From EMBOSS 5.0.0
AjIList ajListIterNewreadBack ( const AjPList list );
Type | Name | Read/Write | Description |
---|---|---|---|
const AjPList | list | Input | List |
AjIList | RETURN | New list iterator |
From EMBOSS 5.0.0
Functions:
ajListIterDone | Tests whether an iterator has completed yet. |
ajListIterDoneBack | Tests whether a backwards iterator has completed yet. |
AjBool ajListIterDone ( const AjIList iter );
Type | Name | Read/Write | Description |
---|---|---|---|
const AjIList | iter | Input | List iterator. |
AjBool | RETURN | ajTrue if the iterator is exhausted. |
From EMBOSS 1.0.0
AjBool ajListIterDoneBack ( const AjIList iter );
Type | Name | Read/Write | Description |
---|---|---|---|
const AjIList | iter | Input | List iterator. |
AjBool | RETURN | ajTrue if the iterator is exhausted. |
From EMBOSS 5.0.0
Functions:
ajListIterDel | Destructor for a list iterator. |
void ajListIterDel ( AjIList* iter );
Type | Name | Read/Write | Description |
---|---|---|---|
AjIList* | iter | Delete | List iterator. |
void | RETURN |
From EMBOSS 5.0.0
Functions:
ajListIterGet | Returns next item using iterator, or steps off the end. |
ajListIterGetBack | Returns next item using back iterator. |
void* ajListIterGet ( AjIList iter );
Type | Name | Read/Write | Description |
---|---|---|---|
AjIList | iter | Modify | List iterator. |
void* | RETURN | Data item returned. |
From EMBOSS 5.0.0
void* ajListIterGetBack ( AjIList iter );
Type | Name | Read/Write | Description |
---|---|---|---|
AjIList | iter | Modify | List iterator. |
void* | RETURN | Data item returned. |
From EMBOSS 5.0.0
Functions:
ajListIterInsert | Insert an item in a list, using an iterator (if not null) to show which position to insert. Otherwise, simply push. |
ajListIterRemove | Remove an item from a list, using an iterator (if not null) to show which item. Otherwise remove the first item. |
ajListIterRewind | Resets iterator to start position |
void ajListIterInsert ( AjIList iter, void* x );
Type | Name | Read/Write | Description |
---|---|---|---|
AjIList | iter | Modify | List iterator. |
void* | x | Modify | Data item to insert. |
void | RETURN |
From EMBOSS 5.0.0
void ajListIterRemove ( AjIList iter );
Type | Name | Read/Write | Description |
---|---|---|---|
AjIList | iter | Modify | List iterator. |
void | RETURN |
From EMBOSS 5.0.0
void ajListIterRewind ( AjIList iter );
Type | Name | Read/Write | Description |
---|---|---|---|
AjIList | iter | Modify | List iterator. |
void | RETURN |
From EMBOSS 6.0.0
Functions:
ajListIterTrace | Traces a list iterator and validates it. |
void ajListIterTrace ( const AjIList iter );
Type | Name | Read/Write | Description |
---|---|---|---|
const AjIList | iter | Input | list iterator to be traced. |
void | RETURN |
From EMBOSS 1.0.0
Sections:
Constructors | Constructors |
Adding values | Modifiers |
Modifiers | Modifiers |
Removing data | Casts |
Element retrieval | Casts |
Trace functions | Miscellaneous |
Destructors | Destructors |
Functions:
ajListstrNew | Creates a new string list. |
ajListstrNewList | Copy a list, with copies of all the string values. |
ajListstrNewListref | Copy a string list. |
AjPList ajListstrNew ( void );
Type | Name | Read/Write | Description |
---|---|---|---|
AjPList | RETURN | new list; |
From EMBOSS 1.0.0
AjPList ajListstrNewList ( const AjPList list );
Type | Name | Read/Write | Description |
---|---|---|---|
const AjPList | list | Input | list to be copied |
AjPList | RETURN | new copied list. |
From EMBOSS 5.0.0
AjPList ajListstrNewListref ( const AjPList list );
Type | Name | Read/Write | Description |
---|---|---|---|
const AjPList | list | Input | List to be copied |
AjPList | RETURN | New, copied, list. |
From EMBOSS 5.0.0
Functions:
ajListstrPush | Add a new node at the start of a string list. |
ajListstrPushAppend | Add a new node at the end of the list and add the data pointer. |
ajListstrPushlist | Adds a list to the start of the current list, then deletes the second list. |
void ajListstrPush ( AjPList list, AjPStr x );
Type | Name | Read/Write | Description |
---|---|---|---|
AjPList | list | Modify | list to be changed. |
AjPStr | x | Modify | String data. |
void | RETURN |
From EMBOSS 1.0.0
void ajListstrPushAppend ( AjPList list, AjPStr x );
Type | Name | Read/Write | Description |
---|---|---|---|
AjPList | list | Modify | List to be changed. |
AjPStr | x | Modify | String to append. |
void | RETURN |
From EMBOSS 5.0.0
void ajListstrPushlist ( AjPList list, AjPList* Plist );
Type | Name | Read/Write | Description |
---|---|---|---|
AjPList | list | Modify | List. |
AjPList* | Plist | Delete | List to be merged. |
void | RETURN |
From EMBOSS 5.0.0
Functions:
ajListstrMap | For each node in the list call function apply, with the address of the string and a client pointer. |
ajListstrReverse | Reverse the order of the nodes in a string list. |
void ajListstrMap ( AjPList list, void function apply, void* cl );
Type | Name | Read/Write | Description |
---|---|---|---|
AjPList | list | Modify | List. |
void function | apply | Function | Function to call for each list item. |
void* | cl | Modify | Standard, usually NULL. |
void | RETURN |
From EMBOSS 1.0.0
void ajListstrReverse ( AjPList list );
Type | Name | Read/Write | Description |
---|---|---|---|
AjPList | list | Modify | List |
void | RETURN |
From EMBOSS 1.0.0
Functions:
ajListstrPop | Remove the first node but set pointer to data first. |
ajListstrPopLast | Remove the last node but set pointer to data first. |
AjBool ajListstrPop ( AjPList list, AjPStr* Pstr );
Type | Name | Read/Write | Description |
---|---|---|---|
AjPList | list | Modify | List |
AjPStr* | Pstr | Output | String |
AjBool | RETURN | ajTrue on success. |
From EMBOSS 1.0.0
AjBool ajListstrPopLast ( AjPList list, AjPStr* Pstr );
Type | Name | Read/Write | Description |
---|---|---|---|
AjPList | list | Modify | List |
AjPStr* | Pstr | Output | String |
AjBool | RETURN | ajTrue on success. |
From EMBOSS 5.0.0
Functions:
ajListstrGetLength | get the number of nodes in the linked list. |
ajListstrMapfind | For each node in the list call function apply and return ajTrue when any node is matched by the function. |
ajListstrMapread | For each node in the list call function apply, with the address of the string and a client pointer. The apply function must not modify the list elements. |
ajListstrPeek | Return the first node but keep it on the list. |
ajListstrToarray | create an array of the pointers to the data. |
ajListstrToarrayAppend | append to an array of the pointers to the data. |
ajuint ajListstrGetLength ( const AjPList list );
Type | Name | Read/Write | Description |
---|---|---|---|
const AjPList | list | Input | List |
ajuint | RETURN | Number of nodes in list. |
From EMBOSS 5.0.0
AjBool ajListstrMapfind ( const AjPList list, AjBool function apply, void* cl );
Type | Name | Read/Write | Description |
---|---|---|---|
const AjPList | list | Input | List |
AjBool function | apply | Function | Function to call to test each list item. |
void* | cl | Modify | Standard, usually NULL. |
AjBool | RETURN | ajTrue on success. |
From EMBOSS 5.0.0
void ajListstrMapread ( const AjPList list, void* function apply, void* cl );
Type | Name | Read/Write | Description |
---|---|---|---|
const AjPList | list | Input | List. |
void* function | apply | Function | Function to call for each list item. |
void* | cl | Modify | Standard, usually NULL. |
void | RETURN |
From EMBOSS 5.0.0
AjBool ajListstrPeek ( const AjPList list, AjPStr* Pstr );
Type | Name | Read/Write | Description |
---|---|---|---|
const AjPList | list | Input | List |
AjPStr* | Pstr | Output | String |
AjBool | RETURN | ajTrue on success. |
From EMBOSS 2.7.0
ajuint ajListstrToarray ( const AjPList list, AjPStr** array );
Type | Name | Read/Write | Description |
---|---|---|---|
const AjPList | list | Input | List |
AjPStr** | array | Output | Array of Strings. |
ajuint | RETURN | Size of array of pointers. |
From EMBOSS 5.0.0
ajuint ajListstrToarrayAppend ( const AjPList list, AjPStr** array );
Type | Name | Read/Write | Description |
---|---|---|---|
const AjPList | list | Input | List |
AjPStr** | array | Output | Array of Strings. |
ajuint | RETURN | Size of array of pointers. |
From EMBOSS 5.0.0
Functions:
ajListstrTrace | Traces through a string list and validates it |
void ajListstrTrace ( const AjPList list );
Type | Name | Read/Write | Description |
---|---|---|---|
const AjPList | list | Input | list to be traced. |
void | RETURN |
From EMBOSS 1.0.0
Functions:
ajListstrFree | Free the list. Do not attempt to free the nodes. For use where the node data has been saved elsewhere, for example by ajListToarray or where the list is a temporary structure referring to permanent data. |
ajListstrFreeData | Free all nodes in a string list. Also deletes all the strings. If these are to be preserved, use ajListstrDel instead. |
void ajListstrFree ( AjPList* Plist );
Type | Name | Read/Write | Description |
---|---|---|---|
AjPList* | Plist | Delete | List |
void | RETURN |
From EMBOSS 1.0.0
void ajListstrFreeData ( AjPList* Plist );
Type | Name | Read/Write | Description |
---|---|---|---|
AjPList* | Plist | Delete | List |
void | RETURN |
From EMBOSS 5.0.0
Sections:
stepping | Modifiers |
modifiers | Modifiers |
Trace functions | Miscellaneous |
Functions:
ajListstrIterGet | Returns next item using iterator, or steps off the end. |
ajListstrIterGetBack | Returns next item using back iterator. |
AjPStr ajListstrIterGet ( AjIList iter );
Type | Name | Read/Write | Description |
---|---|---|---|
AjIList | iter | Modify | List iterator. |
AjPStr | RETURN | Data item returned. |
From EMBOSS 6.0.0
AjPStr ajListstrIterGetBack ( AjIList iter );
Type | Name | Read/Write | Description |
---|---|---|---|
AjIList | iter | Modify | List iterator. |
AjPStr | RETURN | Data item returned. |
From EMBOSS 6.0.0
Functions:
ajListstrIterInsert | Insert an item in a list, using an iterator (if not null) to show which position to insert. Otherwise, simply push. |
ajListstrIterRemove | Remove an item from a list, using an iterator (if not null) to show which item. Otherwise remove the first item. |
void ajListstrIterInsert ( AjIList iter, AjPStr str );
Type | Name | Read/Write | Description |
---|---|---|---|
AjIList | iter | Modify | List iterator. |
AjPStr | str | Modify | String to insert. |
void | RETURN |
From EMBOSS 5.0.0
void ajListstrIterRemove ( AjIList iter );
Type | Name | Read/Write | Description |
---|---|---|---|
AjIList | iter | Modify | List iterator. |
void | RETURN |
From EMBOSS 5.0.0
Functions:
ajListstrIterTrace | Traces a list iterator and validates it |
void ajListstrIterTrace ( const AjIList iter );
Type | Name | Read/Write | Description |
---|---|---|---|
const AjIList | iter | Input | List iterator to be traced. |
void | RETURN |
From EMBOSS 1.0.0