ajtable.c

Datatypes:

AjPTable

Hash tables

Datatype: AjPTable

Sections:

Constructors	Constructors
Destructors	Destructors
Retrieval	Casts
Trace functions	Miscellaneous
Adding values	Modifiers
Map function to each value	Modifiers
Modify	Modifiers
Merging	Modifiers
exit	Miscellaneous

AjPTable: Constructors

Functions:

ajTableNew	creates, initialises, and returns a new, empty table that expects a specified number of key-value pairs.
ajTableNewFunctionLen	creates, initialises, and returns a new, empty table that expects a specified number of key-value pairs.

Function ajTableNew

Prototype

AjPTable ajTableNew (
      ajulong size
);

Type	Name	Read/Write	Description
ajulong	size	Input	number of key-value pairs
AjPTable		RETURN	new table.

From EMBOSS 1.0.0

Function ajTableNewFunctionLen

Prototype

AjPTable ajTableNewFunctionLen (
      ajulong size,
      ajint function cmp,
      ajulong function hash,
      void function keydel,
      void function valdel
);

Type	Name	Read/Write	Description
ajulong	size	Input	number of key-value pairs
ajint function	cmp	Function	function for comparing
ajulong function	hash	Function	function for hashing keys
void function	keydel	Function	key destructor function
void function	valdel	Function	value destructor function
AjPTable		RETURN	new table.

From EMBOSS 5.0.0

AjPTable: Destructors

Functions:

ajTableDel	Deallocates and clears a hash table, and any keys or values.
ajTableDelKeydelValdel	Deallocates and clears a hash table, and any keys or values.
ajTableDelValdel	Deallocates and clears a hash table, and any keys or values.
ajTableFree	Deallocates and clears a hash table. Does not clear keys or values.

Function ajTableDel

Prototype

void ajTableDel (
      AjPTable* Ptable
);

Type	Name	Read/Write	Description
AjPTable*	Ptable	Delete	Table (by reference)
void		RETURN

From EMBOSS 6.4.0

Function ajTableDelKeydelValdel

Prototype

void ajTableDelKeydelValdel (
      AjPTable* Ptable,
      void function keydel,
      void function valdel
);

Type	Name	Read/Write	Description
AjPTable*	Ptable	Delete	Table (by reference)
void function	keydel	Function	key destructor
void function	valdel	Function	value destructor
void		RETURN

From EMBOSS 6.4.0

Function ajTableDelValdel

Prototype

void ajTableDelValdel (
      AjPTable* Ptable,
      void function valdel
);

Type	Name	Read/Write	Description
AjPTable*	Ptable	Delete	Table (by reference)
void function	valdel	Function	value destructor
void		RETURN

From EMBOSS 6.4.0

Function ajTableFree

Prototype

void ajTableFree (
      AjPTable* Ptable
);

Type	Name	Read/Write	Description
AjPTable*	Ptable	Delete	Table (by reference)
void		RETURN

From EMBOSS 1.0.0

AjPTable: Retrieval

Functions:

ajTableFetchC	returns the value associated with key in table, or null if table does not hold key.
ajTableFetchS	returns the value associated with key in table, or null if table does not hold key.
ajTableFetchV	Returns the value associated with key in table, or null if table does not hold key.
ajTableFetchmodC	returns the value associated with key in table, or null if table does not hold key.
ajTableFetchmodS	returns the value associated with key in table, or null if table does not hold key.
ajTableFetchmodV	Returns the value associated with key in table, or null if table does not hold key.
ajTableFetchmodTraceV	Returns the value associated with key in table, or null if table does not hold key.
ajTableGetLength	returns the number of key-value pairs in table.
ajTableGetSize	returns the size of the hash array in a table.
ajTableMatchC	Returns true if the key is found in the table
ajTableMatchS	Returns true if the key is found in the table
ajTableMatchV	Returns true if the key is found in the table
ajTableToarrayKeys	creates two N+1 element arrays that holds the N keys in table in an unspecified order and returns the number of elements. The final element of the array is NULL.
ajTableToarrayKeysValues	creates two N+1 element arrays that holds the N key-value pairs in table in an unspecified order and returns the number of elements. The final element of the array is NULL.
ajTableToarrayValues	creates two N+1 element arrays that holds the N values in table in an unspecified order and returns the number of elements. The final element of the array is NULL.

Function ajTableFetchC

Prototype

const void* ajTableFetchC (
      const AjPTable table,
      const char* txtkey
);

Type	Name	Read/Write	Description
const AjPTable	table	Input	table to search
const char*	txtkey	Input	key to find.
const void*		RETURN	value associated with key

From EMBOSS 6.4.0

Function ajTableFetchS

Prototype

const void* ajTableFetchS (
      const AjPTable table,
      const AjPStr key
);

Type	Name	Read/Write	Description
const AjPTable	table	Input	table to search
const AjPStr	key	Input	key to find.
const void*		RETURN	value associated with key

From EMBOSS 6.4.0

Function ajTableFetchV

Prototype

const void* ajTableFetchV (
      const AjPTable table,
      const void* key
);

Type	Name	Read/Write	Description
const AjPTable	table	Input	table to search
const void*	key	Input	key to find.
const void*		RETURN	value associated with key

From EMBOSS 6.4.0

Function ajTableFetchmodC

Prototype

void* ajTableFetchmodC (
      const AjPTable table,
      const char* txtkey
);

Type	Name	Read/Write	Description
const AjPTable	table	Input	table to search
const char*	txtkey	Input	key to find.
void*		RETURN	value associated with key

From EMBOSS 6.4.0

Function ajTableFetchmodS

Prototype

void* ajTableFetchmodS (
      const AjPTable table,
      const AjPStr key
);

Type	Name	Read/Write	Description
const AjPTable	table	Input	table to search
const AjPStr	key	Input	key to find.
void*		RETURN	value associated with key

From EMBOSS 6.4.0

Function ajTableFetchmodV

Prototype

void* ajTableFetchmodV (
      const AjPTable table,
      const void* key
);

Type	Name	Read/Write	Description
const AjPTable	table	Input	table to search
const void*	key	Input	key to find.
void*		RETURN	value associated with key

From EMBOSS 6.4.0

Function ajTableFetchmodTraceV

Prototype

void* ajTableFetchmodTraceV (
      const AjPTable table,
      const void* key
);

Type	Name	Read/Write	Description
const AjPTable	table	Input	table to search
const void*	key	Input	key to find.
void*		RETURN	value associated with key

From EMBOSS 6.4.0

Function ajTableGetLength

Prototype

ajulong ajTableGetLength (
      const AjPTable table
);

Type	Name	Read/Write	Description
const AjPTable	table	Input	Table to be applied.
ajulong		RETURN	number of key-value pairs.

From EMBOSS 5.0.0

Function ajTableGetSize

Prototype

ajulong ajTableGetSize (
      const AjPTable table
);

Type	Name	Read/Write	Description
const AjPTable	table	Input	Table to be applied.
ajulong		RETURN	number of hash array positions

From EMBOSS 6.4.0

Function ajTableMatchC

Prototype

AjBool ajTableMatchC (
      const AjPTable table,
      const char* txtkey
);

Type	Name	Read/Write	Description
const AjPTable	table	Input	table to search
const char*	txtkey	Input	key to find.
AjBool		RETURN	True if key was found[

From EMBOSS 6.4.0

Function ajTableMatchS

Prototype

AjBool ajTableMatchS (
      const AjPTable table,
      const AjPStr key
);

Type	Name	Read/Write	Description
const AjPTable	table	Input	table to search
const AjPStr	key	Input	key to find.
AjBool		RETURN	True if key was found

From EMBOSS 6.4.0

Function ajTableMatchV

Prototype

AjBool ajTableMatchV (
      const AjPTable table,
      const void* key
);

Type	Name	Read/Write	Description
const AjPTable	table	Input	table to search
const void*	key	Input	key to find.
AjBool		RETURN	True if key was found

From EMBOSS 6.4.0

Function ajTableToarrayKeys

Prototype

ajulong ajTableToarrayKeys (
      const AjPTable table,
      void*** keyarray
);

Type	Name	Read/Write	Description
const AjPTable	table	Input	Table
void***	keyarray	Output	NULL terminated array of keys.
ajulong		RETURN	size of array returned

From EMBOSS 6.2.0

Function ajTableToarrayKeysValues

Prototype

ajulong ajTableToarrayKeysValues (
      const AjPTable table,
      void*** keyarray,
      void*** valarray
);

Type	Name	Read/Write	Description
const AjPTable	table	Input	Table
void***	keyarray	Output	NULL terminated array of keys.
void***	valarray	Output	NULL terminated array of values.
ajulong		RETURN	size of arrays returned

From EMBOSS 6.2.0

Function ajTableToarrayValues

Prototype

ajulong ajTableToarrayValues (
      const AjPTable table,
      void*** valarray
);

Type	Name	Read/Write	Description
const AjPTable	table	Input	Table
void***	valarray	Output	NULL terminated array of values.
ajulong		RETURN	size of array returned

From EMBOSS 6.2.0

AjPTable: Trace functions

Functions:

ajTableTrace

Writes debug messages to trace the contents of a table.

Function ajTableTrace

Prototype

void ajTableTrace (
      const AjPTable table
);

Type	Name	Read/Write	Description
const AjPTable	table	Input	Table
void		RETURN

From EMBOSS 1.0.0

AjPTable: Adding values

Functions:

ajTablePut	change the value associated with key in table to value and returns the previous value, or adds key and value if table does not hold key, and returns null.
ajTablePutClean	change the value associated with key in table to value and returns the previous value, applying destructors to the given key and value, or adds key and value if table does not hold key, and returns null.
ajTablePutTrace	change the value associated with key in table to value and returns the previous value, or adds key and value if table does not hold key, and returns null. Trace the internals as the value is inserted.
ajTableRemove	Removes the key-value pair from table and returns the removed value. If table does not hold key, ajTableRemove has no effect and returns null.
ajTableRemoveKey	Removes the key-value pair from table and returns the removed value. If table does not hold key, ajTableRemove has no effect and returns null.

Function ajTablePut

Prototype

void* ajTablePut (
      AjPTable table,
      void* key,
      void* value
);

Type	Name	Read/Write	Description
AjPTable	table	Modify	Table to add to
void*	key	Unknown	key
void*	value	Modify	value of key
void*		RETURN	previous value if key exists, NULL if not.

From EMBOSS 1.0.0

Function ajTablePutClean

Prototype

AjBool ajTablePutClean (
      AjPTable table,
      void* key,
      void* value,
      void function keydel,
      void function valdel
);

Type	Name	Read/Write	Description
AjPTable	table	Modify	Table to add to
void*	key	Unknown	key
void*	value	Modify	value of key
void function	keydel	Function	key destructor
void function	valdel	Function	value destructor
AjBool		RETURN	previous value was found and deleted.

From EMBOSS 6.4.0

Function ajTablePutTrace

Prototype

void* ajTablePutTrace (
      AjPTable table,
      void* key,
      void* value
);

Type	Name	Read/Write	Description
AjPTable	table	Modify	Table to add to
void*	key	Unknown	key
void*	value	Modify	value of key
void*		RETURN	previous value if key exists, NULL if not.

From EMBOSS 6.4.0

Function ajTableRemove

Prototype

void* ajTableRemove (
      AjPTable table,
      const void* key
);

Type	Name	Read/Write	Description
AjPTable	table	Modify	Table
const void*	key	Input	key to be removed
void*		RETURN	removed value.

From EMBOSS 1.0.0

Function ajTableRemoveKey

Prototype

void* ajTableRemoveKey (
      AjPTable table,
      const void* key,
      void** truekey
);

Type	Name	Read/Write	Description
AjPTable	table	Modify	Table
const void*	key	Input	key to be removed
void**	truekey	Output	true internal key returned, now owned by caller
void*		RETURN	removed value.

From EMBOSS 5.0.0

AjPTable: Map function to each value

Functions:

ajTableMap	calls function 'apply' for each key-value in table in an unspecified order. The table keys should not be modified by function 'apply' although values can be updated.
ajTableMapDel	calls function 'apply' for each key-value in table in an unspecified order.

Function ajTableMap

Prototype

void ajTableMap (
      AjPTable table,
      void function apply,
      void* cl
);

Type	Name	Read/Write	Description
AjPTable	table	Modify	Table.
void function	apply	Function	function to be applied
void*	cl	Modify	Standard. Usually NULL. To be passed to apply
void		RETURN

From EMBOSS 1.0.0

Function ajTableMapDel

Prototype

void ajTableMapDel (
      AjPTable table,
      void function apply,
      void* cl
);

Type	Name	Read/Write	Description
AjPTable	table	Modify	Table.
void function	apply	Function	function to be applied
void*	cl	Modify	Standard. Usually NULL. To be passed to apply
void		RETURN

From EMBOSS 2.9.0

AjPTable: Modify

Functions:

ajTableClear	Clears a hash table. Does not clear keys or values.
ajTableClearDelete	Clears a hash table. Deletes all keys or values.
ajTableResizeCount	Resizes a hash table to a new number of expected values.
ajTableResizeHashsize	Resizes a hash table to a new size.
ajTableSetDestroy	Sets the destructor functions for keys and values
ajTableSetDestroyboth	Sets the destructor functions values to be the same as for keys
ajTableSetDestroykey	Sets the destructor functions for keys
ajTableSetDestroyvalue	Sets the destructor functions for values
ajTableSettypeChar	Resets a hash table to use C character string keys
ajTableSettypeCharCase	Resets a hash table to use case-insensitive C character string keys
ajTableSettypeDefault	Resets a hash table to use default keys
ajTableSettypeInt	Resets a hash table to use integer keys
ajTableSettypeLong	Resets a hash table to use long integer keys
ajTableSettypeString	Resets a hash table to use string keys
ajTableSettypeStringCase	Resets a hash table to use case-insensitive string keys
ajTableSettypeUint	Resets a hash table to use unsigned integer keys
ajTableSettypeUlong	Resets a hash table to use unsigned long integer keys
ajTableSettypeUser	Resets a hash table to use user-defined keys

Function ajTableClear

Prototype

void ajTableClear (
      AjPTable table
);

Type	Name	Read/Write	Description
AjPTable	table	Modify	Table
void		RETURN

From EMBOSS 6.4.0

Function ajTableClearDelete

Prototype

void ajTableClearDelete (
      AjPTable table
);

Type	Name	Read/Write	Description
AjPTable	table	Modify	Table
void		RETURN

From EMBOSS 6.4.0

Function ajTableResizeCount

Prototype

void ajTableResizeCount (
      AjPTable table,
      ajulong size
);

Type	Name	Read/Write	Description
AjPTable	table	Modify	Table
ajulong	size	Input	Expected number of key-value pairs
void		RETURN

From EMBOSS 6.4.0

Function ajTableResizeHashsize

Prototype

void ajTableResizeHashsize (
      AjPTable table,
      ajulong hashsize
);

Type	Name	Read/Write	Description
AjPTable	table	Modify	Table
ajulong	hashsize	Input	Expected number of key-value pairs
void		RETURN

From EMBOSS 6.4.0

Function ajTableSetDestroy

Prototype

void ajTableSetDestroy (
      AjPTable table,
      void function keydel,
      void function valdel
);

Type	Name	Read/Write	Description
AjPTable	table	Modify	Table
void function	keydel	Function	key destructor function
void function	valdel	Function	value destructor function
void		RETURN

From EMBOSS 6.4.0

Function ajTableSetDestroyboth

Prototype

void ajTableSetDestroyboth (
      AjPTable table
);

Type	Name	Read/Write	Description
AjPTable	table	Modify	Table
void		RETURN

From EMBOSS 6.4.0

Function ajTableSetDestroykey

Prototype

void ajTableSetDestroykey (
      AjPTable table,
      void function keydel
);

Type	Name	Read/Write	Description
AjPTable	table	Modify	Table
void function	keydel	Function	key destructor function
void		RETURN

From EMBOSS 6.4.0

Function ajTableSetDestroyvalue

Prototype

void ajTableSetDestroyvalue (
      AjPTable table,
      void function valdel
);

Type	Name	Read/Write	Description
AjPTable	table	Modify	Table
void function	valdel	Function	value destructor function
void		RETURN

From EMBOSS 6.4.0

Function ajTableSettypeChar

Prototype

void ajTableSettypeChar (
      AjPTable table
);

Type	Name	Read/Write	Description
AjPTable	table	Modify	Hash table
void		RETURN

From EMBOSS 6.4.0

Function ajTableSettypeCharCase

Prototype

void ajTableSettypeCharCase (
      AjPTable table
);

Type	Name	Read/Write	Description
AjPTable	table	Modify	Hash table
void		RETURN

From EMBOSS 6.4.0

Function ajTableSettypeDefault

Prototype

void ajTableSettypeDefault (
      AjPTable table
);

Type	Name	Read/Write	Description
AjPTable	table	Modify	Hash table
void		RETURN

From EMBOSS 6.4.0

Function ajTableSettypeInt

Prototype

void ajTableSettypeInt (
      AjPTable table
);

Type	Name	Read/Write	Description
AjPTable	table	Modify	Hash table
void		RETURN

From EMBOSS 6.4.0

Function ajTableSettypeLong

Prototype

void ajTableSettypeLong (
      AjPTable table
);

Type	Name	Read/Write	Description
AjPTable	table	Modify	Hash table
void		RETURN

From EMBOSS 6.4.0

Function ajTableSettypeString

Prototype

void ajTableSettypeString (
      AjPTable table
);

Type	Name	Read/Write	Description
AjPTable	table	Modify	Hash table
void		RETURN

From EMBOSS 6.4.0

Function ajTableSettypeStringCase

Prototype

void ajTableSettypeStringCase (
      AjPTable table
);

Type	Name	Read/Write	Description
AjPTable	table	Modify	Hash table
void		RETURN

From EMBOSS 6.4.0

Function ajTableSettypeUint

Prototype

void ajTableSettypeUint (
      AjPTable table
);

Type	Name	Read/Write	Description
AjPTable	table	Modify	Hash table
void		RETURN

From EMBOSS 6.4.0

Function ajTableSettypeUlong

Prototype

void ajTableSettypeUlong (
      AjPTable table
);

Type	Name	Read/Write	Description
AjPTable	table	Modify	Hash table
void		RETURN

From EMBOSS 6.4.0

Function ajTableSettypeUser

Prototype

void ajTableSettypeUser (
      AjPTable table,
      ajint function cmp,
      ajulong function hash
);

Type	Name	Read/Write	Description
AjPTable	table	Modify	Hash table
ajint function	cmp	Function	function for comparing
ajulong function	hash	Function	function for hashing keys
void		RETURN

From EMBOSS 6.4.0

AjPTable: Merging

Functions:

ajTableMergeAnd	Merge two tables, keeping all keys that are in both tables
ajTableMergeEor	Merge two tables, keeping all keys that are in only one table
ajTableMergeNot	Merge two tables, removing all keys that are not in the new table
ajTableMergeOr	Merge two tables, adding all unique keys from the new table

Function ajTableMergeAnd

Prototype

AjBool ajTableMergeAnd (
      AjPTable thys,
      AjPTable table
);

Type	Name	Read/Write	Description
AjPTable	thys	Modify	Current table
AjPTable	table	Modify	Table to be merged
AjBool		RETURN	True on success

From EMBOSS 6.4.0

Function ajTableMergeEor

Prototype

AjBool ajTableMergeEor (
      AjPTable thys,
      AjPTable table
);

Type	Name	Read/Write	Description
AjPTable	thys	Modify	Current table
AjPTable	table	Modify	Table to be merged
AjBool		RETURN	True on success

From EMBOSS 6.4.0

Function ajTableMergeNot

Prototype

AjBool ajTableMergeNot (
      AjPTable thys,
      AjPTable table
);

Type	Name	Read/Write	Description
AjPTable	thys	Modify	Current table
AjPTable	table	Modify	Table to be merged
AjBool		RETURN	True on success

From EMBOSS 6.4.0

Function ajTableMergeOr

Prototype

AjBool ajTableMergeOr (
      AjPTable thys,
      AjPTable table
);

Type	Name	Read/Write	Description
AjPTable	thys	Modify	Current table
AjPTable	table	Modify	Table to be merged
AjBool		RETURN	True on success

From EMBOSS 6.4.0

AjPTable: exit

Functions:

ajTableExit

Prints a summary of table usage with debug calls

Function ajTableExit

Prototype

void ajTableExit (
      void
);

Type	Name	Read/Write	Description
void		RETURN

From EMBOSS 2.8.0

AjPTable: Constructors

Functions:

ajTablecharNew	Creates a table with a character string key.
ajTablecharNewCase	Creates a table with a character string key and case insensitive searching.
ajTablecharNewCaseConst	Creates a table with a character string key and case insensitive searching.
ajTablecharNewConst	Creates a table with a character string key.

Function ajTablecharNew

Prototype

AjPTable ajTablecharNew (
      ajulong size
);

Type	Name	Read/Write	Description
ajulong	size	Input	number of key-value pairs
AjPTable		RETURN	New table object with a character string key.

From EMBOSS 5.0.0

Function ajTablecharNewCase

Prototype

AjPTable ajTablecharNewCase (
      ajulong size
);

Type	Name	Read/Write	Description
ajulong	size	Input	Hash size estimate.
AjPTable		RETURN	New table object with a character string key.

From EMBOSS 5.0.0

Function ajTablecharNewCaseConst

Prototype

AjPTable ajTablecharNewCaseConst (
      ajulong size
);

Type	Name	Read/Write	Description
ajulong	size	Input	Hash size estimate.
AjPTable		RETURN	New table object with a character string key.

From EMBOSS 6.4.0

Function ajTablecharNewConst

Prototype

AjPTable ajTablecharNewConst (
      ajulong size
);

Type	Name	Read/Write	Description
ajulong	size	Input	number of key-value pairs
AjPTable		RETURN	New table object with a character string key.

From EMBOSS 6.4.0

AjPTable: Trace functions

Functions:

ajTablecharPrint

Print function for a table with a character string key.

Function ajTablecharPrint

Prototype

void ajTablecharPrint (
      const AjPTable table
);

Type	Name	Read/Write	Description
const AjPTable	table	Input	Table.
void		RETURN

From EMBOSS 5.0.0

AjPTable: Comparison functions

Functions:

ajTablecharCmp	Comparison function for a table with a character string key
ajTablecharCmpCase	Comparison function for a table with a character string key and case insensitivity.
ajTablecharHash	Hash function for a table with a character string key
ajTablecharHashCase	Hash function for a table with a character string key and case insensitivity.

Function ajTablecharCmp

Prototype

ajint ajTablecharCmp (
      const void* key1,
      const void* key2
);

Type	Name	Read/Write	Description
const void*	key1	Input	First key.
const void*	key2	Input	Second key.
ajint		RETURN	Comparison result. Zero if equal, non-zero if different.

From EMBOSS 5.0.0

Function ajTablecharCmpCase

Prototype

ajint ajTablecharCmpCase (
      const void* key1,
      const void* key2
);

Type	Name	Read/Write	Description
const void*	key1	Input	First key.
const void*	key2	Input	Second key.
ajint		RETURN	Comparison result. Zero if equal, non-zero if different.

From EMBOSS 5.0.0

Function ajTablecharHash

Prototype

ajulong ajTablecharHash (
      const void* key,
      ajulong hashsize
);

Type	Name	Read/Write	Description
const void*	key	Input	Standard argument. Table key.
ajulong	hashsize	Input	Standard argument. Estimated Hash size.
ajulong		RETURN	Hash value.

From EMBOSS 5.0.0

Function ajTablecharHashCase

Prototype

ajulong ajTablecharHashCase (
      const void* key,
      ajulong hashsize
);

Type	Name	Read/Write	Description
const void*	key	Input	Standard argument. Table key.
ajulong	hashsize	Input	Standard argument. Estimated Hash size.
ajulong		RETURN	Hash value.

From EMBOSS 5.0.0

AjPTable: Constructors

Functions:

ajTableintNew	Creates, initialises, and returns a new, empty table that can hold a specified number of integer key-value pairs.
ajTableintNewConst	Creates, initialises, and returns a new, empty table that can hold a specified number of integer key-value pairs.

Function ajTableintNew

Prototype

AjPTable ajTableintNew (
      ajulong size
);

Type	Name	Read/Write	Description
ajulong	size	Input	estimate of number of unique keys
AjPTable		RETURN	new table.

From EMBOSS 6.4.0

Function ajTableintNewConst

Prototype

AjPTable ajTableintNewConst (
      ajulong size
);

Type	Name	Read/Write	Description
ajulong	size	Input	estimate of number of unique keys
AjPTable		RETURN	new table.

From EMBOSS 6.4.0

AjPTable: Destructors

Functions:

ajTableintFree	Free keys and value strings in a table and free the table. Use only where the keys and data in the table are real, and not just copies of pointers. Otherwise a call to ajTableFree is enough.
ajTableintFreeKey	Free keys and value strings in a table and free the table. Use only where the keys in the table are real, and not just copies of pointers. Otherwise a call to ajTableFree is enough.

Function ajTableintFree

Prototype

void ajTableintFree (
      AjPTable* Ptable
);

Type	Name	Read/Write	Description
AjPTable*	Ptable	Delete	Table
void		RETURN

From EMBOSS 6.4.0

Function ajTableintFreeKey

Prototype

void ajTableintFreeKey (
      AjPTable* Ptable
);

Type	Name	Read/Write	Description
AjPTable*	Ptable	Delete	Table
void		RETURN

From EMBOSS 6.4.0

AjPTable: Retrieval

Functions:

ajTableintFetch

returns the value associated with key in table, or null if table does not hold key.

Function ajTableintFetch

Prototype

const ajint* ajTableintFetch (
      const AjPTable table,
      const ajint* intkey
);

Type	Name	Read/Write	Description
const AjPTable	table	Input	table to search
const ajint*	intkey	Input	key to find.
const ajint*		RETURN	value associated with key

From EMBOSS 6.4.0

AjPTable: Modify

Functions:

ajTableintFetchmod

returns the value associated with key in table, or null if table does not hold key.

Function ajTableintFetchmod

Prototype

ajint* ajTableintFetchmod (
      AjPTable table,
      const ajint* intkey
);

Type	Name	Read/Write	Description
AjPTable	table	Modify	table to search
const ajint*	intkey	Input	key to find.
ajint*		RETURN	value associated with key

From EMBOSS 6.4.0

AjPTable: Comparison functions

Functions:

ajTableintCmp	Comparison function for a table with an integer key
ajTableintHash	Hash function for a table with an integer key

Function ajTableintCmp

Prototype

ajint ajTableintCmp (
      const void* key1,
      const void* key2
);

Type	Name	Read/Write	Description
const void*	key1	Input	First key.
const void*	key2	Input	Second key.
ajint		RETURN	Comparison result. Zero if equal, non-zero if different.

From EMBOSS 6.4.0

Function ajTableintHash

Prototype

ajulong ajTableintHash (
      const void* key,
      ajulong hashsize
);

Type	Name	Read/Write	Description
const void*	key	Input	Standard argument. Table key.
ajulong	hashsize	Input	Standard argument. Estimated Hash size.
ajulong		RETURN	Hash value in range 0 to hashsize-1

From EMBOSS 6.4.0

AjPTable: Constructors

Functions:

ajTablelongNew	Creates, initialises, and returns a new, empty table that can hold a specified number of long integer key-value pairs.
ajTablelongNewConst	Creates, initialises, and returns a new, empty table that can hold a specified number of long integer key-value pairs.

Function ajTablelongNew

Prototype

AjPTable ajTablelongNew (
      ajulong size
);

Type	Name	Read/Write	Description
ajulong	size	Input	estimate of number of unique keys
AjPTable		RETURN	new table.

From EMBOSS 6.4.0

Function ajTablelongNewConst

Prototype

AjPTable ajTablelongNewConst (
      ajulong size
);

Type	Name	Read/Write	Description
ajulong	size	Input	estimate of number of unique keys
AjPTable		RETURN	new table.

From EMBOSS 6.4.0

AjPTable: Destructors

Functions:

ajTablelongFree	Free keys and value strings in a table and free the table. Use only where the keys and data in the table are real, and not just copies of pointers. Otherwise a call to ajTableFree is enough.
ajTablelongFreeKey	Free keys and value strings in a table and free the table. Use only where the keys in the table are real, and not just copies of pointers. Otherwise a call to ajTableFree is enough.

Function ajTablelongFree

Prototype

void ajTablelongFree (
      AjPTable* Ptable
);

Type	Name	Read/Write	Description
AjPTable*	Ptable	Delete	Table
void		RETURN

From EMBOSS 6.4.0

Function ajTablelongFreeKey

Prototype

void ajTablelongFreeKey (
      AjPTable* Ptable
);

Type	Name	Read/Write	Description
AjPTable*	Ptable	Delete	Table
void		RETURN

From EMBOSS 6.4.0

AjPTable: Retrieval

Functions:

ajTablelongFetch

returns the value associated with key in table, or null if table does not hold key.

Function ajTablelongFetch

Prototype

const ajlong* ajTablelongFetch (
      const AjPTable table,
      const ajlong* longkey
);

Type	Name	Read/Write	Description
const AjPTable	table	Input	table to search
const ajlong*	longkey	Input	key to find.
const ajlong*		RETURN	value associated with key

From EMBOSS 6.4.0

AjPTable: Modify

Functions:

ajTablelongFetchmod

returns the value associated with key in table, or null if table does not hold key.

Function ajTablelongFetchmod

Prototype

ajlong* ajTablelongFetchmod (
      AjPTable table,
      const ajlong* longkey
);

Type	Name	Read/Write	Description
AjPTable	table	Modify	table to search
const ajlong*	longkey	Input	key to find.
ajlong*		RETURN	value associated with key

From EMBOSS 6.4.0

AjPTable: Comparison functions

Functions:

ajTablelongCmp	Comparison function for a table with a long integer key
ajTablelongHash	Hash function for a table with a long integer key

Function ajTablelongCmp

Prototype

ajint ajTablelongCmp (
      const void* key1,
      const void* key2
);

Type	Name	Read/Write	Description
const void*	key1	Input	First key.
const void*	key2	Input	Second key.
ajint		RETURN	Comparison result. Zero if equal, non-zero if different.

From EMBOSS 6.4.0

Function ajTablelongHash

Prototype

ajulong ajTablelongHash (
      const void* key,
      ajulong hashsize
);

Type	Name	Read/Write	Description
const void*	key	Input	Standard argument. Table key.
ajulong	hashsize	Input	Standard argument. Estimated Hash size.
ajulong		RETURN	Hash value in range 0 to hashsize-1

From EMBOSS 6.4.0

AjPTable: Constructors

Functions:

ajTablestrNew	Creates, initialises, and returns a new, empty table that can hold a specified number of key-value pairs.
ajTablestrNewCase	Creates, initialises, and returns a new, empty table that can hold a specified number of key-value pairs.
ajTablestrNewCaseConst	Creates, initialises, and returns a new, empty table that can hold a specified number of key-value pairs.
ajTablestrNewConst	Creates, initialises, and returns a new, empty table that can hold a specified number of key-value pairs.

Function ajTablestrNew

Prototype

AjPTable ajTablestrNew (
      ajulong size
);

Type	Name	Read/Write	Description
ajulong	size	Input	estimate of number of unique keys
AjPTable		RETURN	new table.

From EMBOSS 5.0.0

Function ajTablestrNewCase

Prototype

AjPTable ajTablestrNewCase (
      ajulong size
);

Type	Name	Read/Write	Description
ajulong	size	Input	estimate of number of unique keys
AjPTable		RETURN	new table.

From EMBOSS 5.0.0

Function ajTablestrNewCaseConst

Prototype

AjPTable ajTablestrNewCaseConst (
      ajulong size
);

Type	Name	Read/Write	Description
ajulong	size	Input	estimate of number of unique keys
AjPTable		RETURN	new table.

From EMBOSS 6.4.0

Function ajTablestrNewConst

Prototype

AjPTable ajTablestrNewConst (
      ajulong size
);

Type	Name	Read/Write	Description
ajulong	size	Input	estimate of number of unique keys
AjPTable		RETURN	new table.

From EMBOSS 6.4.0

AjPTable: Destructors

Functions:

ajTablestrFree	Free keys and value strings in a table and free the table. Use only where the keys and strings in the table are real, and not just copies of pointers. Otherwise a call to ajTableFree is enough.
ajTablestrFreeKey	Free string keys in a table and free the table. Do not free the values. Use only where the keys in the table are real strings, and not just copies of pointers. Otherwise a call to ajTableFree is enough. The data is simply freed.

Function ajTablestrFree

Prototype

void ajTablestrFree (
      AjPTable* Ptable
);

Type	Name	Read/Write	Description
AjPTable*	Ptable	Delete	Table
void		RETURN

From EMBOSS 5.0.0

Function ajTablestrFreeKey

Prototype

void ajTablestrFreeKey (
      AjPTable* Ptable
);

Type	Name	Read/Write	Description
AjPTable*	Ptable	Delete	Table
void		RETURN

From EMBOSS 5.0.0

AjPTable: Retrieval

Functions:

ajTablestrFetchC	returns the value associated with key in table, or null if table does not hold key.
ajTablestrFetchS	returns the value associated with key in table, or null if table does not hold key.
ajTablestrFetchkeyC	returns the key value associated with key in table, or null if table does not hold key.
ajTablestrFetchkeyS	returns the key value associated with key in table, or null if table does not hold key.

Function ajTablestrFetchC

Prototype

void* ajTablestrFetchC (
      const AjPTable table,
      const char* txtkey
);

Type	Name	Read/Write	Description
const AjPTable	table	Input	table to search
const char*	txtkey	Input	key to find.
void*		RETURN	value associated with key

From EMBOSS 6.4.0

Function ajTablestrFetchS

Prototype

void* ajTablestrFetchS (
      const AjPTable table,
      const AjPStr key
);

Type	Name	Read/Write	Description
const AjPTable	table	Input	table to search
const AjPStr	key	Input	key to find.
void*		RETURN	value associated with key

From EMBOSS 6.4.0

Function ajTablestrFetchkeyC

Prototype

const AjPStr ajTablestrFetchkeyC (
      const AjPTable table,
      const char* txtkey
);

Type	Name	Read/Write	Description
const AjPTable	table	Input	table to search
const char*	txtkey	Input	key to find.
const AjPStr		RETURN	key value as stored in the table

From EMBOSS 6.4.0

Function ajTablestrFetchkeyS

Prototype

const AjPStr ajTablestrFetchkeyS (
      const AjPTable table,
      const AjPStr key
);

Type	Name	Read/Write	Description
const AjPTable	table	Input	table to search
const AjPStr	key	Input	key to find.
const AjPStr		RETURN	key value as stored in the table

From EMBOSS 6.4.0

AjPTable: Modify

Functions:

ajTablestrFetchmod

returns the value associated with key in table, or null if table does not hold key.

Function ajTablestrFetchmod

Prototype

AjPStr* ajTablestrFetchmod (
      AjPTable table,
      const AjPStr key
);

Type	Name	Read/Write	Description
AjPTable	table	Modify	table to search
const AjPStr	key	Input	key to find.
AjPStr*		RETURN	value associated with key

From EMBOSS 6.0.0

AjPTable: Comparison functions

Functions:

ajTablestrCmp	Comparison function for a table with a string key
ajTablestrCmpCase	Comparison function for a table with a string key and case insensitivity.
ajTablestrHash	Hash function for a table with a string key
ajTablestrHashCase	Hash function for a table with a string key and case insensitivity.

Function ajTablestrCmp

Prototype

ajint ajTablestrCmp (
      const void* key1,
      const void* key2
);

Type	Name	Read/Write	Description
const void*	key1	Input	First key.
const void*	key2	Input	Second key.
ajint		RETURN	Comparison result. Zero if equal, non-zero if different.

From EMBOSS 5.0.0

Function ajTablestrCmpCase

Prototype

ajint ajTablestrCmpCase (
      const void* key1,
      const void* key2
);

Type	Name	Read/Write	Description
const void*	key1	Input	First key.
const void*	key2	Input	Second key.
ajint		RETURN	Comparison result. Zero if equal, non-zero if different.

From EMBOSS 5.0.0

Function ajTablestrHash

Prototype

ajulong ajTablestrHash (
      const void* key,
      ajulong hashsize
);

Type	Name	Read/Write	Description
const void*	key	Input	Standard argument. Table key.
ajulong	hashsize	Input	Standard argument. Estimated Hash size.
ajulong		RETURN	Hash value in range 0 to hashsize-1

From EMBOSS 5.0.0

Function ajTablestrHashCase

Prototype

ajulong ajTablestrHashCase (
      const void* key,
      ajulong hashsize
);

Type	Name	Read/Write	Description
const void*	key	Input	Standard argument. Table key.
ajulong	hashsize	Input	Standard argument. Estimated Hash size.
ajulong		RETURN	Hash value in range 0 to hashsize-1

From EMBOSS 5.0.0

AjPTable: Trace functions

Functions:

ajTablestrPrint	Print function for a table with a string key.
ajTablestrTrace	Writes debug messages to trace the contents of a table, assuming all keys and values are strings.
ajTablestrTracekeys	Writes debug messages to trace the keys of a string table, assuming all keys and values are strings.

Function ajTablestrPrint

Prototype

void ajTablestrPrint (
      const AjPTable table
);

Type	Name	Read/Write	Description
const AjPTable	table	Input	Table.
void		RETURN

From EMBOSS 5.0.0

Function ajTablestrTrace

Prototype

void ajTablestrTrace (
      const AjPTable table
);

Type	Name	Read/Write	Description
const AjPTable	table	Input	Table
void		RETURN

From EMBOSS 5.0.0

Function ajTablestrTracekeys

Prototype

void ajTablestrTracekeys (
      const AjPTable table
);

Type	Name	Read/Write	Description
const AjPTable	table	Input	Table
void		RETURN

From EMBOSS 6.4.0

AjPTable: Constructors

Functions:

ajTableuintNew	Creates, initialises, and returns a new, empty table that can hold a specified number of unsigned integer key-value pairs.
ajTableuintNewConst	Creates, initialises, and returns a new, empty table that can hold a specified number of unsigned integer key-value pairs.

Function ajTableuintNew

Prototype

AjPTable ajTableuintNew (
      ajulong size
);

Type	Name	Read/Write	Description
ajulong	size	Input	estimate of number of unique keys
AjPTable		RETURN	new table.

From EMBOSS 6.4.0

Function ajTableuintNewConst

Prototype

AjPTable ajTableuintNewConst (
      ajulong size
);

Type	Name	Read/Write	Description
ajulong	size	Input	estimate of number of unique keys
AjPTable		RETURN	new table.

From EMBOSS 6.4.0

AjPTable: Destructors

Functions:

ajTableuintFree	Free keys and value strings in a table and free the table. Use only where the keys and data in the table are real, and not just copies of pointers. Otherwise a call to ajTableFree is enough.
ajTableuintFreeKey	Free keys and value strings in a table and free the table. Use only where the keys in the table are real, and not just copies of pointers. Otherwise a call to ajTableFree is enough.

Function ajTableuintFree

Prototype

void ajTableuintFree (
      AjPTable* Ptable
);

Type	Name	Read/Write	Description
AjPTable*	Ptable	Delete	Table
void		RETURN

From EMBOSS 6.4.0

Function ajTableuintFreeKey

Prototype

void ajTableuintFreeKey (
      AjPTable* Ptable
);

Type	Name	Read/Write	Description
AjPTable*	Ptable	Delete	Table
void		RETURN

From EMBOSS 6.4.0

AjPTable: Retrieval

Functions:

ajTableuintFetch

returns the value associated with key in table, or null if table does not hold key.

Function ajTableuintFetch

Prototype

const ajuint* ajTableuintFetch (
      const AjPTable table,
      const ajuint* uintkey
);

Type	Name	Read/Write	Description
const AjPTable	table	Input	table to search
const ajuint*	uintkey	Input	key to find.
const ajuint*		RETURN	value associated with key

From EMBOSS 6.4.0

AjPTable: Modify

Functions:

ajTableuintFetchmod

returns the value associated with key in table, or null if table does not hold key.

Function ajTableuintFetchmod

Prototype

ajuint* ajTableuintFetchmod (
      AjPTable table,
      const ajuint* uintkey
);

Type	Name	Read/Write	Description
AjPTable	table	Modify	table to search
const ajuint*	uintkey	Input	key to find.
ajuint*		RETURN	value associated with key

From EMBOSS 6.4.0

AjPTable: Comparison functions

Functions:

ajTableuintCmp	Comparison function for a table with an unsigned integer key
ajTableuintHash	Hash function for a table with an unsigned integer key

Function ajTableuintCmp

Prototype

ajint ajTableuintCmp (
      const void* key1,
      const void* key2
);

Type	Name	Read/Write	Description
const void*	key1	Input	First key.
const void*	key2	Input	Second key.
ajint		RETURN	Comparison result. Zero if equal, non-zero if different.

From EMBOSS 6.4.0

Function ajTableuintHash

Prototype

ajulong ajTableuintHash (
      const void* key,
      ajulong hashsize
);

Type	Name	Read/Write	Description
const void*	key	Input	Standard argument. Table key.
ajulong	hashsize	Input	Standard argument. Estimated Hash size.
ajulong		RETURN	Hash value in range 0 to hashsize-1

From EMBOSS 6.4.0

AjPTable: Constructors

Functions:

ajTableulongNew	Creates, initialises, and returns a new, empty table that can hold an arbitrary number of unsigned long integer key-value pairs
ajTableulongNewConst	Creates, initialises, and returns a new, empty table that can hold an arbitrary number of unsigned long integer key-value pairs

Function ajTableulongNew

Prototype

AjPTable ajTableulongNew (
      ajulong size
);

Type	Name	Read/Write	Description
ajulong	size	Input	estimate of number of unique keys
AjPTable		RETURN	new table.

From EMBOSS 6.4.0

Function ajTableulongNewConst

Prototype

AjPTable ajTableulongNewConst (
      ajulong size
);

Type	Name	Read/Write	Description
ajulong	size	Input	estimate of number of unique keys
AjPTable		RETURN	new table.

From EMBOSS 6.4.0

AjPTable: Destructors

Functions:

ajTableulongFree	Free keys and value strings in a table and free the table. Use only where the keys and data in the table are real, and not just copies of pointers. Otherwise a call to ajTableFree is enough.
ajTableulongFreeKey	Free keys and value strings in a table and free the table. Use only where the keys in the table are real, and not just copies of pointers. Otherwise a call to ajTableFree is enough.

Function ajTableulongFree

Prototype

void ajTableulongFree (
      AjPTable* Ptable
);

Type	Name	Read/Write	Description
AjPTable*	Ptable	Delete	Table
void		RETURN

From EMBOSS 6.4.0

Function ajTableulongFreeKey

Prototype

void ajTableulongFreeKey (
      AjPTable* Ptable
);

Type	Name	Read/Write	Description
AjPTable*	Ptable	Delete	Table
void		RETURN

From EMBOSS 6.4.0

AjPTable: Retrieval

Functions:

ajTableulongFetch

returns the value associated with key in table, or null if table does not hold key.

Function ajTableulongFetch

Prototype

const ajulong* ajTableulongFetch (
      const AjPTable table,
      const ajulong* ulongkey
);

Type	Name	Read/Write	Description
const AjPTable	table	Input	table to search
const ajulong*	ulongkey	Input	key to find.
const ajulong*		RETURN	value associated with key

From EMBOSS 6.4.0

AjPTable: Modify

Functions:

ajTableulongFetchmod

Returns the value associated with key in table, or null if table does not hold key.

Function ajTableulongFetchmod

Prototype

ajulong* ajTableulongFetchmod (
      AjPTable table,
      const ajulong* ulongkey
);

Type	Name	Read/Write	Description
AjPTable	table	Modify	table to search
const ajulong*	ulongkey	Input	key to find.
ajulong*		RETURN	value associated with key

From EMBOSS 6.4.0

AjPTable: Comparison functions

Functions:

ajTableulongCmp	Comparison function for a table with an unsigned long integer key
ajTableulongHash	Hash function for a table with an unsigned long integer key

Function ajTableulongCmp

Prototype

ajint ajTableulongCmp (
      const void* key1,
      const void* key2
);

Type	Name	Read/Write	Description
const void*	key1	Input	First key.
const void*	key2	Input	Second key.
ajint		RETURN	Comparison result. Zero if equal, non-zero if different.

From EMBOSS 6.4.0

Function ajTableulongHash

Prototype

ajulong ajTableulongHash (
      const void* key,
      ajulong hashsize
);

Type	Name	Read/Write	Description
const void*	key	Input	Standard argument. Table key.
ajulong	hashsize	Input	Standard argument. Estimated Hash size.
ajulong		RETURN	Hash value in range 0 to hashsize-1

From EMBOSS 6.4.0