ajarr.c
Default constructor for empty AJAX character arrays.
Synopsis
Prototype
AjPChar ajChararrNew (
void
);
Type | Name | Read/Write | Description |
AjPChar | | RETURN | Pointer to an empty character array structure |
Returns
AjPChar: | Pointer to an empty character array structure |
Description
Default constructor for empty AJAX character arrays.
See Also
See other functions in this section
Availability
In release 6.4.0
Constructor given an initial reserved size.
Synopsis
Prototype
AjPChar ajChararrNewRes (
ajuint size
);
Type | Name | Read/Write | Description |
ajuint | size | Input | Reserved size |
AjPChar | | RETURN | Pointer to an empty character array struct
of specified size. |
Input
size: | (Input) | Reserved size |
Returns
AjPChar: | Pointer to an empty character array struct
of specified size. |
Description
Constructor given an initial reserved size.
See Also
See other functions in this section
Availability
In release 6.4.0
Default destructor for AJAX character arrays.
If the given array is a NULL pointer, simply returns.
Synopsis
Prototype
void ajChararrDel (
AjPChar* thys
);
Type | Name | Read/Write | Description |
AjPChar* | thys | Delete | Pointer to the char array to be deleted.
The pointer is always deleted. |
void | | RETURN | |
Output
thys: | (Delete) | Pointer to the char array to be deleted.
The pointer is always deleted. |
Returns
Description
Default destructor for AJAX character arrays.
If the given array is a NULL pointer, simply returns.
See Also
See other functions in this section
Availability
In release 6.4.0
Retrieve an element from an AJAX character array.
If the given array is a NULL pointer, simply returns.
Synopsis
Prototype
char ajChararrGet (
const AjPChar thys,
ajuint elem
);
Type | Name | Read/Write | Description |
const AjPChar | thys | Input | Pointer to the char array. |
ajuint | elem | Input | array element. |
char | | RETURN | contents of array element |
Input
thys: | (Input) | Pointer to the char array. |
elem: | (Input) | array element. |
Returns
char: | contents of array element |
Description
Retrieve an element from an AJAX character array.
If the given array is a NULL pointer, simply returns.
See Also
See other functions in this section
Availability
In release 6.4.0
Load a character array element.
If the given array is a NULL pointer an error is generated.
If the array is of insufficient size then the array is extended.
Negative indices generate an error.
Synopsis
Prototype
AjBool ajChararrPut (
AjPChar* thys,
ajuint elem,
char v
);
Type | Name | Read/Write | Description |
AjPChar* | thys | Output | Pointer to the char array. |
ajuint | elem | Input | array element. |
char | v | Input | value to load. |
AjBool | | RETURN | true if the array was extended. |
Input
elem: | (Input) | array element. |
v: | (Input) | value to load. |
Output
thys: | (Output) | Pointer to the char array. |
Returns
AjBool: | true if the array was extended. |
Description
Load a character array element.
If the given array is a NULL pointer an error is generated.
If the array is of insufficient size then the array is extended.
Negative indices generate an error.
See Also
See other functions in this section
Availability
In release 6.4.0
Returns the current char* pointer. This will remain valid until
the array is resized or deleted.
Synopsis
Prototype
char* ajChararrChararr (
const AjPChar thys
);
Type | Name | Read/Write | Description |
const AjPChar | thys | Input | Source array |
char* | | RETURN | Current array pointer, or a null string if undefined. |
Input
Returns
char*: | Current array pointer, or a null string if undefined. |
Description
Returns the current char* pointer. This will remain valid until
the array is resized or deleted.
See Also
See other functions in this section
Availability
In release 6.4.0
Get length of dynamic character array
Synopsis
Prototype
ajuint ajChararrLen (
const AjPChar thys
);
Type | Name | Read/Write | Description |
const AjPChar | thys | Input | Source array |
ajuint | | RETURN | length |
Input
Returns
Description
Get length of dynamic character array
See Also
See other functions in this section
Availability
In release 6.4.0
Default constructor for empty AJAX integer arrays.
Synopsis
Prototype
AjPInt ajIntNew (
void
);
Type | Name | Read/Write | Description |
AjPInt | | RETURN | Pointer to an empty integer array structure |
Returns
AjPInt: | Pointer to an empty integer array structure |
Description
Default constructor for empty AJAX integer arrays.
See Also
See other functions in this section
Availability
In release 6.4.0
Constructor given an initial reserved size.
Synopsis
Prototype
AjPInt ajIntNewRes (
ajuint size
);
Type | Name | Read/Write | Description |
ajuint | size | Input | Reserved size |
AjPInt | | RETURN | Pointer to an empty integer array struct of specified size. |
Input
size: | (Input) | Reserved size |
Returns
AjPInt: | Pointer to an empty integer array struct of specified size. |
Description
Constructor given an initial reserved size.
See Also
See other functions in this section
Availability
In release 6.4.0
Default destructor for AJAX integer arrays.
If the given array is a NULL pointer, simply returns.
Synopsis
Prototype
void ajIntDel (
AjPInt* thys
);
Type | Name | Read/Write | Description |
AjPInt* | thys | Delete | Pointer to the ajint array to be deleted.
The pointer is always deleted. |
void | | RETURN | |
Output
thys: | (Delete) | Pointer to the ajint array to be deleted.
The pointer is always deleted. |
Returns
Description
Default destructor for AJAX integer arrays.
If the given array is a NULL pointer, simply returns.
See Also
See other functions in this section
Availability
In release 6.4.0
Retrieve an element from an AJAX integer array.
If the given array is a NULL pointer, simply returns.
Synopsis
Prototype
ajint ajIntGet (
const AjPInt thys,
ajuint elem
);
Type | Name | Read/Write | Description |
const AjPInt | thys | Input | Pointer to the ajint array. |
ajuint | elem | Input | array element. |
ajint | | RETURN | contents of array element |
Input
thys: | (Input) | Pointer to the ajint array. |
elem: | (Input) | array element. |
Returns
ajint: | contents of array element |
Description
Retrieve an element from an AJAX integer array.
If the given array is a NULL pointer, simply returns.
See Also
See other functions in this section
Availability
In release 6.4.0
Load an integer array element.
If the given array is a NULL pointer an error is generated.
If the array is of insufficient size then the array is extended.
Negative indices generate an error.
Synopsis
Prototype
AjBool ajIntPut (
AjPInt* thys,
ajuint elem,
ajint v
);
Type | Name | Read/Write | Description |
AjPInt* | thys | Output | Pointer to the ajint array. |
ajuint | elem | Input | array element. |
ajint | v | Input | value to load. |
AjBool | | RETURN | true if the array was extended. |
Input
elem: | (Input) | array element. |
v: | (Input) | value to load. |
Output
thys: | (Output) | Pointer to the ajint array. |
Returns
AjBool: | true if the array was extended. |
Description
Load an integer array element.
If the given array is a NULL pointer an error is generated.
If the array is of insufficient size then the array is extended.
Negative indices generate an error.
See Also
See other functions in this section
Availability
In release 6.4.0
Increment an integer array element.
If the given array is a NULL pointer an error is generated.
Negative indices generate an error.
Synopsis
Prototype
void ajIntInc (
AjPInt* thys,
ajuint elem
);
Type | Name | Read/Write | Description |
AjPInt* | thys | Output | Pointer to the ajint array. |
ajuint | elem | Input | array element. |
void | | RETURN | |
Input
elem: | (Input) | array element. |
Output
thys: | (Output) | Pointer to the ajint array. |
Returns
Description
Increment an integer array element.
If the given array is a NULL pointer an error is generated.
Negative indices generate an error.
See Also
See other functions in this section
Availability
In release 6.4.0
Decrement an integer array element.
If the given array is a NULL pointer an error is generated.
Negative indices generate an error.
Synopsis
Prototype
void ajIntDec (
AjPInt* thys,
ajuint elem
);
Type | Name | Read/Write | Description |
AjPInt* | thys | Output | Pointer to the ajint array. |
ajuint | elem | Input | array element. |
void | | RETURN | |
Input
elem: | (Input) | array element. |
Output
thys: | (Output) | Pointer to the ajint array. |
Returns
Description
Decrement an integer array element.
If the given array is a NULL pointer an error is generated.
Negative indices generate an error.
See Also
See other functions in this section
Availability
In release 6.4.0
Default constructor for empty AJAX unsigned integer arrays.
Synopsis
Prototype
AjPUint ajUintNew (
void
);
Type | Name | Read/Write | Description |
AjPUint | | RETURN | Pointer to an empty unsigned integer array structure |
Returns
AjPUint: | Pointer to an empty unsigned integer array structure |
Description
Default constructor for empty AJAX unsigned integer arrays.
See Also
See other functions in this section
Availability
In release 6.4.0
Constructor given an initial reserved size.
Synopsis
Prototype
AjPUint ajUintNewRes (
ajuint size
);
Type | Name | Read/Write | Description |
ajuint | size | Input | Reserved size |
AjPUint | | RETURN | Pointer to an empty unsigned integer array struct
of specified size. |
Input
size: | (Input) | Reserved size |
Returns
AjPUint: | Pointer to an empty unsigned integer array struct
of specified size. |
Description
Constructor given an initial reserved size.
See Also
See other functions in this section
Availability
In release 6.4.0
Default destructor for AJAX integer integer arrays.
If the given array is a NULL pointer, simply returns.
Synopsis
Prototype
void ajUintDel (
AjPUint* thys
);
Type | Name | Read/Write | Description |
AjPUint* | thys | Delete | Pointer to the ajuint array to be deleted.
The pointer is always deleted. |
void | | RETURN | |
Output
thys: | (Delete) | Pointer to the ajuint array to be deleted.
The pointer is always deleted. |
Returns
Description
Default destructor for AJAX integer integer arrays.
If the given array is a NULL pointer, simply returns.
See Also
See other functions in this section
Availability
In release 6.4.0
Retrieve an element from an AJAX unsigned integer array.
If the given array is a NULL pointer, simply returns.
Synopsis
Prototype
ajuint ajUintGet (
const AjPUint thys,
ajuint elem
);
Type | Name | Read/Write | Description |
const AjPUint | thys | Input | Pointer to the ajuint array. |
ajuint | elem | Input | array element. |
ajuint | | RETURN | contents of array element |
Input
thys: | (Input) | Pointer to the ajuint array. |
elem: | (Input) | array element. |
Returns
ajuint: | contents of array element |
Description
Retrieve an element from an AJAX unsigned integer array.
If the given array is a NULL pointer, simply returns.
See Also
See other functions in this section
Availability
In release 6.4.0
Load an unsigned integer array element.
If the given array is a NULL pointer an error is generated.
If the array is of insufficient size then the array is extended.
Negative indices generate an error.
Synopsis
Prototype
AjBool ajUintPut (
AjPUint* thys,
ajuint elem,
ajuint v
);
Type | Name | Read/Write | Description |
AjPUint* | thys | Output | Pointer to the ajuint array. |
ajuint | elem | Input | array element. |
ajuint | v | Input | value to load. |
AjBool | | RETURN | true if the array was extended. |
Input
elem: | (Input) | array element. |
v: | (Input) | value to load. |
Output
thys: | (Output) | Pointer to the ajuint array. |
Returns
AjBool: | true if the array was extended. |
Description
Load an unsigned integer array element.
If the given array is a NULL pointer an error is generated.
If the array is of insufficient size then the array is extended.
Negative indices generate an error.
See Also
See other functions in this section
Availability
In release 6.4.0
Increment an unsigned integer array element.
If the given array is a NULL pointer an error is generated.
Negative indices generate an error.
Synopsis
Prototype
void ajUintInc (
AjPUint* thys,
ajuint elem
);
Type | Name | Read/Write | Description |
AjPUint* | thys | Output | Pointer to the ajuint array. |
ajuint | elem | Input | array element. |
void | | RETURN | |
Input
elem: | (Input) | array element. |
Output
thys: | (Output) | Pointer to the ajuint array. |
Returns
Description
Increment an unsigned integer array element.
If the given array is a NULL pointer an error is generated.
Negative indices generate an error.
See Also
See other functions in this section
Availability
In release 6.4.0
Decrement an unsigned integer array element.
If the given array is a NULL pointer an error is generated.
Negative indices generate an error.
Synopsis
Prototype
void ajUintDec (
AjPUint* thys,
ajuint elem
);
Type | Name | Read/Write | Description |
AjPUint* | thys | Output | Pointer to the ajuint array. |
ajuint | elem | Input | array element. |
void | | RETURN | |
Input
elem: | (Input) | array element. |
Output
thys: | (Output) | Pointer to the ajuint array. |
Returns
Description
Decrement an unsigned integer array element.
If the given array is a NULL pointer an error is generated.
Negative indices generate an error.
See Also
See other functions in this section
Availability
In release 6.4.0
Returns the current ajint* pointer. This will remain valid until
the array is resized or deleted.
Synopsis
Prototype
ajint* ajIntInt (
const AjPInt thys
);
Type | Name | Read/Write | Description |
const AjPInt | thys | Input | Source array |
ajint* | | RETURN | Current array pointer, or a null string if undefined. |
Input
Returns
ajint*: | Current array pointer, or a null string if undefined. |
Description
Returns the current ajint* pointer. This will remain valid until
the array is resized or deleted.
See Also
See other functions in this section
Availability
In release 6.4.0
Get length of dynamic 1d ajint array
Synopsis
Prototype
ajuint ajIntLen (
const AjPInt thys
);
Type | Name | Read/Write | Description |
const AjPInt | thys | Input | Source array |
ajuint | | RETURN | length |
Input
Returns
Description
Get length of dynamic 1d ajint array
See Also
See other functions in this section
Availability
In release 6.4.0
Returns the current ajuint* pointer. This will remain valid until
the array is resized or deleted.
Synopsis
Prototype
ajuint* ajUintUint (
const AjPUint thys
);
Type | Name | Read/Write | Description |
const AjPUint | thys | Input | Source array |
ajuint* | | RETURN | Current array pointer, or a null string if undefined. |
Input
Returns
ajuint*: | Current array pointer, or a null string if undefined. |
Description
Returns the current ajuint* pointer. This will remain valid until
the array is resized or deleted.
See Also
See other functions in this section
Availability
In release 6.4.0
Get length of dynamic 1d ajuint array
Synopsis
Prototype
ajuint ajUintLen (
const AjPUint thys
);
Type | Name | Read/Write | Description |
const AjPUint | thys | Input | Source array |
ajuint | | RETURN | length |
Input
Returns
Description
Get length of dynamic 1d ajuint array
See Also
See other functions in this section
Availability
In release 6.4.0
Default constructor for empty AJAX float arrays.
Synopsis
Prototype
AjPFloat ajFloatNew (
void
);
Type | Name | Read/Write | Description |
AjPFloat | | RETURN | Pointer to an empty float array structure |
Returns
AjPFloat: | Pointer to an empty float array structure |
Description
Default constructor for empty AJAX float arrays.
See Also
See other functions in this section
Availability
In release 6.4.0
Constructor given an initial reserved size.
Synopsis
Prototype
AjPFloat ajFloatNewRes (
ajuint size
);
Type | Name | Read/Write | Description |
ajuint | size | Input | Reserved size |
AjPFloat | | RETURN | Pointer to an empty float array struct of specified size. |
Input
size: | (Input) | Reserved size |
Returns
AjPFloat: | Pointer to an empty float array struct of specified size. |
Description
Constructor given an initial reserved size.
See Also
See other functions in this section
Availability
In release 6.4.0
Default destructor for AJAX float arrays.
If the given array is a NULL pointer, simply returns.
Synopsis
Prototype
void ajFloatDel (
AjPFloat* thys
);
Type | Name | Read/Write | Description |
AjPFloat* | thys | Delete | Pointer to the float array to be deleted.
The pointer is always deleted. |
void | | RETURN | |
Output
thys: | (Delete) | Pointer to the float array to be deleted.
The pointer is always deleted. |
Returns
Description
Default destructor for AJAX float arrays.
If the given array is a NULL pointer, simply returns.
See Also
See other functions in this section
Availability
In release 6.4.0
Retrieve an element from an AJAX float array.
If the given array is a NULL pointer, simply returns.
Synopsis
Prototype
float ajFloatGet (
const AjPFloat thys,
ajuint elem
);
Type | Name | Read/Write | Description |
const AjPFloat | thys | Input | Pointer to the float array. |
ajuint | elem | Input | array element. |
float | | RETURN | contents of array element |
Input
thys: | (Input) | Pointer to the float array. |
elem: | (Input) | array element. |
Returns
float: | contents of array element |
Description
Retrieve an element from an AJAX float array.
If the given array is a NULL pointer, simply returns.
See Also
See other functions in this section
Availability
In release 6.4.0
Load a float array element.
If the given array is a NULL pointer an error is generated.
If the array is of insufficient size then the array is extended.
Negative indices generate an error.
Synopsis
Prototype
AjBool ajFloatPut (
AjPFloat* thys,
ajuint elem,
float v
);
Type | Name | Read/Write | Description |
AjPFloat* | thys | Output | Pointer to the float array. |
ajuint | elem | Input | array element. |
float | v | Input | value to load. |
AjBool | | RETURN | true if the array was extended. |
Input
elem: | (Input) | array element. |
v: | (Input) | value to load. |
Output
thys: | (Output) | Pointer to the float array. |
Returns
AjBool: | true if the array was extended. |
Description
Load a float array element.
If the given array is a NULL pointer an error is generated.
If the array is of insufficient size then the array is extended.
Negative indices generate an error.
See Also
See other functions in this section
Availability
In release 6.4.0
Returns the current float* pointer. This will remain valid until
the array is resized or deleted.
Synopsis
Prototype
float* ajFloatFloat (
const AjPFloat thys
);
Type | Name | Read/Write | Description |
const AjPFloat | thys | Input | Source array |
float* | | RETURN | Current array pointer, or a null string if undefined. |
Input
Returns
float*: | Current array pointer, or a null string if undefined. |
Description
Returns the current float* pointer. This will remain valid until
the array is resized or deleted.
See Also
See other functions in this section
Availability
In release 6.4.0
Get length of dynamic 1d float array
Synopsis
Prototype
ajuint ajFloatLen (
const AjPFloat thys
);
Type | Name | Read/Write | Description |
const AjPFloat | thys | Input | Source array |
ajuint | | RETURN | length |
Input
Returns
Description
Get length of dynamic 1d float array
See Also
See other functions in this section
Availability
In release 6.4.0
Default constructor for empty AJAX double arrays.
Synopsis
Prototype
AjPDouble ajDoubleNew (
void
);
Type | Name | Read/Write | Description |
AjPDouble | | RETURN | Pointer to an empty double array structure |
Returns
AjPDouble: | Pointer to an empty double array structure |
Description
Default constructor for empty AJAX double arrays.
See Also
See other functions in this section
Availability
In release 6.4.0
Constructor given an initial reserved size.
Synopsis
Prototype
AjPDouble ajDoubleNewRes (
ajuint size
);
Type | Name | Read/Write | Description |
ajuint | size | Input | Reserved size |
AjPDouble | | RETURN | Pointer to an empty double array struct
of specified size. |
Input
size: | (Input) | Reserved size |
Returns
AjPDouble: | Pointer to an empty double array struct
of specified size. |
Description
Constructor given an initial reserved size.
See Also
See other functions in this section
Availability
In release 6.4.0
Default destructor for AJAX double arrays.
If the given array is a NULL pointer, simply returns.
Synopsis
Prototype
void ajDoubleDel (
AjPDouble* thys
);
Type | Name | Read/Write | Description |
AjPDouble* | thys | Delete | Pointer to the double array to be deleted.
The pointer is always deleted. |
void | | RETURN | |
Output
thys: | (Delete) | Pointer to the double array to be deleted.
The pointer is always deleted. |
Returns
Description
Default destructor for AJAX double arrays.
If the given array is a NULL pointer, simply returns.
See Also
See other functions in this section
Availability
In release 6.4.0
Retrieve an element from an AJAX double array.
If the given array is a NULL pointer, simply returns.
Synopsis
Prototype
double ajDoubleGet (
const AjPDouble thys,
ajuint elem
);
Type | Name | Read/Write | Description |
const AjPDouble | thys | Input | Pointer to the double array. |
ajuint | elem | Input | array element. |
double | | RETURN | contents of array element |
Input
thys: | (Input) | Pointer to the double array. |
elem: | (Input) | array element. |
Returns
double: | contents of array element |
Description
Retrieve an element from an AJAX double array.
If the given array is a NULL pointer, simply returns.
See Also
See other functions in this section
Availability
In release 6.4.0
Load a double array element.
If the given array is a NULL pointer an error is generated.
If the array is of insufficient size then the array is extended.
Negative indices generate an error.
Synopsis
Prototype
AjBool ajDoublePut (
AjPDouble* thys,
ajuint elem,
double v
);
Type | Name | Read/Write | Description |
AjPDouble* | thys | Output | Pointer to the double array. |
ajuint | elem | Input | array element. |
double | v | Input | value to load. |
AjBool | | RETURN | true if the array was extended. |
Input
elem: | (Input) | array element. |
v: | (Input) | value to load. |
Output
thys: | (Output) | Pointer to the double array. |
Returns
AjBool: | true if the array was extended. |
Description
Load a double array element.
If the given array is a NULL pointer an error is generated.
If the array is of insufficient size then the array is extended.
Negative indices generate an error.
See Also
See other functions in this section
Availability
In release 6.4.0
Returns the current double* pointer. This will remain valid until
the array is resized or deleted.
Synopsis
Prototype
double* ajDoubleDouble (
const AjPDouble thys
);
Type | Name | Read/Write | Description |
const AjPDouble | thys | Input | Source array |
double* | | RETURN | Current array pointer, or a null string if undefined. |
Input
Returns
double*: | Current array pointer, or a null string if undefined. |
Description
Returns the current double* pointer. This will remain valid until
the array is resized or deleted.
See Also
See other functions in this section
Availability
In release 6.4.0
Get length of dynamic 1d double array
Synopsis
Prototype
ajuint ajDoubleLen (
const AjPDouble thys
);
Type | Name | Read/Write | Description |
const AjPDouble | thys | Input | Source array |
ajuint | | RETURN | length |
Input
Returns
Description
Get length of dynamic 1d double array
See Also
See other functions in this section
Availability
In release 6.4.0
Default constructor for empty AJAX short arrays.
Synopsis
Prototype
AjPShort ajShortNew (
void
);
Type | Name | Read/Write | Description |
AjPShort | | RETURN | Pointer to an empty short array structure |
Returns
AjPShort: | Pointer to an empty short array structure |
Description
Default constructor for empty AJAX short arrays.
See Also
See other functions in this section
Availability
In release 6.4.0
Constructor given an initial reserved size.
Synopsis
Prototype
AjPShort ajShortNewRes (
ajuint size
);
Type | Name | Read/Write | Description |
ajuint | size | Input | Reserved size |
AjPShort | | RETURN | Pointer to an empty short array struct of specified size. |
Input
size: | (Input) | Reserved size |
Returns
AjPShort: | Pointer to an empty short array struct of specified size. |
Description
Constructor given an initial reserved size.
See Also
See other functions in this section
Availability
In release 6.4.0
Default destructor for AJAX short arrays.
If the given array is a NULL pointer, simply returns.
Synopsis
Prototype
void ajShortDel (
AjPShort* thys
);
Type | Name | Read/Write | Description |
AjPShort* | thys | Delete | Pointer to the short array to be deleted.
The pointer is always deleted. |
void | | RETURN | |
Output
thys: | (Delete) | Pointer to the short array to be deleted.
The pointer is always deleted. |
Returns
Description
Default destructor for AJAX short arrays.
If the given array is a NULL pointer, simply returns.
See Also
See other functions in this section
Availability
In release 6.4.0
Retrieve an element from an AJAX short array.
If the given array is a NULL pointer, simply returns.
Synopsis
Prototype
short ajShortGet (
const AjPShort thys,
ajuint elem
);
Type | Name | Read/Write | Description |
const AjPShort | thys | Input | Pointer to the short array. |
ajuint | elem | Input | array element. |
short | | RETURN | contents of array element |
Input
thys: | (Input) | Pointer to the short array. |
elem: | (Input) | array element. |
Returns
short: | contents of array element |
Description
Retrieve an element from an AJAX short array.
If the given array is a NULL pointer, simply returns.
See Also
See other functions in this section
Availability
In release 6.4.0
Load a short array element.
If the given array is a NULL pointer an error is generated.
If the array is of insufficient size then the array is extended.
Negative indices generate an error.
Synopsis
Prototype
AjBool ajShortPut (
AjPShort* thys,
ajuint elem,
short v
);
Type | Name | Read/Write | Description |
AjPShort* | thys | Output | Pointer to the short integer array. |
ajuint | elem | Input | array element. |
short | v | Input | value to load. |
AjBool | | RETURN | true if the array was extended. |
Input
elem: | (Input) | array element. |
v: | (Input) | value to load. |
Output
thys: | (Output) | Pointer to the short integer array. |
Returns
AjBool: | true if the array was extended. |
Description
Load a short array element.
If the given array is a NULL pointer an error is generated.
If the array is of insufficient size then the array is extended.
Negative indices generate an error.
See Also
See other functions in this section
Availability
In release 6.4.0
Returns the current short* pointer. This will remain valid until
the array is resized or deleted.
Synopsis
Prototype
short* ajShortShort (
const AjPShort thys
);
Type | Name | Read/Write | Description |
const AjPShort | thys | Input | Source array |
short* | | RETURN | Current array pointer, or a null string if undefined. |
Input
Returns
short*: | Current array pointer, or a null string if undefined. |
Description
Returns the current short* pointer. This will remain valid until
the array is resized or deleted.
See Also
See other functions in this section
Availability
In release 6.4.0
Get length of dynamic 1d short array
Synopsis
Prototype
ajuint ajShortLen (
const AjPShort thys
);
Type | Name | Read/Write | Description |
const AjPShort | thys | Input | Source array |
ajuint | | RETURN | length |
Input
Returns
Description
Get length of dynamic 1d short array
See Also
See other functions in this section
Availability
In release 6.4.0
Default constructor for empty AJAX ajlong arrays.
Synopsis
Prototype
AjPLong ajLongNew (
void
);
Type | Name | Read/Write | Description |
AjPLong | | RETURN | Pointer to an empty ajlong array structure |
Returns
AjPLong: | Pointer to an empty ajlong array structure |
Description
Default constructor for empty AJAX ajlong arrays.
See Also
See other functions in this section
Availability
In release 6.4.0
Constructor given an initial reserved size.
Synopsis
Prototype
AjPLong ajLongNewRes (
ajuint size
);
Type | Name | Read/Write | Description |
ajuint | size | Input | Reserved size |
AjPLong | | RETURN | Pointer to an empty ajlong array struct of specified size. |
Input
size: | (Input) | Reserved size |
Returns
AjPLong: | Pointer to an empty ajlong array struct of specified size. |
Description
Constructor given an initial reserved size.
See Also
See other functions in this section
Availability
In release 6.4.0
Default destructor for AJAX ajlong arrays.
If the given array is a NULL pointer, simply returns.
Synopsis
Prototype
void ajLongDel (
AjPLong* thys
);
Type | Name | Read/Write | Description |
AjPLong* | thys | Delete | Pointer to the ajlong array to be deleted.
The pointer is always deleted. |
void | | RETURN | |
Output
thys: | (Delete) | Pointer to the ajlong array to be deleted.
The pointer is always deleted. |
Returns
Description
Default destructor for AJAX ajlong arrays.
If the given array is a NULL pointer, simply returns.
See Also
See other functions in this section
Availability
In release 6.4.0
Retrieve an element from an AJAX ajlong array.
If the given array is a NULL pointer, simply returns.
Synopsis
Prototype
ajlong ajLongGet (
const AjPLong thys,
ajuint elem
);
Type | Name | Read/Write | Description |
const AjPLong | thys | Input | Pointer to the ajlong array. |
ajuint | elem | Input | array element. |
ajlong | | RETURN | contents of array element |
Input
thys: | (Input) | Pointer to the ajlong array. |
elem: | (Input) | array element. |
Returns
ajlong: | contents of array element |
Description
Retrieve an element from an AJAX ajlong array.
If the given array is a NULL pointer, simply returns.
See Also
See other functions in this section
Availability
In release 6.4.0
Load a long integer array element.
If the given array is a NULL pointer an error is generated.
If the array is of insufficient size then the array is extended.
Negative indices generate an error.
Synopsis
Prototype
AjBool ajLongPut (
AjPLong* thys,
ajuint elem,
ajlong v
);
Type | Name | Read/Write | Description |
AjPLong* | thys | Output | Pointer to the long integer array. |
ajuint | elem | Input | array element. |
ajlong | v | Input | value to load. |
AjBool | | RETURN | true if the array was extended. |
Input
elem: | (Input) | array element. |
v: | (Input) | value to load. |
Output
thys: | (Output) | Pointer to the long integer array. |
Returns
AjBool: | true if the array was extended. |
Description
Load a long integer array element.
If the given array is a NULL pointer an error is generated.
If the array is of insufficient size then the array is extended.
Negative indices generate an error.
See Also
See other functions in this section
Availability
In release 6.4.0
Returns the current ajlong* pointer. This will remain valid until
the array is resized or deleted.
Synopsis
Prototype
ajlong* ajLongLong (
const AjPLong thys
);
Type | Name | Read/Write | Description |
const AjPLong | thys | Input | Source array |
ajlong* | | RETURN | Current array pointer, or a null string if undefined. |
Input
Returns
ajlong*: | Current array pointer, or a null string if undefined. |
Description
Returns the current ajlong* pointer. This will remain valid until
the array is resized or deleted.
See Also
See other functions in this section
Availability
In release 6.4.0
Get length of dynamic 1d ajlong array
Synopsis
Prototype
ajuint ajLongLen (
const AjPLong thys
);
Type | Name | Read/Write | Description |
const AjPLong | thys | Input | Source array |
ajuint | | RETURN | length |
Input
Returns
Description
Get length of dynamic 1d ajlong array
See Also
See other functions in this section
Availability
In release 6.4.0
Parses a string into a floating point array.
The array size is already set.
Synopsis
Prototype
AjBool ajFloatParse (
const AjPStr str,
AjPFloat* array
);
Type | Name | Read/Write | Description |
const AjPStr | str | Input | Input string |
AjPFloat* | array | Output | Array |
AjBool | | RETURN | ajTrue on success. |
Input
Output
Returns
AjBool: | ajTrue on success. |
Description
Parses a string into a floating point array.
The array size is already set.
See Also
See other functions in this section
Availability
In release 6.4.0
Writes a floating point array as a string
Synopsis
Prototype
void ajFloatStr (
const AjPFloat array,
ajint precision,
AjPStr* str
);
Type | Name | Read/Write | Description |
const AjPFloat | array | Input | Array |
ajint | precision | Input | floating point precision |
AjPStr* | str | Output | Output string |
void | | RETURN | |
Input
array: | (Input) | Array |
precision: | (Input) | floating point precision |
Output
str: | (Output) | Output string |
Returns
Description
Writes a floating point array as a string
See Also
See other functions in this section
Availability
In release 6.4.0
Writes a floating point array to the debug file
Synopsis
Prototype
void ajFloatTrace (
const AjPFloat array,
ajint precision,
const char* text
);
Type | Name | Read/Write | Description |
const AjPFloat | array | Input | Array |
ajint | precision | Input | floating point precision |
const char* | text | Input | Report title |
void | | RETURN | |
Input
array: | (Input) | Array |
precision: | (Input) | floating point precision |
text: | (Input) | Report title |
Returns
Description
Writes a floating point array to the debug file
See Also
See other functions in this section
Availability
In release 6.4.0
Creates an AjPStr array from a string of comma separated tokens
Synopsis
Prototype
ajuint ajArrCommaList (
const AjPStr s,
AjPStr** a
);
Type | Name | Read/Write | Description |
const AjPStr | s | Input | Line containing comma separated strings |
AjPStr** | a | Output | array pointer to create and load |
ajuint | | RETURN | number of array elements created |
Input
s: | (Input) | Line containing comma separated strings |
Output
a: | (Output) | array pointer to create and load |
Returns
ajuint: | number of array elements created |
Description
Creates an AjPStr array from a string of comma separated tokens
See Also
See other functions in this section
Availability
In release 6.4.0
Creates a double array from a string of columns
Synopsis
Prototype
double* ajArrDoubleLine (
const AjPStr line,
const char* delim,
ajuint startcol,
ajuint endcol
);
Type | Name | Read/Write | Description |
const AjPStr | line | Input | Line containing numbers |
const char* | delim | Input | Delimiter string for tokens |
ajuint | startcol | Input | Start token (1 to n) |
ajuint | endcol | Input | End token (1 to n) |
double* | | RETURN | Allocated array of integers |
Input
line: | (Input) | Line containing numbers |
delim: | (Input) | Delimiter string for tokens |
startcol: | (Input) | Start token (1 to n) |
endcol: | (Input) | End token (1 to n) |
Returns
double*: | Allocated array of integers |
Description
Creates a double array from a string of columns
See Also
See other functions in this section
Availability
In release 6.4.0
Creates an Int array from a string of columns
Synopsis
Prototype
ajint* ajArrIntLine (
const AjPStr line,
const char* delim,
ajuint startcol,
ajuint endcol
);
Type | Name | Read/Write | Description |
const AjPStr | line | Input | Line containing numbers |
const char* | delim | Input | Delimiter string for tokens |
ajuint | startcol | Input | Start token (1 to n) |
ajuint | endcol | Input | End token (1 to n) |
ajint* | | RETURN | Allocated array of integers |
Input
line: | (Input) | Line containing numbers |
delim: | (Input) | Delimiter string for tokens |
startcol: | (Input) | Start token (1 to n) |
endcol: | (Input) | End token (1 to n) |
Returns
ajint*: | Allocated array of integers |
Description
Creates an Int array from a string of columns
See Also
See other functions in this section
Availability
In release 6.4.0
Creates a Float array from a string of columns
Synopsis
Prototype
float* ajArrFloatLine (
const AjPStr line,
const char* delim,
ajuint startcol,
ajuint endcol
);
Type | Name | Read/Write | Description |
const AjPStr | line | Input | Line containing numbers |
const char* | delim | Input | Delimiter string for tokens |
ajuint | startcol | Input | Start token (1 to n) |
ajuint | endcol | Input | End token (1 to n) |
float* | | RETURN | Allocated array of integers |
Input
line: | (Input) | Line containing numbers |
delim: | (Input) | Delimiter string for tokens |
startcol: | (Input) | Start token (1 to n) |
endcol: | (Input) | End token (1 to n) |
Returns
float*: | Allocated array of integers |
Description
Creates a Float array from a string of columns
See Also
See other functions in this section
Availability
In release 6.4.0
Default constructor for empty AJAX 2D integer arrays.
Synopsis
Prototype
AjPInt2d ajInt2dNew (
void
);
Type | Name | Read/Write | Description |
AjPInt2d | | RETURN | Pointer to an empty integer array structure |
Returns
AjPInt2d: | Pointer to an empty integer array structure |
Description
Default constructor for empty AJAX 2D integer arrays.
See Also
See other functions in this section
Availability
In release 6.4.0
Constructor given an initial reserved size.
Synopsis
Prototype
AjPInt2d ajInt2dNewRes (
ajuint size
);
Type | Name | Read/Write | Description |
ajuint | size | Input | Reserved size 1st dim |
AjPInt2d | | RETURN | Pointer to an empty integer 2d array struct of
specified size. |
Input
size: | (Input) | Reserved size 1st dim |
Returns
AjPInt2d: | Pointer to an empty integer 2d array struct of
specified size. |
Description
Constructor given an initial reserved size.
See Also
See other functions in this section
Availability
In release 6.4.0
Constructor given an initial reserved size in both dimensions
Synopsis
Prototype
AjPInt2d ajInt2dNewResRes2 (
ajuint size,
ajuint size2
);
Type | Name | Read/Write | Description |
ajuint | size | Input | Reserved size 1st dim |
ajuint | size2 | Input | Reserved size 2nd dim |
AjPInt2d | | RETURN | Pointer to an empty integer 2d array struct of
specified size. |
Input
size: | (Input) | Reserved size 1st dim |
size2: | (Input) | Reserved size 2nd dim |
Returns
AjPInt2d: | Pointer to an empty integer 2d array struct of
specified size. |
Description
Constructor given an initial reserved size in both dimensions
See Also
See other functions in this section
Availability
In release 6.4.0
Default destructor for AJAX integer arrays.
If the given array is a NULL pointer, simply returns.
Synopsis
Prototype
void ajInt2dDel (
AjPInt2d* thys
);
Type | Name | Read/Write | Description |
AjPInt2d* | thys | Delete | Pointer to the ajint array to be deleted.
The pointer is always deleted. |
void | | RETURN | |
Output
thys: | (Delete) | Pointer to the ajint array to be deleted.
The pointer is always deleted. |
Returns
Description
Default destructor for AJAX integer arrays.
If the given array is a NULL pointer, simply returns.
See Also
See other functions in this section
Availability
In release 6.4.0
Retrieve an element from an AJAX 2d integer array.
If the given array is a NULL pointer, simply returns.
Synopsis
Prototype
ajint ajInt2dGet (
const AjPInt2d thys,
ajuint elem1,
ajuint elem2
);
Type | Name | Read/Write | Description |
const AjPInt2d | thys | Input | Pointer to the ajint array. |
ajuint | elem1 | Input | array element. |
ajuint | elem2 | Input | array element. |
ajint | | RETURN | contents of array element |
Input
thys: | (Input) | Pointer to the ajint array. |
elem1: | (Input) | array element. |
elem2: | (Input) | array element. |
Returns
ajint: | contents of array element |
Description
Retrieve an element from an AJAX 2d integer array.
If the given array is a NULL pointer, simply returns.
See Also
See other functions in this section
Availability
In release 6.4.0
Load an integer 2d array element.
If the given array is a NULL pointer an error is generated.
If the array is of insufficient size then the array is extended.
Negative indices generate an error.
Synopsis
Prototype
AjBool ajInt2dPut (
AjPInt2d* thys,
ajuint elem1,
ajuint elem2,
ajint v
);
Type | Name | Read/Write | Description |
AjPInt2d* | thys | Output | Pointer to the ajint array. |
ajuint | elem1 | Input | array element. |
ajuint | elem2 | Input | array element. |
ajint | v | Input | value to load. |
AjBool | | RETURN | true if any array was extended. |
Input
elem1: | (Input) | array element. |
elem2: | (Input) | array element. |
v: | (Input) | value to load. |
Output
thys: | (Output) | Pointer to the ajint array. |
Returns
AjBool: | true if any array was extended. |
Description
Load an integer 2d array element.
If the given array is a NULL pointer an error is generated.
If the array is of insufficient size then the array is extended.
Negative indices generate an error.
See Also
See other functions in this section
Availability
In release 6.4.0
Get lengths of 2d ajint array
Synopsis
Prototype
void ajInt2dLen (
const AjPInt2d thys,
ajuint* len1,
ajuint* len2
);
Type | Name | Read/Write | Description |
const AjPInt2d | thys | Input | Pointer to the ajint array. |
ajuint* | len1 | Output | Length of 1st dim |
ajuint* | len2 | Output | Length of 2nd dim |
void | | RETURN | |
Input
thys: | (Input) | Pointer to the ajint array. |
Output
len1: | (Output) | Length of 1st dim |
len2: | (Output) | Length of 2nd dim |
Returns
Description
Get lengths of 2d ajint array
See Also
See other functions in this section
Availability
In release 6.4.0
Convert AjPInt2d to ajint
Synopsis
Prototype
ajint** ajInt2dInt (
const AjPInt2d thys
);
Type | Name | Read/Write | Description |
const AjPInt2d | thys | Input | Pointer to the ajint array. |
ajint** | | RETURN | converted value. |
Input
thys: | (Input) | Pointer to the ajint array. |
Returns
Description
Convert AjPInt2d to ajint
See Also
See other functions in this section
Availability
In release 6.4.0
Default constructor for empty AJAX 3D integer arrays.
Synopsis
Prototype
AjPInt3d ajInt3dNew (
void
);
Type | Name | Read/Write | Description |
AjPInt3d | | RETURN | Pointer to an empty integer array structure |
Returns
AjPInt3d: | Pointer to an empty integer array structure |
Description
Default constructor for empty AJAX 3D integer arrays.
See Also
See other functions in this section
Availability
In release 6.4.0
Constructor given an initial reserved size.
Synopsis
Prototype
AjPInt3d ajInt3dNewRes (
ajuint size
);
Type | Name | Read/Write | Description |
ajuint | size | Input | Reserved size 1st dim |
AjPInt3d | | RETURN | Pointer to an empty integer 3d array struct of
specified size. |
Input
size: | (Input) | Reserved size 1st dim |
Returns
AjPInt3d: | Pointer to an empty integer 3d array struct of
specified size. |
Description
Constructor given an initial reserved size.
See Also
See other functions in this section
Availability
In release 6.4.0
Default destructor for AJAX integer arrays.
If the given array is a NULL pointer, simply returns.
Synopsis
Prototype
void ajInt3dDel (
AjPInt3d* thys
);
Type | Name | Read/Write | Description |
AjPInt3d* | thys | Delete | Pointer to the ajint array to be deleted.
The pointer is always deleted. |
void | | RETURN | |
Output
thys: | (Delete) | Pointer to the ajint array to be deleted.
The pointer is always deleted. |
Returns
Description
Default destructor for AJAX integer arrays.
If the given array is a NULL pointer, simply returns.
See Also
See other functions in this section
Availability
In release 6.4.0
Retrieve an element from an AJAX 3d integer array.
If the given array is a NULL pointer, simply returns.
Synopsis
Prototype
ajint ajInt3dGet (
const AjPInt3d thys,
ajuint elem1,
ajuint elem2,
ajuint elem3
);
Type | Name | Read/Write | Description |
const AjPInt3d | thys | Input | Pointer to the ajint array. |
ajuint | elem1 | Input | array element. |
ajuint | elem2 | Input | array element. |
ajuint | elem3 | Input | array element. |
ajint | | RETURN | contents of array element |
Input
thys: | (Input) | Pointer to the ajint array. |
elem1: | (Input) | array element. |
elem2: | (Input) | array element. |
elem3: | (Input) | array element. |
Returns
ajint: | contents of array element |
Description
Retrieve an element from an AJAX 3d integer array.
If the given array is a NULL pointer, simply returns.
See Also
See other functions in this section
Availability
In release 6.4.0
Load an integer 3d array element.
If the given array is a NULL pointer an error is generated.
If the array is of insufficient size then the array is extended.
Negative indices generate an error.
Synopsis
Prototype
AjBool ajInt3dPut (
AjPInt3d* thys,
ajuint elem1,
ajuint elem2,
ajuint elem3,
ajint v
);
Type | Name | Read/Write | Description |
AjPInt3d* | thys | Output | Pointer to the ajint array. |
ajuint | elem1 | Input | array element. |
ajuint | elem2 | Input | array element. |
ajuint | elem3 | Input | array element. |
ajint | v | Input | value to load. |
AjBool | | RETURN | true if any array was extended. |
Input
elem1: | (Input) | array element. |
elem2: | (Input) | array element. |
elem3: | (Input) | array element. |
v: | (Input) | value to load. |
Output
thys: | (Output) | Pointer to the ajint array. |
Returns
AjBool: | true if any array was extended. |
Description
Load an integer 3d array element.
If the given array is a NULL pointer an error is generated.
If the array is of insufficient size then the array is extended.
Negative indices generate an error.
See Also
See other functions in this section
Availability
In release 6.4.0
Get lengths of 3d ajint array
Synopsis
Prototype
void ajInt3dLen (
const AjPInt3d thys,
ajuint* len1,
ajuint* len2,
ajuint* len3
);
Type | Name | Read/Write | Description |
const AjPInt3d | thys | Input | Pointer to the ajint array. |
ajuint* | len1 | Output | Length of 1st dim |
ajuint* | len2 | Output | Length of 2nd dim |
ajuint* | len3 | Output | Length of 3rd dim |
void | | RETURN | |
Input
thys: | (Input) | Pointer to the ajint array. |
Output
len1: | (Output) | Length of 1st dim |
len2: | (Output) | Length of 2nd dim |
len3: | (Output) | Length of 3rd dim |
Returns
Description
Get lengths of 3d ajint array
See Also
See other functions in this section
Availability
In release 6.4.0
Convert AjPInt3d to ajint
Synopsis
Prototype
ajint*** ajInt3dInt (
const AjPInt3d thys
);
Type | Name | Read/Write | Description |
const AjPInt3d | thys | Input | Pointer to the ajint array. |
ajint*** | | RETURN | converted values. |
Input
thys: | (Input) | Pointer to the ajint array. |
Returns
ajint***: | converted values. |
Description
Convert AjPInt3d to ajint
See Also
See other functions in this section
Availability
In release 6.4.0
Default constructor for empty AJAX 2D integer arrays.
Synopsis
Prototype
AjPUint2d ajUint2dNew (
void
);
Type | Name | Read/Write | Description |
AjPUint2d | | RETURN | Pointer to an empty integer array structure |
Returns
AjPUint2d: | Pointer to an empty integer array structure |
Description
Default constructor for empty AJAX 2D integer arrays.
See Also
See other functions in this section
Availability
In release 6.4.0
Constructor given an initial reserved size.
Synopsis
Prototype
AjPUint2d ajUint2dNewRes (
ajuint size
);
Type | Name | Read/Write | Description |
ajuint | size | Input | Reserved size 1st dim |
AjPUint2d | | RETURN | Pointer to an empty integer 2d array struct of
specified size. |
Input
size: | (Input) | Reserved size 1st dim |
Returns
AjPUint2d: | Pointer to an empty integer 2d array struct of
specified size. |
Description
Constructor given an initial reserved size.
See Also
See other functions in this section
Availability
In release 6.4.0
Constructor given an initial reserved size in both dimensions
Synopsis
Prototype
AjPUint2d ajUint2dNewResRes2 (
ajuint size,
ajuint size2
);
Type | Name | Read/Write | Description |
ajuint | size | Input | Reserved size 1st dim |
ajuint | size2 | Input | Reserved size 2nd dim |
AjPUint2d | | RETURN | Pointer to an empty integer 2d array struct of
specified size. |
Input
size: | (Input) | Reserved size 1st dim |
size2: | (Input) | Reserved size 2nd dim |
Returns
AjPUint2d: | Pointer to an empty integer 2d array struct of
specified size. |
Description
Constructor given an initial reserved size in both dimensions
See Also
See other functions in this section
Availability
In release 6.4.0
Default destructor for AJAX unsigned integer arrays.
If the given array is a NULL pointer, simply returns.
Synopsis
Prototype
void ajUint2dDel (
AjPUint2d* thys
);
Type | Name | Read/Write | Description |
AjPUint2d* | thys | Delete | Pointer to the ajuint array to be deleted.
The pointer is always deleted. |
void | | RETURN | |
Output
thys: | (Delete) | Pointer to the ajuint array to be deleted.
The pointer is always deleted. |
Returns
Description
Default destructor for AJAX unsigned integer arrays.
If the given array is a NULL pointer, simply returns.
See Also
See other functions in this section
Availability
In release 6.4.0
Retrieve an element from an AJAX 2d unsigned integer array.
If the given array is a NULL pointer, simply returns.
Synopsis
Prototype
ajuint ajUint2dGet (
const AjPUint2d thys,
ajuint elem1,
ajuint elem2
);
Type | Name | Read/Write | Description |
const AjPUint2d | thys | Input | Pointer to the ajuint array. |
ajuint | elem1 | Input | array element. |
ajuint | elem2 | Input | array element. |
ajuint | | RETURN | contents of array element |
Input
thys: | (Input) | Pointer to the ajuint array. |
elem1: | (Input) | array element. |
elem2: | (Input) | array element. |
Returns
ajuint: | contents of array element |
Description
Retrieve an element from an AJAX 2d unsigned integer array.
If the given array is a NULL pointer, simply returns.
See Also
See other functions in this section
Availability
In release 6.4.0
Load an unsigned integer 2d array element.
If the given array is a NULL pointer an error is generated.
If the array is of insufficient size then the array is extended.
Negative indices generate an error.
Synopsis
Prototype
AjBool ajUint2dPut (
AjPUint2d* thys,
ajuint elem1,
ajuint elem2,
ajuint v
);
Type | Name | Read/Write | Description |
AjPUint2d* | thys | Output | Pointer to the ajuint array. |
ajuint | elem1 | Input | array element. |
ajuint | elem2 | Input | array element. |
ajuint | v | Input | value to load. |
AjBool | | RETURN | true if any array was extended. |
Input
elem1: | (Input) | array element. |
elem2: | (Input) | array element. |
v: | (Input) | value to load. |
Output
thys: | (Output) | Pointer to the ajuint array. |
Returns
AjBool: | true if any array was extended. |
Description
Load an unsigned integer 2d array element.
If the given array is a NULL pointer an error is generated.
If the array is of insufficient size then the array is extended.
Negative indices generate an error.
See Also
See other functions in this section
Availability
In release 6.4.0
Get lengths of 2d ajuint array
Synopsis
Prototype
void ajUint2dLen (
const AjPUint2d thys,
ajuint* len1,
ajuint* len2
);
Type | Name | Read/Write | Description |
const AjPUint2d | thys | Input | Pointer to the ajuint array. |
ajuint* | len1 | Output | Length of 1st dim |
ajuint* | len2 | Output | Length of 2nd dim |
void | | RETURN | |
Input
thys: | (Input) | Pointer to the ajuint array. |
Output
len1: | (Output) | Length of 1st dim |
len2: | (Output) | Length of 2nd dim |
Returns
Description
Get lengths of 2d ajuint array
See Also
See other functions in this section
Availability
In release 6.4.0
Convert AjPUint2d to ajuint
Synopsis
Prototype
ajuint** ajUint2dUint (
const AjPUint2d thys
);
Type | Name | Read/Write | Description |
const AjPUint2d | thys | Input | Pointer to the ajuint array. |
ajuint** | | RETURN | converted value. |
Input
thys: | (Input) | Pointer to the ajuint array. |
Returns
ajuint**: | converted value. |
Description
Convert AjPUint2d to ajuint
See Also
See other functions in this section
Availability
In release 6.4.0
Default constructor for empty AJAX 3D unsigned integer arrays.
Synopsis
Prototype
AjPUint3d ajUint3dNew (
void
);
Type | Name | Read/Write | Description |
AjPUint3d | | RETURN | Pointer to an empty unsigned integer array structure |
Returns
AjPUint3d: | Pointer to an empty unsigned integer array structure |
Description
Default constructor for empty AJAX 3D unsigned integer arrays.
See Also
See other functions in this section
Availability
In release 6.4.0
Constructor given an initial reserved size.
Synopsis
Prototype
AjPUint3d ajUint3dNewRes (
ajuint size
);
Type | Name | Read/Write | Description |
ajuint | size | Input | Reserved size 1st dim |
AjPUint3d | | RETURN | Pointer to an empty unsigned integer 3d array struct of
specified size. |
Input
size: | (Input) | Reserved size 1st dim |
Returns
AjPUint3d: | Pointer to an empty unsigned integer 3d array struct of
specified size. |
Description
Constructor given an initial reserved size.
See Also
See other functions in this section
Availability
In release 6.4.0
Default destructor for AJAX unsigned integer arrays.
If the given array is a NULL pointer, simply returns.
Synopsis
Prototype
void ajUint3dDel (
AjPUint3d* thys
);
Type | Name | Read/Write | Description |
AjPUint3d* | thys | Delete | Pointer to the ajuint array to be deleted.
The pointer is always deleted. |
void | | RETURN | |
Output
thys: | (Delete) | Pointer to the ajuint array to be deleted.
The pointer is always deleted. |
Returns
Description
Default destructor for AJAX unsigned integer arrays.
If the given array is a NULL pointer, simply returns.
See Also
See other functions in this section
Availability
In release 6.4.0
Retrieve an element from an AJAX 3d integer array.
If the given array is a NULL pointer, simply returns.
Synopsis
Prototype
ajuint ajUint3dGet (
const AjPUint3d thys,
ajuint elem1,
ajuint elem2,
ajuint elem3
);
Type | Name | Read/Write | Description |
const AjPUint3d | thys | Input | Pointer to the ajuint array. |
ajuint | elem1 | Input | array element. |
ajuint | elem2 | Input | array element. |
ajuint | elem3 | Input | array element. |
ajuint | | RETURN | contents of array element |
Input
thys: | (Input) | Pointer to the ajuint array. |
elem1: | (Input) | array element. |
elem2: | (Input) | array element. |
elem3: | (Input) | array element. |
Returns
ajuint: | contents of array element |
Description
Retrieve an element from an AJAX 3d integer array.
If the given array is a NULL pointer, simply returns.
See Also
See other functions in this section
Availability
In release 6.4.0
Load an unsigned integer 3d array element.
If the given array is a NULL pointer an error is generated.
If the array is of insufficient size then the array is extended.
Negative indices generate an error.
Synopsis
Prototype
AjBool ajUint3dPut (
AjPUint3d* thys,
ajuint elem1,
ajuint elem2,
ajuint elem3,
ajuint v
);
Type | Name | Read/Write | Description |
AjPUint3d* | thys | Output | Pointer to the ajint array. |
ajuint | elem1 | Input | array element. |
ajuint | elem2 | Input | array element. |
ajuint | elem3 | Input | array element. |
ajuint | v | Input | value to load. |
AjBool | | RETURN | true if any array was extended. |
Input
elem1: | (Input) | array element. |
elem2: | (Input) | array element. |
elem3: | (Input) | array element. |
v: | (Input) | value to load. |
Output
thys: | (Output) | Pointer to the ajint array. |
Returns
AjBool: | true if any array was extended. |
Description
Load an unsigned integer 3d array element.
If the given array is a NULL pointer an error is generated.
If the array is of insufficient size then the array is extended.
Negative indices generate an error.
See Also
See other functions in this section
Availability
In release 6.4.0
Get lengths of 3d ajuint array
Synopsis
Prototype
void ajUint3dLen (
const AjPUint3d thys,
ajuint* len1,
ajuint* len2,
ajuint* len3
);
Type | Name | Read/Write | Description |
const AjPUint3d | thys | Input | Pointer to the ajuint array. |
ajuint* | len1 | Output | Length of 1st dim |
ajuint* | len2 | Output | Length of 2nd dim |
ajuint* | len3 | Output | Length of 3rd dim |
void | | RETURN | |
Input
thys: | (Input) | Pointer to the ajuint array. |
Output
len1: | (Output) | Length of 1st dim |
len2: | (Output) | Length of 2nd dim |
len3: | (Output) | Length of 3rd dim |
Returns
Description
Get lengths of 3d ajuint array
See Also
See other functions in this section
Availability
In release 6.4.0
Convert AjPUint3d to ajuint
Synopsis
Prototype
ajuint*** ajUint3dUint (
const AjPUint3d thys
);
Type | Name | Read/Write | Description |
const AjPUint3d | thys | Input | Pointer to the ajuint array. |
ajuint*** | | RETURN | converted values. |
Input
thys: | (Input) | Pointer to the ajuint array. |
Returns
ajuint***: | converted values. |
Description
Convert AjPUint3d to ajuint
See Also
See other functions in this section
Availability
In release 6.4.0
Default constructor for empty AJAX 2D float arrays.
Synopsis
Prototype
AjPFloat2d ajFloat2dNew (
void
);
Type | Name | Read/Write | Description |
AjPFloat2d | | RETURN | Pointer to an empty float array structure |
Returns
AjPFloat2d: | Pointer to an empty float array structure |
Description
Default constructor for empty AJAX 2D float arrays.
See Also
See other functions in this section
Availability
In release 6.4.0
Constructor given an initial reserved size.
Synopsis
Prototype
AjPFloat2d ajFloat2dNewRes (
ajuint size
);
Type | Name | Read/Write | Description |
ajuint | size | Input | Reserved size 1st dim |
AjPFloat2d | | RETURN | Pointer to an empty float 2d array struct of
specified size. |
Input
size: | (Input) | Reserved size 1st dim |
Returns
AjPFloat2d: | Pointer to an empty float 2d array struct of
specified size. |
Description
Constructor given an initial reserved size.
See Also
See other functions in this section
Availability
In release 6.4.0
Default destructor for AJAX float arrays.
If the given array is a NULL pointer, simply returns.
Synopsis
Prototype
void ajFloat2dDel (
AjPFloat2d* thys
);
Type | Name | Read/Write | Description |
AjPFloat2d* | thys | Delete | Pointer to the float array to be deleted.
The pointer is always deleted. |
void | | RETURN | |
Output
thys: | (Delete) | Pointer to the float array to be deleted.
The pointer is always deleted. |
Returns
Description
Default destructor for AJAX float arrays.
If the given array is a NULL pointer, simply returns.
See Also
See other functions in this section
Availability
In release 6.4.0
Retrieve an element from an AJAX 2d float array.
If the given array is a NULL pointer, simply returns.
Synopsis
Prototype
float ajFloat2dGet (
const AjPFloat2d thys,
ajuint elem1,
ajuint elem2
);
Type | Name | Read/Write | Description |
const AjPFloat2d | thys | Input | Pointer to the float array. |
ajuint | elem1 | Input | array element. |
ajuint | elem2 | Input | array element. |
float | | RETURN | contents of array element |
Input
thys: | (Input) | Pointer to the float array. |
elem1: | (Input) | array element. |
elem2: | (Input) | array element. |
Returns
float: | contents of array element |
Description
Retrieve an element from an AJAX 2d float array.
If the given array is a NULL pointer, simply returns.
See Also
See other functions in this section
Availability
In release 6.4.0
Load a float 2d array element.
If the given array is a NULL pointer an error is generated.
If the array is of insufficient size then the array is extended.
Negative indices generate an error.
Synopsis
Prototype
AjBool ajFloat2dPut (
AjPFloat2d* thys,
ajuint elem1,
ajuint elem2,
float v
);
Type | Name | Read/Write | Description |
AjPFloat2d* | thys | Output | Pointer to the float array. |
ajuint | elem1 | Input | array element. |
ajuint | elem2 | Input | array element. |
float | v | Input | value to load. |
AjBool | | RETURN | true if any array was extended. |
Input
elem1: | (Input) | array element. |
elem2: | (Input) | array element. |
v: | (Input) | value to load. |
Output
thys: | (Output) | Pointer to the float array. |
Returns
AjBool: | true if any array was extended. |
Description
Load a float 2d array element.
If the given array is a NULL pointer an error is generated.
If the array is of insufficient size then the array is extended.
Negative indices generate an error.
See Also
See other functions in this section
Availability
In release 6.4.0
Get lengths of 2d float array
Synopsis
Prototype
void ajFloat2dLen (
const AjPFloat2d thys,
ajuint* len1,
ajuint* len2
);
Type | Name | Read/Write | Description |
const AjPFloat2d | thys | Input | Pointer to the float array. |
ajuint* | len1 | Output | Length of 1st dim |
ajuint* | len2 | Output | Length of 2nd dim |
void | | RETURN | |
Input
thys: | (Input) | Pointer to the float array. |
Output
len1: | (Output) | Length of 1st dim |
len2: | (Output) | Length of 2nd dim |
Returns
Description
Get lengths of 2d float array
See Also
See other functions in this section
Availability
In release 6.4.0
Convert AjPFloat2d to float
Synopsis
Prototype
float** ajFloat2dFloat (
const AjPFloat2d thys
);
Type | Name | Read/Write | Description |
const AjPFloat2d | thys | Input | Pointer to the float array. |
float** | | RETURN | converted values. |
Input
thys: | (Input) | Pointer to the float array. |
Returns
float**: | converted values. |
Description
Convert AjPFloat2d to float
See Also
See other functions in this section
Availability
In release 6.4.0
Default constructor for empty AJAX 3D float arrays.
Synopsis
Prototype
AjPFloat3d ajFloat3dNew (
void
);
Type | Name | Read/Write | Description |
AjPFloat3d | | RETURN | Pointer to an empty float array structure |
Returns
AjPFloat3d: | Pointer to an empty float array structure |
Description
Default constructor for empty AJAX 3D float arrays.
See Also
See other functions in this section
Availability
In release 6.4.0
Constructor given an initial reserved size.
Synopsis
Prototype
AjPFloat3d ajFloat3dNewRes (
ajuint size
);
Type | Name | Read/Write | Description |
ajuint | size | Input | Reserved size 1st dim |
AjPFloat3d | | RETURN | Pointer to an empty float 3d array struct of
specified size. |
Input
size: | (Input) | Reserved size 1st dim |
Returns
AjPFloat3d: | Pointer to an empty float 3d array struct of
specified size. |
Description
Constructor given an initial reserved size.
See Also
See other functions in this section
Availability
In release 6.4.0
Default destructor for AJAX float arrays.
If the given array is a NULL pointer, simply returns.
Synopsis
Prototype
void ajFloat3dDel (
AjPFloat3d* thys
);
Type | Name | Read/Write | Description |
AjPFloat3d* | thys | Delete | Pointer to the float array to be deleted.
The pointer is always deleted. |
void | | RETURN | |
Output
thys: | (Delete) | Pointer to the float array to be deleted.
The pointer is always deleted. |
Returns
Description
Default destructor for AJAX float arrays.
If the given array is a NULL pointer, simply returns.
See Also
See other functions in this section
Availability
In release 6.4.0
Retrieve an element from an AJAX 3d float array.
If the given array is a NULL pointer, simply returns.
Synopsis
Prototype
float ajFloat3dGet (
const AjPFloat3d thys,
ajuint elem1,
ajuint elem2,
ajuint elem3
);
Type | Name | Read/Write | Description |
const AjPFloat3d | thys | Input | Pointer to the float array. |
ajuint | elem1 | Input | array element. |
ajuint | elem2 | Input | array element. |
ajuint | elem3 | Input | array element. |
float | | RETURN | contents of array element |
Input
thys: | (Input) | Pointer to the float array. |
elem1: | (Input) | array element. |
elem2: | (Input) | array element. |
elem3: | (Input) | array element. |
Returns
float: | contents of array element |
Description
Retrieve an element from an AJAX 3d float array.
If the given array is a NULL pointer, simply returns.
See Also
See other functions in this section
Availability
In release 6.4.0
Load a float 3d array element.
If the given array is a NULL pointer an error is generated.
If the array is of insufficient size then the array is extended.
Negative indices generate an error.
Synopsis
Prototype
AjBool ajFloat3dPut (
AjPFloat3d* thys,
ajuint elem1,
ajuint elem2,
ajuint elem3,
float v
);
Type | Name | Read/Write | Description |
AjPFloat3d* | thys | Output | Pointer to the float array. |
ajuint | elem1 | Input | array element. |
ajuint | elem2 | Input | array element. |
ajuint | elem3 | Input | array element. |
float | v | Input | value to load. |
AjBool | | RETURN | true if any array was extended. |
Input
elem1: | (Input) | array element. |
elem2: | (Input) | array element. |
elem3: | (Input) | array element. |
v: | (Input) | value to load. |
Output
thys: | (Output) | Pointer to the float array. |
Returns
AjBool: | true if any array was extended. |
Description
Load a float 3d array element.
If the given array is a NULL pointer an error is generated.
If the array is of insufficient size then the array is extended.
Negative indices generate an error.
See Also
See other functions in this section
Availability
In release 6.4.0
Get lengths of 3d float array
Synopsis
Prototype
void ajFloat3dLen (
const AjPFloat3d thys,
ajuint* len1,
ajuint* len2,
ajuint* len3
);
Type | Name | Read/Write | Description |
const AjPFloat3d | thys | Input | Pointer to the float array. |
ajuint* | len1 | Output | Length of 1st dim |
ajuint* | len2 | Output | Length of 2nd dim |
ajuint* | len3 | Output | Length of 3rd dim |
void | | RETURN | |
Input
thys: | (Input) | Pointer to the float array. |
Output
len1: | (Output) | Length of 1st dim |
len2: | (Output) | Length of 2nd dim |
len3: | (Output) | Length of 3rd dim |
Returns
Description
Get lengths of 3d float array
See Also
See other functions in this section
Availability
In release 6.4.0
Convert AjPFloat3d to float
Synopsis
Prototype
float*** ajFloat3dFloat (
const AjPFloat3d thys
);
Type | Name | Read/Write | Description |
const AjPFloat3d | thys | Input | Pointer to the float array. |
float*** | | RETURN | converted values. |
Input
thys: | (Input) | Pointer to the float array. |
Returns
float***: | converted values. |
Description
Convert AjPFloat3d to float
See Also
See other functions in this section
Availability
In release 6.4.0
Default constructor for empty AJAX 2D double arrays.
Synopsis
Prototype
AjPDouble2d ajDouble2dNew (
void
);
Type | Name | Read/Write | Description |
AjPDouble2d | | RETURN | Pointer to an empty double array structure |
Returns
AjPDouble2d: | Pointer to an empty double array structure |
Description
Default constructor for empty AJAX 2D double arrays.
See Also
See other functions in this section
Availability
In release 6.4.0
Constructor given an initial reserved size.
Synopsis
Prototype
AjPDouble2d ajDouble2dNewRes (
ajuint size
);
Type | Name | Read/Write | Description |
ajuint | size | Input | Reserved size 1st dim |
AjPDouble2d | | RETURN | Pointer to an empty double 2d array struct of
specified size. |
Input
size: | (Input) | Reserved size 1st dim |
Returns
AjPDouble2d: | Pointer to an empty double 2d array struct of
specified size. |
Description
Constructor given an initial reserved size.
See Also
See other functions in this section
Availability
In release 6.4.0
Default destructor for AJAX double arrays.
If the given array is a NULL pointer, simply returns.
Synopsis
Prototype
void ajDouble2dDel (
AjPDouble2d* thys
);
Type | Name | Read/Write | Description |
AjPDouble2d* | thys | Delete | Pointer to the double array to be deleted.
The pointer is always deleted. |
void | | RETURN | |
Output
thys: | (Delete) | Pointer to the double array to be deleted.
The pointer is always deleted. |
Returns
Description
Default destructor for AJAX double arrays.
If the given array is a NULL pointer, simply returns.
See Also
See other functions in this section
Availability
In release 6.4.0
Retrieve an element from an AJAX 2d double array.
If the given array is a NULL pointer, simply returns.
Synopsis
Prototype
double ajDouble2dGet (
const AjPDouble2d thys,
ajuint elem1,
ajuint elem2
);
Type | Name | Read/Write | Description |
const AjPDouble2d | thys | Input | Pointer to the double array. |
ajuint | elem1 | Input | array element. |
ajuint | elem2 | Input | array element. |
double | | RETURN | contents of array element |
Input
thys: | (Input) | Pointer to the double array. |
elem1: | (Input) | array element. |
elem2: | (Input) | array element. |
Returns
double: | contents of array element |
Description
Retrieve an element from an AJAX 2d double array.
If the given array is a NULL pointer, simply returns.
See Also
See other functions in this section
Availability
In release 6.4.0
Load a double 2d array element.
If the given array is a NULL pointer an error is generated.
If the array is of insufficient size then the array is extended.
Negative indices generate an error.
Synopsis
Prototype
AjBool ajDouble2dPut (
AjPDouble2d* thys,
ajuint elem1,
ajuint elem2,
double v
);
Type | Name | Read/Write | Description |
AjPDouble2d* | thys | Output | Pointer to the double array. |
ajuint | elem1 | Input | array element. |
ajuint | elem2 | Input | array element. |
double | v | Input | value to load. |
AjBool | | RETURN | true if any array was extended. |
Input
elem1: | (Input) | array element. |
elem2: | (Input) | array element. |
v: | (Input) | value to load. |
Output
thys: | (Output) | Pointer to the double array. |
Returns
AjBool: | true if any array was extended. |
Description
Load a double 2d array element.
If the given array is a NULL pointer an error is generated.
If the array is of insufficient size then the array is extended.
Negative indices generate an error.
See Also
See other functions in this section
Availability
In release 6.4.0
Get lengths of 2d double array
Synopsis
Prototype
void ajDouble2dLen (
const AjPDouble2d thys,
ajuint* len1,
ajuint* len2
);
Type | Name | Read/Write | Description |
const AjPDouble2d | thys | Input | Pointer to the double array. |
ajuint* | len1 | Output | Length of 1st dim |
ajuint* | len2 | Output | Length of 2nd dim |
void | | RETURN | |
Input
thys: | (Input) | Pointer to the double array. |
Output
len1: | (Output) | Length of 1st dim |
len2: | (Output) | Length of 2nd dim |
Returns
Description
Get lengths of 2d double array
See Also
See other functions in this section
Availability
In release 6.4.0
Convert AjPDouble2d to double
Synopsis
Prototype
double** ajDouble2dDouble (
const AjPDouble2d thys
);
Type | Name | Read/Write | Description |
const AjPDouble2d | thys | Input | Pointer to the double array. |
double** | | RETURN | converted values. |
Input
thys: | (Input) | Pointer to the double array. |
Returns
double**: | converted values. |
Description
Convert AjPDouble2d to double
See Also
See other functions in this section
Availability
In release 6.4.0
Default constructor for empty AJAX 3D double arrays.
Synopsis
Prototype
AjPDouble3d ajDouble3dNew (
void
);
Type | Name | Read/Write | Description |
AjPDouble3d | | RETURN | Pointer to an empty double array structure |
Returns
AjPDouble3d: | Pointer to an empty double array structure |
Description
Default constructor for empty AJAX 3D double arrays.
See Also
See other functions in this section
Availability
In release 6.4.0
Constructor given an initial reserved size.
Synopsis
Prototype
AjPDouble3d ajDouble3dNewRes (
ajuint size
);
Type | Name | Read/Write | Description |
ajuint | size | Input | Reserved size 1st dim |
AjPDouble3d | | RETURN | Pointer to an empty double 3d array struct of
specified size. |
Input
size: | (Input) | Reserved size 1st dim |
Returns
AjPDouble3d: | Pointer to an empty double 3d array struct of
specified size. |
Description
Constructor given an initial reserved size.
See Also
See other functions in this section
Availability
In release 6.4.0
Default destructor for AJAX double arrays.
If the given array is a NULL pointer, simply returns.
Synopsis
Prototype
void ajDouble3dDel (
AjPDouble3d* thys
);
Type | Name | Read/Write | Description |
AjPDouble3d* | thys | Delete | Pointer to the double array to be deleted.
The pointer is always deleted. |
void | | RETURN | |
Output
thys: | (Delete) | Pointer to the double array to be deleted.
The pointer is always deleted. |
Returns
Description
Default destructor for AJAX double arrays.
If the given array is a NULL pointer, simply returns.
See Also
See other functions in this section
Availability
In release 6.4.0
Retrieve an element from an AJAX 3d double array.
If the given array is a NULL pointer, simply returns.
Synopsis
Prototype
double ajDouble3dGet (
const AjPDouble3d thys,
ajuint elem1,
ajuint elem2,
ajuint elem3
);
Type | Name | Read/Write | Description |
const AjPDouble3d | thys | Input | Pointer to the double array. |
ajuint | elem1 | Input | array element. |
ajuint | elem2 | Input | array element. |
ajuint | elem3 | Input | array element. |
double | | RETURN | contents of array element |
Input
thys: | (Input) | Pointer to the double array. |
elem1: | (Input) | array element. |
elem2: | (Input) | array element. |
elem3: | (Input) | array element. |
Returns
double: | contents of array element |
Description
Retrieve an element from an AJAX 3d double array.
If the given array is a NULL pointer, simply returns.
See Also
See other functions in this section
Availability
In release 6.4.0
Load a double 3d array element.
If the given array is a NULL pointer an error is generated.
If the array is of insufficient size then the array is extended.
Negative indices generate an error.
Synopsis
Prototype
AjBool ajDouble3dPut (
AjPDouble3d* thys,
ajuint elem1,
ajuint elem2,
ajuint elem3,
double v
);
Type | Name | Read/Write | Description |
AjPDouble3d* | thys | Output | Pointer to the double array. |
ajuint | elem1 | Input | array element. |
ajuint | elem2 | Input | array element. |
ajuint | elem3 | Input | array element. |
double | v | Input | value to load. |
AjBool | | RETURN | true if any array was extended. |
Input
elem1: | (Input) | array element. |
elem2: | (Input) | array element. |
elem3: | (Input) | array element. |
v: | (Input) | value to load. |
Output
thys: | (Output) | Pointer to the double array. |
Returns
AjBool: | true if any array was extended. |
Description
Load a double 3d array element.
If the given array is a NULL pointer an error is generated.
If the array is of insufficient size then the array is extended.
Negative indices generate an error.
See Also
See other functions in this section
Availability
In release 6.4.0
Get lengths of 3d double array
Synopsis
Prototype
void ajDouble3dLen (
const AjPDouble3d thys,
ajuint* len1,
ajuint* len2,
ajuint* len3
);
Type | Name | Read/Write | Description |
const AjPDouble3d | thys | Input | Pointer to the double array. |
ajuint* | len1 | Output | Length of 1st dim |
ajuint* | len2 | Output | Length of 2nd dim |
ajuint* | len3 | Output | Length of 3rd dim |
void | | RETURN | |
Input
thys: | (Input) | Pointer to the double array. |
Output
len1: | (Output) | Length of 1st dim |
len2: | (Output) | Length of 2nd dim |
len3: | (Output) | Length of 3rd dim |
Returns
Description
Get lengths of 3d double array
See Also
See other functions in this section
Availability
In release 6.4.0
Convert AjPDouble3d to double
Synopsis
Prototype
double*** ajDouble3dDouble (
const AjPDouble3d thys
);
Type | Name | Read/Write | Description |
const AjPDouble3d | thys | Input | Pointer to the double array. |
double*** | | RETURN | converted values. |
Input
thys: | (Input) | Pointer to the double array. |
Returns
double***: | converted values. |
Description
Convert AjPDouble3d to double
See Also
See other functions in this section
Availability
In release 6.4.0
Default constructor for empty AJAX 2D short arrays.
Synopsis
Prototype
AjPShort2d ajShort2dNew (
void
);
Type | Name | Read/Write | Description |
AjPShort2d | | RETURN | Pointer to an empty short array structure |
Returns
AjPShort2d: | Pointer to an empty short array structure |
Description
Default constructor for empty AJAX 2D short arrays.
See Also
See other functions in this section
Availability
In release 6.4.0
Constructor given an initial reserved size.
Synopsis
Prototype
AjPShort2d ajShort2dNewRes (
ajuint size
);
Type | Name | Read/Write | Description |
ajuint | size | Input | Reserved size 1st dim |
AjPShort2d | | RETURN | Pointer to an empty short 2d array struct of
specified size. |
Input
size: | (Input) | Reserved size 1st dim |
Returns
AjPShort2d: | Pointer to an empty short 2d array struct of
specified size. |
Description
Constructor given an initial reserved size.
See Also
See other functions in this section
Availability
In release 6.4.0
Default destructor for AJAX short arrays.
If the given array is a NULL pointer, simply returns.
Synopsis
Prototype
void ajShort2dDel (
AjPShort2d* thys
);
Type | Name | Read/Write | Description |
AjPShort2d* | thys | Delete | Pointer to the short array to be deleted.
The pointer is always deleted. |
void | | RETURN | |
Output
thys: | (Delete) | Pointer to the short array to be deleted.
The pointer is always deleted. |
Returns
Description
Default destructor for AJAX short arrays.
If the given array is a NULL pointer, simply returns.
See Also
See other functions in this section
Availability
In release 6.4.0
Retrieve an element from an AJAX 2d short array.
If the given array is a NULL pointer, simply returns.
Synopsis
Prototype
short ajShort2dGet (
const AjPShort2d thys,
ajuint elem1,
ajuint elem2
);
Type | Name | Read/Write | Description |
const AjPShort2d | thys | Input | Pointer to the short array. |
ajuint | elem1 | Input | array element. |
ajuint | elem2 | Input | array element. |
short | | RETURN | contents of array element |
Input
thys: | (Input) | Pointer to the short array. |
elem1: | (Input) | array element. |
elem2: | (Input) | array element. |
Returns
short: | contents of array element |
Description
Retrieve an element from an AJAX 2d short array.
If the given array is a NULL pointer, simply returns.
See Also
See other functions in this section
Availability
In release 6.4.0
Load a short 2d array element.
If the given array is a NULL pointer an error is generated.
If the array is of insufficient size then the array is extended.
Negative indices generate an error.
Synopsis
Prototype
AjBool ajShort2dPut (
AjPShort2d* thys,
ajuint elem1,
ajuint elem2,
short v
);
Type | Name | Read/Write | Description |
AjPShort2d* | thys | Output | Pointer to the short array. |
ajuint | elem1 | Input | array element. |
ajuint | elem2 | Input | array element. |
short | v | Input | value to load. |
AjBool | | RETURN | true if any array was extended. |
Input
elem1: | (Input) | array element. |
elem2: | (Input) | array element. |
v: | (Input) | value to load. |
Output
thys: | (Output) | Pointer to the short array. |
Returns
AjBool: | true if any array was extended. |
Description
Load a short 2d array element.
If the given array is a NULL pointer an error is generated.
If the array is of insufficient size then the array is extended.
Negative indices generate an error.
See Also
See other functions in this section
Availability
In release 6.4.0
Get lengths of 2d short array
Synopsis
Prototype
void ajShort2dLen (
const AjPShort2d thys,
ajuint* len1,
ajuint* len2
);
Type | Name | Read/Write | Description |
const AjPShort2d | thys | Input | Pointer to the short array. |
ajuint* | len1 | Output | Length of 1st dim |
ajuint* | len2 | Output | Length of 2nd dim |
void | | RETURN | |
Input
thys: | (Input) | Pointer to the short array. |
Output
len1: | (Output) | Length of 1st dim |
len2: | (Output) | Length of 2nd dim |
Returns
Description
Get lengths of 2d short array
See Also
See other functions in this section
Availability
In release 6.4.0
Convert AjPShort2d to short
Synopsis
Prototype
short** ajShort2dShort (
const AjPShort2d thys
);
Type | Name | Read/Write | Description |
const AjPShort2d | thys | Input | Pointer to the short array. |
short** | | RETURN | converted values |
Input
thys: | (Input) | Pointer to the short array. |
Returns
Description
Convert AjPShort2d to short
See Also
See other functions in this section
Availability
In release 6.4.0
Default constructor for empty AJAX 3D short arrays.
Synopsis
Prototype
AjPShort3d ajShort3dNew (
void
);
Type | Name | Read/Write | Description |
AjPShort3d | | RETURN | Pointer to an empty short array structure |
Returns
AjPShort3d: | Pointer to an empty short array structure |
Description
Default constructor for empty AJAX 3D short arrays.
See Also
See other functions in this section
Availability
In release 6.4.0
Constructor given an initial reserved size.
Synopsis
Prototype
AjPShort3d ajShort3dNewRes (
ajuint size
);
Type | Name | Read/Write | Description |
ajuint | size | Input | Reserved size 1st dim |
AjPShort3d | | RETURN | Pointer to an empty short 3d array struct of
specified size. |
Input
size: | (Input) | Reserved size 1st dim |
Returns
AjPShort3d: | Pointer to an empty short 3d array struct of
specified size. |
Description
Constructor given an initial reserved size.
See Also
See other functions in this section
Availability
In release 6.4.0
Default destructor for AJAX short arrays.
If the given array is a NULL pointer, simply returns.
Synopsis
Prototype
void ajShort3dDel (
AjPShort3d* thys
);
Type | Name | Read/Write | Description |
AjPShort3d* | thys | Delete | Pointer to the short array to be deleted.
The pointer is always deleted. |
void | | RETURN | |
Output
thys: | (Delete) | Pointer to the short array to be deleted.
The pointer is always deleted. |
Returns
Description
Default destructor for AJAX short arrays.
If the given array is a NULL pointer, simply returns.
See Also
See other functions in this section
Availability
In release 6.4.0
Retrieve an element from an AJAX 3d short array.
If the given array is a NULL pointer, simply returns.
Synopsis
Prototype
short ajShort3dGet (
const AjPShort3d thys,
ajuint elem1,
ajuint elem2,
ajuint elem3
);
Type | Name | Read/Write | Description |
const AjPShort3d | thys | Input | Pointer to the short array. |
ajuint | elem1 | Input | array element. |
ajuint | elem2 | Input | array element. |
ajuint | elem3 | Input | array element. |
short | | RETURN | contents of array element |
Input
thys: | (Input) | Pointer to the short array. |
elem1: | (Input) | array element. |
elem2: | (Input) | array element. |
elem3: | (Input) | array element. |
Returns
short: | contents of array element |
Description
Retrieve an element from an AJAX 3d short array.
If the given array is a NULL pointer, simply returns.
See Also
See other functions in this section
Availability
In release 6.4.0
Load a short 3d array element.
If the given array is a NULL pointer an error is generated.
If the array is of insufficient size then the array is extended.
Negative indices generate an error.
Synopsis
Prototype
AjBool ajShort3dPut (
AjPShort3d* thys,
ajuint elem1,
ajuint elem2,
ajuint elem3,
short v
);
Type | Name | Read/Write | Description |
AjPShort3d* | thys | Output | Pointer to the short array. |
ajuint | elem1 | Input | array element. |
ajuint | elem2 | Input | array element. |
ajuint | elem3 | Input | array element. |
short | v | Input | value to load. |
AjBool | | RETURN | true if any array was extended. |
Input
elem1: | (Input) | array element. |
elem2: | (Input) | array element. |
elem3: | (Input) | array element. |
v: | (Input) | value to load. |
Output
thys: | (Output) | Pointer to the short array. |
Returns
AjBool: | true if any array was extended. |
Description
Load a short 3d array element.
If the given array is a NULL pointer an error is generated.
If the array is of insufficient size then the array is extended.
Negative indices generate an error.
See Also
See other functions in this section
Availability
In release 6.4.0
Get lengths of 3d short array
Synopsis
Prototype
void ajShort3dLen (
const AjPShort3d thys,
ajuint* len1,
ajuint* len2,
ajuint* len3
);
Type | Name | Read/Write | Description |
const AjPShort3d | thys | Input | Pointer to the short array. |
ajuint* | len1 | Output | Length of 1st dim |
ajuint* | len2 | Output | Length of 2nd dim |
ajuint* | len3 | Output | Length of 3rd dim |
void | | RETURN | |
Input
thys: | (Input) | Pointer to the short array. |
Output
len1: | (Output) | Length of 1st dim |
len2: | (Output) | Length of 2nd dim |
len3: | (Output) | Length of 3rd dim |
Returns
Description
Get lengths of 3d short array
See Also
See other functions in this section
Availability
In release 6.4.0
Convert AjPShort3d to short
Synopsis
Prototype
short*** ajShort3dShort (
const AjPShort3d thys
);
Type | Name | Read/Write | Description |
const AjPShort3d | thys | Input | Pointer to the short array. |
short*** | | RETURN | converted values. |
Input
thys: | (Input) | Pointer to the short array. |
Returns
short***: | converted values. |
Description
Convert AjPShort3d to short
See Also
See other functions in this section
Availability
In release 6.4.0
Default constructor for empty AJAX 2D ajlong arrays.
Synopsis
Prototype
AjPLong2d ajLong2dNew (
void
);
Type | Name | Read/Write | Description |
AjPLong2d | | RETURN | Pointer to an empty ajlong array structure |
Returns
AjPLong2d: | Pointer to an empty ajlong array structure |
Description
Default constructor for empty AJAX 2D ajlong arrays.
See Also
See other functions in this section
Availability
In release 6.4.0
Constructor given an initial reserved size.
Synopsis
Prototype
AjPLong2d ajLong2dNewRes (
ajuint size
);
Type | Name | Read/Write | Description |
ajuint | size | Input | Reserved size 1st dim |
AjPLong2d | | RETURN | Pointer to an empty ajlong 2d array struct of
specified size. |
Input
size: | (Input) | Reserved size 1st dim |
Returns
AjPLong2d: | Pointer to an empty ajlong 2d array struct of
specified size. |
Description
Constructor given an initial reserved size.
See Also
See other functions in this section
Availability
In release 6.4.0
Default destructor for AJAX ajlong arrays.
If the given array is a NULL pointer, simply returns.
Synopsis
Prototype
void ajLong2dDel (
AjPLong2d* thys
);
Type | Name | Read/Write | Description |
AjPLong2d* | thys | Delete | Pointer to the ajlong array to be deleted.
The pointer is always deleted. |
void | | RETURN | |
Output
thys: | (Delete) | Pointer to the ajlong array to be deleted.
The pointer is always deleted. |
Returns
Description
Default destructor for AJAX ajlong arrays.
If the given array is a NULL pointer, simply returns.
See Also
See other functions in this section
Availability
In release 6.4.0
Retrieve an element from an AJAX 2d ajlong array.
If the given array is a NULL pointer, simply returns.
Synopsis
Prototype
ajlong ajLong2dGet (
const AjPLong2d thys,
ajuint elem1,
ajuint elem2
);
Type | Name | Read/Write | Description |
const AjPLong2d | thys | Input | Pointer to the ajlong array. |
ajuint | elem1 | Input | array element. |
ajuint | elem2 | Input | array element. |
ajlong | | RETURN | contents of array element |
Input
thys: | (Input) | Pointer to the ajlong array. |
elem1: | (Input) | array element. |
elem2: | (Input) | array element. |
Returns
ajlong: | contents of array element |
Description
Retrieve an element from an AJAX 2d ajlong array.
If the given array is a NULL pointer, simply returns.
See Also
See other functions in this section
Availability
In release 6.4.0
Load a ajlong 2d array element.
If the given array is a NULL pointer an error is generated.
If the array is of insufficient size then the array is extended.
Negative indices generate an error.
Synopsis
Prototype
AjBool ajLong2dPut (
AjPLong2d* thys,
ajuint elem1,
ajuint elem2,
ajlong v
);
Type | Name | Read/Write | Description |
AjPLong2d* | thys | Output | Pointer to the ajlong array. |
ajuint | elem1 | Input | array element. |
ajuint | elem2 | Input | array element. |
ajlong | v | Input | value to load. |
AjBool | | RETURN | true if any array was extended. |
Input
elem1: | (Input) | array element. |
elem2: | (Input) | array element. |
v: | (Input) | value to load. |
Output
thys: | (Output) | Pointer to the ajlong array. |
Returns
AjBool: | true if any array was extended. |
Description
Load a ajlong 2d array element.
If the given array is a NULL pointer an error is generated.
If the array is of insufficient size then the array is extended.
Negative indices generate an error.
See Also
See other functions in this section
Availability
In release 6.4.0
Get lengths of 2d ajlong array
Synopsis
Prototype
void ajLong2dLen (
const AjPLong2d thys,
ajuint* len1,
ajuint* len2
);
Type | Name | Read/Write | Description |
const AjPLong2d | thys | Input | Pointer to the ajlong array. |
ajuint* | len1 | Output | Length of 1st dim |
ajuint* | len2 | Output | Length of 2nd dim |
void | | RETURN | |
Input
thys: | (Input) | Pointer to the ajlong array. |
Output
len1: | (Output) | Length of 1st dim |
len2: | (Output) | Length of 2nd dim |
Returns
Description
Get lengths of 2d ajlong array
See Also
See other functions in this section
Availability
In release 6.4.0
Convert AjPLong2d to ajlong
Synopsis
Prototype
ajlong** ajLong2dLong (
const AjPLong2d thys
);
Type | Name | Read/Write | Description |
const AjPLong2d | thys | Input | Pointer to the ajlong array. |
ajlong** | | RETURN | converted values. |
Input
thys: | (Input) | Pointer to the ajlong array. |
Returns
ajlong**: | converted values. |
Description
Convert AjPLong2d to ajlong
See Also
See other functions in this section
Availability
In release 6.4.0
Default constructor for empty AJAX 3D ajlong arrays.
Synopsis
Prototype
AjPLong3d ajLong3dNew (
void
);
Type | Name | Read/Write | Description |
AjPLong3d | | RETURN | Pointer to an empty ajlong array structure |
Returns
AjPLong3d: | Pointer to an empty ajlong array structure |
Description
Default constructor for empty AJAX 3D ajlong arrays.
See Also
See other functions in this section
Availability
In release 6.4.0
Constructor given an initial reserved size.
Synopsis
Prototype
AjPLong3d ajLong3dNewRes (
ajuint size
);
Type | Name | Read/Write | Description |
ajuint | size | Input | Reserved size 1st dim |
AjPLong3d | | RETURN | Pointer to an empty ajlong 3d array struct of
specified size. |
Input
size: | (Input) | Reserved size 1st dim |
Returns
AjPLong3d: | Pointer to an empty ajlong 3d array struct of
specified size. |
Description
Constructor given an initial reserved size.
See Also
See other functions in this section
Availability
In release 6.4.0
Default destructor for AJAX ajlong arrays.
If the given array is a NULL pointer, simply returns.
Synopsis
Prototype
void ajLong3dDel (
AjPLong3d* thys
);
Type | Name | Read/Write | Description |
AjPLong3d* | thys | Delete | Pointer to the ajlong array to be deleted.
The pointer is always deleted. |
void | | RETURN | |
Output
thys: | (Delete) | Pointer to the ajlong array to be deleted.
The pointer is always deleted. |
Returns
Description
Default destructor for AJAX ajlong arrays.
If the given array is a NULL pointer, simply returns.
See Also
See other functions in this section
Availability
In release 6.4.0
Retrieve an element from an AJAX 3d ajlong array.
If the given array is a NULL pointer, simply returns.
Synopsis
Prototype
ajlong ajLong3dGet (
const AjPLong3d thys,
ajuint elem1,
ajuint elem2,
ajuint elem3
);
Type | Name | Read/Write | Description |
const AjPLong3d | thys | Input | Pointer to the ajlong array. |
ajuint | elem1 | Input | array element. |
ajuint | elem2 | Input | array element. |
ajuint | elem3 | Input | array element. |
ajlong | | RETURN | contents of array element |
Input
thys: | (Input) | Pointer to the ajlong array. |
elem1: | (Input) | array element. |
elem2: | (Input) | array element. |
elem3: | (Input) | array element. |
Returns
ajlong: | contents of array element |
Description
Retrieve an element from an AJAX 3d ajlong array.
If the given array is a NULL pointer, simply returns.
See Also
See other functions in this section
Availability
In release 6.4.0
Load a ajlong 3d array element.
If the given array is a NULL pointer an error is generated.
If the array is of insufficient size then the array is extended.
Negative indices generate an error.
Synopsis
Prototype
AjBool ajLong3dPut (
AjPLong3d* thys,
ajuint elem1,
ajuint elem2,
ajuint elem3,
ajlong v
);
Type | Name | Read/Write | Description |
AjPLong3d* | thys | Output | Pointer to the ajlong array. |
ajuint | elem1 | Input | array element. |
ajuint | elem2 | Input | array element. |
ajuint | elem3 | Input | array element. |
ajlong | v | Input | value to load. |
AjBool | | RETURN | true if any array was extended. |
Input
elem1: | (Input) | array element. |
elem2: | (Input) | array element. |
elem3: | (Input) | array element. |
v: | (Input) | value to load. |
Output
thys: | (Output) | Pointer to the ajlong array. |
Returns
AjBool: | true if any array was extended. |
Description
Load a ajlong 3d array element.
If the given array is a NULL pointer an error is generated.
If the array is of insufficient size then the array is extended.
Negative indices generate an error.
See Also
See other functions in this section
Availability
In release 6.4.0
Get lengths of 3d ajlong array
Synopsis
Prototype
void ajLong3dLen (
const AjPLong3d thys,
ajuint* len1,
ajuint* len2,
ajuint* len3
);
Type | Name | Read/Write | Description |
const AjPLong3d | thys | Input | Pointer to the ajlong array. |
ajuint* | len1 | Output | Length of 1st dim |
ajuint* | len2 | Output | Length of 2nd dim |
ajuint* | len3 | Output | Length of 3rd dim |
void | | RETURN | |
Input
thys: | (Input) | Pointer to the ajlong array. |
Output
len1: | (Output) | Length of 1st dim |
len2: | (Output) | Length of 2nd dim |
len3: | (Output) | Length of 3rd dim |
Returns
Description
Get lengths of 3d ajlong array
See Also
See other functions in this section
Availability
In release 6.4.0
Convert AjPLong3d to ajlong
Synopsis
Prototype
ajlong*** ajLong3dLong (
const AjPLong3d thys
);
Type | Name | Read/Write | Description |
const AjPLong3d | thys | Input | Pointer to the ajlong array. |
ajlong*** | | RETURN | converted values. |
Input
thys: | (Input) | Pointer to the ajlong array. |
Returns
ajlong***: | converted values. |
Description
Convert AjPLong3d to ajlong
See Also
See other functions in this section
Availability
In release 6.4.0
Cleanup of array handling internals, and debug report of memory use
Synopsis
Prototype
void ajArrExit (
void
);
Type | Name | Read/Write | Description |
void | | RETURN | |
Returns
Description
Cleanup of array handling internals, and debug report of memory use
See Also
See other functions in this section
Availability
In release 6.4.0