GenericArray - Generic arrays module
[Non-specific low-level tools level]

Generic arrays module (former dyntab module). More...

Data Structures

struct  CharArray
 Array of char (former Dyntab_char). More...
struct  IntArray
 Array of int (former Dyntab_int). More...
struct  DoubleArray
 Array of double (former Dyntab_double). More...
struct  LongArray
 Array of long (former Dyntab_longint). More...
struct  PointerArray
 Array of pointers (void*) (former Dyntab_pointeur). More...
struct  StringArray
 Array of string (char*). More...

Defines

#define arrayFree(array)

Functions

CharArraycharArrayCreate ()
void charArrayAppendVal (CharArray *array, const char value)
void charArrayInsertVal (CharArray *array, const guint index, const char value)
void charArraySetVal (CharArray *array, const size_t index, char const value)
CharArraycharArrayDuplicate (const CharArray *array)
IntArrayintArrayCreate ()
void intArrayAppendVal (IntArray *array, const int value)
void intArrayInsertVal (IntArray *array, const guint index, const int value)
void intArraySetVal (IntArray *array, const size_t index, int const value)
IntArrayintArrayDuplicate (const IntArray *array)
DoubleArraydoubleArrayCreate ()
void doubleArrayAppendVal (DoubleArray *array, const double value)
void doubleArrayInsertVal (DoubleArray *array, const guint index, const double value)
void doubleArraySetVal (DoubleArray *array, const size_t index, double const value)
DoubleArraydoubleArrayDuplicate (const DoubleArray *array)
LongArraylongArrayCreate ()
void longArrayAppendVal (LongArray *array, const guint32 value)
void longArrayInsertVal (LongArray *array, const guint index, const guint32 value)
void longArraySetVal (LongArray *array, const size_t index, guint32 const value)
LongArraylongArrayDuplicate (const LongArray *array)
PointerArraypointerArrayCreate ()
void pointerArrayAppendVal (PointerArray *array, const void *value)
void pointerArrayInsertVal (PointerArray *array, const guint index, const void *value)
void pointerArraySetVal (PointerArray *array, const size_t index, void *const value)
PointerArraypointerArrayDuplicate (const PointerArray *array)
void stringArrayFree (StringArray *array)
StringArraystringArrayCreate ()
void stringArrayAppendVal (StringArray *array, const char *value)
void stringArraySetVal (StringArray *array, const size_t index, const char *value)
StringArraystringArrayDuplicate (const StringArray *array)

Detailed Description

Generic arrays module (former dyntab module).

SlpTK Library 0.6.0

Required header
<genericarray.h>
Author:
Jean-Cédric Chappelier (creation on 09.12.1998)

Martin Keschenau (modification on 11.02.2001)

Antonin Merçay (revision on 17.11.2004)

Date:
2 March 2005
Version:
0.6.0

Define Documentation

#define arrayFree ( array   ) 

Free the memory allocated to a given array

Parameters:
[in] array The array to free
Former(s) function(s):
Libere_Dyntab


Function Documentation

void charArrayAppendVal ( CharArray array,
const char  value 
)

Append a new element at the end of the array

Parameters:
[in] array The array
[in] value The value of the element to append
Former(s) function(s):
Augmente_Dyntab_*

CharArray * charArrayCreate (  ) 

Create a new array of a given type

Returns:
The new array
See also:
arrayFree()
Former(s) function(s):
Init_Dyntab_*

CharArray * charArrayDuplicate ( const CharArray array  ) 

Create a copy of the array

Parameters:
[in] array The array to duplicate
See also:
arrayFree()
Former(s) function(s):
Duplique_Dyntab_*

void charArrayInsertVal ( CharArray array,
const guint  index,
const char  value 
)

Insert a new element in the array

Parameters:
[in] array The array
[in] index The index where to insert the element
[in] value The value of the element to insert

void charArraySetVal ( CharArray array,
const size_t  index,
const char  value 
)

Set the value of the element at a given index of the array

Remarks:
If the given index is greater than the size of the array, elements set to 0 are inserted to fill the interval
Parameters:
[in] array The array
[in] index The index of the element to set
[in] value The value of the element to set
Former(s) function(s):
Ajoute_Dyntab_*

void doubleArrayAppendVal ( DoubleArray array,
const double  value 
)

Append a new element at the end of the array

Parameters:
[in] array The array
[in] value The value of the element to append
Former(s) function(s):
Augmente_Dyntab_*

DoubleArray * doubleArrayCreate (  ) 

Create a new array of a given type

Returns:
The new array
See also:
arrayFree()
Former(s) function(s):
Init_Dyntab_*

DoubleArray * doubleArrayDuplicate ( const DoubleArray array  ) 

Create a copy of the array

Parameters:
[in] array The array to duplicate
See also:
arrayFree()
Former(s) function(s):
Duplique_Dyntab_*

void doubleArrayInsertVal ( DoubleArray array,
const guint  index,
const double  value 
)

Insert a new element in the array

Parameters:
[in] array The array
[in] index The index where to insert the element
[in] value The value of the element to insert

void doubleArraySetVal ( DoubleArray array,
const size_t  index,
const double  value 
)

Set the value of the element at a given index of the array

Remarks:
If the given index is greater than the size of the array, elements set to 0 are inserted to fill the interval
Parameters:
[in] array The array
[in] index The index of the element to set
[in] value The value of the element to set
Former(s) function(s):
Ajoute_Dyntab_*

void intArrayAppendVal ( IntArray array,
const int  value 
)

Append a new element at the end of the array

Parameters:
[in] array The array
[in] value The value of the element to append
Former(s) function(s):
Augmente_Dyntab_*

IntArray * intArrayCreate (  ) 

Create a new array of a given type

Returns:
The new array
See also:
arrayFree()
Former(s) function(s):
Init_Dyntab_*

IntArray * intArrayDuplicate ( const IntArray array  ) 

Create a copy of the array

Parameters:
[in] array The array to duplicate
See also:
arrayFree()
Former(s) function(s):
Duplique_Dyntab_*

void intArrayInsertVal ( IntArray array,
const guint  index,
const int  value 
)

Insert a new element in the array

Parameters:
[in] array The array
[in] index The index where to insert the element
[in] value The value of the element to insert

void intArraySetVal ( IntArray array,
const size_t  index,
const int  value 
)

Set the value of the element at a given index of the array

Remarks:
If the given index is greater than the size of the array, elements set to 0 are inserted to fill the interval
Parameters:
[in] array The array
[in] index The index of the element to set
[in] value The value of the element to set
Former(s) function(s):
Ajoute_Dyntab_*

void longArrayAppendVal ( LongArray array,
const guint32  value 
)

Append a new element at the end of the array

Parameters:
[in] array The array
[in] value The value of the element to append
Former(s) function(s):
Augmente_Dyntab_*

LongArray * longArrayCreate (  ) 

Create a new array of a given type

Returns:
The new array
See also:
arrayFree()
Former(s) function(s):
Init_Dyntab_*

LongArray * longArrayDuplicate ( const LongArray array  ) 

Create a copy of the array

Parameters:
[in] array The array to duplicate
See also:
arrayFree()
Former(s) function(s):
Duplique_Dyntab_*

void longArrayInsertVal ( LongArray array,
const guint  index,
const guint32  value 
)

Insert a new element in the array

Parameters:
[in] array The array
[in] index The index where to insert the element
[in] value The value of the element to insert

void longArraySetVal ( LongArray array,
const size_t  index,
const guint32  value 
)

Set the value of the element at a given index of the array

Remarks:
If the given index is greater than the size of the array, elements set to 0 are inserted to fill the interval
Parameters:
[in] array The array
[in] index The index of the element to set
[in] value The value of the element to set
Former(s) function(s):
Ajoute_Dyntab_*

void pointerArrayAppendVal ( PointerArray array,
const void *  value 
)

Append a new element at the end of the array

Parameters:
[in] array The array
[in] value The value of the element to append
Former(s) function(s):
Augmente_Dyntab_*

PointerArray * pointerArrayCreate (  ) 

Create a new array of a given type

Returns:
The new array
See also:
arrayFree()
Former(s) function(s):
Init_Dyntab_*

PointerArray * pointerArrayDuplicate ( const PointerArray array  ) 

Create a copy of the array

Parameters:
[in] array The array to duplicate
See also:
arrayFree()
Former(s) function(s):
Duplique_Dyntab_*

void pointerArrayInsertVal ( PointerArray array,
const guint  index,
const void *  value 
)

Insert a new element in the array

Parameters:
[in] array The array
[in] index The index where to insert the element
[in] value The value of the element to insert

void pointerArraySetVal ( PointerArray array,
const size_t  index,
void *const   value 
)

Set the value of the element at a given index of the array

Remarks:
If the given index is greater than the size of the array, elements set to 0 are inserted to fill the interval
Parameters:
[in] array The array
[in] index The index of the element to set
[in] value The value of the element to set
Former(s) function(s):
Ajoute_Dyntab_*

void stringArrayAppendVal ( StringArray array,
const char *  value 
)

Append an element at the end of the array of strings

Parameters:
[in] array The array of strings
[in] value The value of the string to append

StringArray * stringArrayCreate (  ) 

Create a new array of strings

Returns:
The new array
See also:
stringArrayFree()

StringArray* stringArrayDuplicate ( const StringArray array  ) 

Duplicate the array of strings

Remarks:
The string array content is also duplicated.
Parameters:
[in] array The array to duplicate
Returns:
The duplicate
See also:
stringArrayFree()

void stringArrayFree ( StringArray array  ) 

Free the memory allocated to an array of strings

Remarks:
The memory allocated to the stored strings is also freed
Parameters:
[in] array The array of strings to free

void stringArraySetVal ( StringArray array,
const size_t  index,
const char *  value 
)

Insert an element in the array of strings at a particular index

Remarks:
If the specified index is greater than the size of the array, null elements are inserted between.
Parameters:
[in] array The array of strings
[in] index The index of the inserted string
[in] value The value of the string to insert


Generated on Thu Mar 22 17:46:31 2007 for SlpTk by  doxygen 1.4.7