ajarr.c


Function ajChararrNew

Default constructor for empty AJAX character arrays.

Synopsis

Prototype
AjPChar ajChararrNew (
      void
);

TypeNameRead/WriteDescription
AjPChar RETURNPointer 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

Function ajChararrNewRes

Constructor given an initial reserved size.

Synopsis

Prototype
AjPChar ajChararrNewRes (
      ajuint size
);

TypeNameRead/WriteDescription
ajuintsizeInputReserved size
AjPChar RETURNPointer 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

Function ajChararrDel

Default destructor for AJAX character arrays.

If the given array is a NULL pointer, simply returns.

Synopsis

Prototype
void ajChararrDel (
      AjPChar* thys
);

TypeNameRead/WriteDescription
AjPChar*thysDeletePointer 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
void:No return value

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

Function ajChararrGet

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
);

TypeNameRead/WriteDescription
const AjPCharthysInputPointer to the char array.
ajuintelemInputarray element.
char RETURNcontents 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

Function ajChararrPut

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
);

TypeNameRead/WriteDescription
AjPChar*thysOutputPointer to the char array.
ajuintelemInputarray element.
charvInputvalue to load.
AjBool RETURNtrue 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

Function ajChararrChararr

Returns the current char* pointer. This will remain valid until the array is resized or deleted.

Synopsis

Prototype
char* ajChararrChararr (
      const AjPChar thys
);

TypeNameRead/WriteDescription
const AjPCharthysInputSource array
char* RETURNCurrent array pointer, or a null string if undefined.

Input
thys:(Input)Source array
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

Function ajChararrLen

Get length of dynamic character array

Synopsis

Prototype
ajuint ajChararrLen (
      const AjPChar thys
);

TypeNameRead/WriteDescription
const AjPCharthysInputSource array
ajuint RETURNlength

Input
thys:(Input)Source array
Returns
ajuint:length

Description

Get length of dynamic character array

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajIntNew

Default constructor for empty AJAX integer arrays.

Synopsis

Prototype
AjPInt ajIntNew (
      void
);

TypeNameRead/WriteDescription
AjPInt RETURNPointer 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

Function ajIntNewRes

Constructor given an initial reserved size.

Synopsis

Prototype
AjPInt ajIntNewRes (
      ajuint size
);

TypeNameRead/WriteDescription
ajuintsizeInputReserved size
AjPInt RETURNPointer 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

Function ajIntDel

Default destructor for AJAX integer arrays.

If the given array is a NULL pointer, simply returns.

Synopsis

Prototype
void ajIntDel (
      AjPInt* thys
);

TypeNameRead/WriteDescription
AjPInt*thysDeletePointer 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
void:No return value

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

Function ajIntGet

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
);

TypeNameRead/WriteDescription
const AjPIntthysInputPointer to the ajint array.
ajuintelemInputarray element.
ajint RETURNcontents 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

Function ajIntPut

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
);

TypeNameRead/WriteDescription
AjPInt*thysOutputPointer to the ajint array.
ajuintelemInputarray element.
ajintvInputvalue to load.
AjBool RETURNtrue 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

Function ajIntInc

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
);

TypeNameRead/WriteDescription
AjPInt*thysOutputPointer to the ajint array.
ajuintelemInputarray element.
void RETURN

Input
elem:(Input)array element.
Output
thys:(Output)Pointer to the ajint array.
Returns
void:No return value

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

Function ajIntDec

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
);

TypeNameRead/WriteDescription
AjPInt*thysOutputPointer to the ajint array.
ajuintelemInputarray element.
void RETURN

Input
elem:(Input)array element.
Output
thys:(Output)Pointer to the ajint array.
Returns
void:No return value

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

Function ajUintNew

Default constructor for empty AJAX unsigned integer arrays.

Synopsis

Prototype
AjPUint ajUintNew (
      void
);

TypeNameRead/WriteDescription
AjPUint RETURNPointer 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

Function ajUintNewRes

Constructor given an initial reserved size.

Synopsis

Prototype
AjPUint ajUintNewRes (
      ajuint size
);

TypeNameRead/WriteDescription
ajuintsizeInputReserved size
AjPUint RETURNPointer 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

Function ajUintDel

Default destructor for AJAX integer integer arrays.

If the given array is a NULL pointer, simply returns.

Synopsis

Prototype
void ajUintDel (
      AjPUint* thys
);

TypeNameRead/WriteDescription
AjPUint*thysDeletePointer 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
void:No return value

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

Function ajUintGet

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
);

TypeNameRead/WriteDescription
const AjPUintthysInputPointer to the ajuint array.
ajuintelemInputarray element.
ajuint RETURNcontents 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

Function ajUintPut

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
);

TypeNameRead/WriteDescription
AjPUint*thysOutputPointer to the ajuint array.
ajuintelemInputarray element.
ajuintvInputvalue to load.
AjBool RETURNtrue 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

Function ajUintInc

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
);

TypeNameRead/WriteDescription
AjPUint*thysOutputPointer to the ajuint array.
ajuintelemInputarray element.
void RETURN

Input
elem:(Input)array element.
Output
thys:(Output)Pointer to the ajuint array.
Returns
void:No return value

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

Function ajUintDec

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
);

TypeNameRead/WriteDescription
AjPUint*thysOutputPointer to the ajuint array.
ajuintelemInputarray element.
void RETURN

Input
elem:(Input)array element.
Output
thys:(Output)Pointer to the ajuint array.
Returns
void:No return value

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

Function ajIntInt

Returns the current ajint* pointer. This will remain valid until the array is resized or deleted.

Synopsis

Prototype
ajint* ajIntInt (
      const AjPInt thys
);

TypeNameRead/WriteDescription
const AjPIntthysInputSource array
ajint* RETURNCurrent array pointer, or a null string if undefined.

Input
thys:(Input)Source array
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

Function ajIntLen

Get length of dynamic 1d ajint array

Synopsis

Prototype
ajuint ajIntLen (
      const AjPInt thys
);

TypeNameRead/WriteDescription
const AjPIntthysInputSource array
ajuint RETURNlength

Input
thys:(Input)Source array
Returns
ajuint:length

Description

Get length of dynamic 1d ajint array

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajUintUint

Returns the current ajuint* pointer. This will remain valid until the array is resized or deleted.

Synopsis

Prototype
ajuint* ajUintUint (
      const AjPUint thys
);

TypeNameRead/WriteDescription
const AjPUintthysInputSource array
ajuint* RETURNCurrent array pointer, or a null string if undefined.

Input
thys:(Input)Source array
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

Function ajUintLen

Get length of dynamic 1d ajuint array

Synopsis

Prototype
ajuint ajUintLen (
      const AjPUint thys
);

TypeNameRead/WriteDescription
const AjPUintthysInputSource array
ajuint RETURNlength

Input
thys:(Input)Source array
Returns
ajuint:length

Description

Get length of dynamic 1d ajuint array

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajFloatNew

Default constructor for empty AJAX float arrays.

Synopsis

Prototype
AjPFloat ajFloatNew (
      void
);

TypeNameRead/WriteDescription
AjPFloat RETURNPointer 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

Function ajFloatNewRes

Constructor given an initial reserved size.

Synopsis

Prototype
AjPFloat ajFloatNewRes (
      ajuint size
);

TypeNameRead/WriteDescription
ajuintsizeInputReserved size
AjPFloat RETURNPointer 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

Function ajFloatDel

Default destructor for AJAX float arrays.

If the given array is a NULL pointer, simply returns.

Synopsis

Prototype
void ajFloatDel (
      AjPFloat* thys
);

TypeNameRead/WriteDescription
AjPFloat*thysDeletePointer 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
void:No return value

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

Function ajFloatGet

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
);

TypeNameRead/WriteDescription
const AjPFloatthysInputPointer to the float array.
ajuintelemInputarray element.
float RETURNcontents 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

Function ajFloatPut

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
);

TypeNameRead/WriteDescription
AjPFloat*thysOutputPointer to the float array.
ajuintelemInputarray element.
floatvInputvalue to load.
AjBool RETURNtrue 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

Function ajFloatFloat

Returns the current float* pointer. This will remain valid until the array is resized or deleted.

Synopsis

Prototype
float* ajFloatFloat (
      const AjPFloat thys
);

TypeNameRead/WriteDescription
const AjPFloatthysInputSource array
float* RETURNCurrent array pointer, or a null string if undefined.

Input
thys:(Input)Source array
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

Function ajFloatLen

Get length of dynamic 1d float array

Synopsis

Prototype
ajuint ajFloatLen (
      const AjPFloat thys
);

TypeNameRead/WriteDescription
const AjPFloatthysInputSource array
ajuint RETURNlength

Input
thys:(Input)Source array
Returns
ajuint:length

Description

Get length of dynamic 1d float array

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajDoubleNew

Default constructor for empty AJAX double arrays.

Synopsis

Prototype
AjPDouble ajDoubleNew (
      void
);

TypeNameRead/WriteDescription
AjPDouble RETURNPointer 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

Function ajDoubleNewRes

Constructor given an initial reserved size.

Synopsis

Prototype
AjPDouble ajDoubleNewRes (
      ajuint size
);

TypeNameRead/WriteDescription
ajuintsizeInputReserved size
AjPDouble RETURNPointer 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

Function ajDoubleDel

Default destructor for AJAX double arrays.

If the given array is a NULL pointer, simply returns.

Synopsis

Prototype
void ajDoubleDel (
      AjPDouble* thys
);

TypeNameRead/WriteDescription
AjPDouble*thysDeletePointer 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
void:No return value

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

Function ajDoubleGet

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
);

TypeNameRead/WriteDescription
const AjPDoublethysInputPointer to the double array.
ajuintelemInputarray element.
double RETURNcontents 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

Function ajDoublePut

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
);

TypeNameRead/WriteDescription
AjPDouble*thysOutputPointer to the double array.
ajuintelemInputarray element.
doublevInputvalue to load.
AjBool RETURNtrue 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

Function ajDoubleDouble

Returns the current double* pointer. This will remain valid until the array is resized or deleted.

Synopsis

Prototype
double* ajDoubleDouble (
      const AjPDouble thys
);

TypeNameRead/WriteDescription
const AjPDoublethysInputSource array
double* RETURNCurrent array pointer, or a null string if undefined.

Input
thys:(Input)Source array
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

Function ajDoubleLen

Get length of dynamic 1d double array

Synopsis

Prototype
ajuint ajDoubleLen (
      const AjPDouble thys
);

TypeNameRead/WriteDescription
const AjPDoublethysInputSource array
ajuint RETURNlength

Input
thys:(Input)Source array
Returns
ajuint:length

Description

Get length of dynamic 1d double array

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajShortNew

Default constructor for empty AJAX short arrays.

Synopsis

Prototype
AjPShort ajShortNew (
      void
);

TypeNameRead/WriteDescription
AjPShort RETURNPointer 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

Function ajShortNewRes

Constructor given an initial reserved size.

Synopsis

Prototype
AjPShort ajShortNewRes (
      ajuint size
);

TypeNameRead/WriteDescription
ajuintsizeInputReserved size
AjPShort RETURNPointer 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

Function ajShortDel

Default destructor for AJAX short arrays.

If the given array is a NULL pointer, simply returns.

Synopsis

Prototype
void ajShortDel (
      AjPShort* thys
);

TypeNameRead/WriteDescription
AjPShort*thysDeletePointer 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
void:No return value

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

Function ajShortGet

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
);

TypeNameRead/WriteDescription
const AjPShortthysInputPointer to the short array.
ajuintelemInputarray element.
short RETURNcontents 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

Function ajShortPut

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
);

TypeNameRead/WriteDescription
AjPShort*thysOutputPointer to the short integer array.
ajuintelemInputarray element.
shortvInputvalue to load.
AjBool RETURNtrue 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

Function ajShortShort

Returns the current short* pointer. This will remain valid until the array is resized or deleted.

Synopsis

Prototype
short* ajShortShort (
      const AjPShort thys
);

TypeNameRead/WriteDescription
const AjPShortthysInputSource array
short* RETURNCurrent array pointer, or a null string if undefined.

Input
thys:(Input)Source array
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

Function ajShortLen

Get length of dynamic 1d short array

Synopsis

Prototype
ajuint ajShortLen (
      const AjPShort thys
);

TypeNameRead/WriteDescription
const AjPShortthysInputSource array
ajuint RETURNlength

Input
thys:(Input)Source array
Returns
ajuint:length

Description

Get length of dynamic 1d short array

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajLongNew

Default constructor for empty AJAX ajlong arrays.

Synopsis

Prototype
AjPLong ajLongNew (
      void
);

TypeNameRead/WriteDescription
AjPLong RETURNPointer 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

Function ajLongNewRes

Constructor given an initial reserved size.

Synopsis

Prototype
AjPLong ajLongNewRes (
      ajuint size
);

TypeNameRead/WriteDescription
ajuintsizeInputReserved size
AjPLong RETURNPointer 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

Function ajLongDel

Default destructor for AJAX ajlong arrays.

If the given array is a NULL pointer, simply returns.

Synopsis

Prototype
void ajLongDel (
      AjPLong* thys
);

TypeNameRead/WriteDescription
AjPLong*thysDeletePointer 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
void:No return value

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

Function ajLongGet

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
);

TypeNameRead/WriteDescription
const AjPLongthysInputPointer to the ajlong array.
ajuintelemInputarray element.
ajlong RETURNcontents 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

Function ajLongPut

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
);

TypeNameRead/WriteDescription
AjPLong*thysOutputPointer to the long integer array.
ajuintelemInputarray element.
ajlongvInputvalue to load.
AjBool RETURNtrue 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

Function ajLongLong

Returns the current ajlong* pointer. This will remain valid until the array is resized or deleted.

Synopsis

Prototype
ajlong* ajLongLong (
      const AjPLong thys
);

TypeNameRead/WriteDescription
const AjPLongthysInputSource array
ajlong* RETURNCurrent array pointer, or a null string if undefined.

Input
thys:(Input)Source array
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

Function ajLongLen

Get length of dynamic 1d ajlong array

Synopsis

Prototype
ajuint ajLongLen (
      const AjPLong thys
);

TypeNameRead/WriteDescription
const AjPLongthysInputSource array
ajuint RETURNlength

Input
thys:(Input)Source array
Returns
ajuint:length

Description

Get length of dynamic 1d ajlong array

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajFloatParse

Parses a string into a floating point array.

The array size is already set.

Synopsis

Prototype
AjBool ajFloatParse (
      const AjPStr str,
      AjPFloat* array
);

TypeNameRead/WriteDescription
const AjPStrstrInputInput string
AjPFloat*arrayOutputArray
AjBool RETURNajTrue on success.

Input
str:(Input)Input string
Output
array:(Output)Array
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

Function ajFloatStr

Writes a floating point array as a string

Synopsis

Prototype
void ajFloatStr (
      const AjPFloat array,
      ajint precision,
      AjPStr* str
);

TypeNameRead/WriteDescription
const AjPFloatarrayInputArray
ajintprecisionInputfloating point precision
AjPStr*strOutputOutput string
void RETURN

Input
array:(Input)Array
precision:(Input)floating point precision
Output
str:(Output)Output string
Returns
void:No return value

Description

Writes a floating point array as a string

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajFloatTrace

Writes a floating point array to the debug file

Synopsis

Prototype
void ajFloatTrace (
      const AjPFloat array,
      ajint precision,
      const char* text
);

TypeNameRead/WriteDescription
const AjPFloatarrayInputArray
ajintprecisionInputfloating point precision
const char*textInputReport title
void RETURN

Input
array:(Input)Array
precision:(Input)floating point precision
text:(Input)Report title
Returns
void:No return value

Description

Writes a floating point array to the debug file

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajArrCommaList

Creates an AjPStr array from a string of comma separated tokens

Synopsis

Prototype
ajuint ajArrCommaList (
      const AjPStr s,
      AjPStr** a
);

TypeNameRead/WriteDescription
const AjPStrsInputLine containing comma separated strings
AjPStr**aOutputarray pointer to create and load
ajuint RETURNnumber 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

Function ajArrDoubleLine

Creates a double array from a string of columns

Synopsis

Prototype
double* ajArrDoubleLine (
      const AjPStr line,
      const char* delim,
      ajuint startcol,
      ajuint endcol
);

TypeNameRead/WriteDescription
const AjPStrlineInputLine containing numbers
const char*delimInputDelimiter string for tokens
ajuintstartcolInputStart token (1 to n)
ajuintendcolInputEnd token (1 to n)
double* RETURNAllocated 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

Function ajArrIntLine

Creates an Int array from a string of columns

Synopsis

Prototype
ajint* ajArrIntLine (
      const AjPStr line,
      const char* delim,
      ajuint startcol,
      ajuint endcol
);

TypeNameRead/WriteDescription
const AjPStrlineInputLine containing numbers
const char*delimInputDelimiter string for tokens
ajuintstartcolInputStart token (1 to n)
ajuintendcolInputEnd token (1 to n)
ajint* RETURNAllocated 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

Function ajArrFloatLine

Creates a Float array from a string of columns

Synopsis

Prototype
float* ajArrFloatLine (
      const AjPStr line,
      const char* delim,
      ajuint startcol,
      ajuint endcol
);

TypeNameRead/WriteDescription
const AjPStrlineInputLine containing numbers
const char*delimInputDelimiter string for tokens
ajuintstartcolInputStart token (1 to n)
ajuintendcolInputEnd token (1 to n)
float* RETURNAllocated 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

Function ajInt2dNew

Default constructor for empty AJAX 2D integer arrays.

Synopsis

Prototype
AjPInt2d ajInt2dNew (
      void
);

TypeNameRead/WriteDescription
AjPInt2d RETURNPointer 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

Function ajInt2dNewRes

Constructor given an initial reserved size.

Synopsis

Prototype
AjPInt2d ajInt2dNewRes (
      ajuint size
);

TypeNameRead/WriteDescription
ajuintsizeInputReserved size 1st dim
AjPInt2d RETURNPointer 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

Function ajInt2dNewResRes2

Constructor given an initial reserved size in both dimensions

Synopsis

Prototype
AjPInt2d ajInt2dNewResRes2 (
      ajuint size,
      ajuint size2
);

TypeNameRead/WriteDescription
ajuintsizeInputReserved size 1st dim
ajuintsize2InputReserved size 2nd dim
AjPInt2d RETURNPointer 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

Function ajInt2dDel

Default destructor for AJAX integer arrays.

If the given array is a NULL pointer, simply returns.

Synopsis

Prototype
void ajInt2dDel (
      AjPInt2d* thys
);

TypeNameRead/WriteDescription
AjPInt2d*thysDeletePointer 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
void:No return value

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

Function ajInt2dGet

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
);

TypeNameRead/WriteDescription
const AjPInt2dthysInputPointer to the ajint array.
ajuintelem1Inputarray element.
ajuintelem2Inputarray element.
ajint RETURNcontents 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

Function ajInt2dPut

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
);

TypeNameRead/WriteDescription
AjPInt2d*thysOutputPointer to the ajint array.
ajuintelem1Inputarray element.
ajuintelem2Inputarray element.
ajintvInputvalue to load.
AjBool RETURNtrue 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

Function ajInt2dLen

Get lengths of 2d ajint array

Synopsis

Prototype
void ajInt2dLen (
      const AjPInt2d thys,
      ajuint* len1,
      ajuint* len2
);

TypeNameRead/WriteDescription
const AjPInt2dthysInputPointer to the ajint array.
ajuint*len1OutputLength of 1st dim
ajuint*len2OutputLength 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
void:No return value

Description

Get lengths of 2d ajint array

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajInt2dInt

Convert AjPInt2d to ajint

Synopsis

Prototype
ajint** ajInt2dInt (
      const AjPInt2d thys
);

TypeNameRead/WriteDescription
const AjPInt2dthysInputPointer to the ajint array.
ajint** RETURNconverted value.

Input
thys:(Input)Pointer to the ajint array.
Returns
ajint**:converted value.

Description

Convert AjPInt2d to ajint

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajInt3dNew

Default constructor for empty AJAX 3D integer arrays.

Synopsis

Prototype
AjPInt3d ajInt3dNew (
      void
);

TypeNameRead/WriteDescription
AjPInt3d RETURNPointer 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

Function ajInt3dNewRes

Constructor given an initial reserved size.

Synopsis

Prototype
AjPInt3d ajInt3dNewRes (
      ajuint size
);

TypeNameRead/WriteDescription
ajuintsizeInputReserved size 1st dim
AjPInt3d RETURNPointer 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

Function ajInt3dDel

Default destructor for AJAX integer arrays.

If the given array is a NULL pointer, simply returns.

Synopsis

Prototype
void ajInt3dDel (
      AjPInt3d* thys
);

TypeNameRead/WriteDescription
AjPInt3d*thysDeletePointer 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
void:No return value

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

Function ajInt3dGet

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
);

TypeNameRead/WriteDescription
const AjPInt3dthysInputPointer to the ajint array.
ajuintelem1Inputarray element.
ajuintelem2Inputarray element.
ajuintelem3Inputarray element.
ajint RETURNcontents 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

Function ajInt3dPut

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
);

TypeNameRead/WriteDescription
AjPInt3d*thysOutputPointer to the ajint array.
ajuintelem1Inputarray element.
ajuintelem2Inputarray element.
ajuintelem3Inputarray element.
ajintvInputvalue to load.
AjBool RETURNtrue 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

Function ajInt3dLen

Get lengths of 3d ajint array

Synopsis

Prototype
void ajInt3dLen (
      const AjPInt3d thys,
      ajuint* len1,
      ajuint* len2,
      ajuint* len3
);

TypeNameRead/WriteDescription
const AjPInt3dthysInputPointer to the ajint array.
ajuint*len1OutputLength of 1st dim
ajuint*len2OutputLength of 2nd dim
ajuint*len3OutputLength 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
void:No return value

Description

Get lengths of 3d ajint array

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajInt3dInt

Convert AjPInt3d to ajint

Synopsis

Prototype
ajint*** ajInt3dInt (
      const AjPInt3d thys
);

TypeNameRead/WriteDescription
const AjPInt3dthysInputPointer to the ajint array.
ajint*** RETURNconverted 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

Function ajUint2dNew

Default constructor for empty AJAX 2D integer arrays.

Synopsis

Prototype
AjPUint2d ajUint2dNew (
      void
);

TypeNameRead/WriteDescription
AjPUint2d RETURNPointer 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

Function ajUint2dNewRes

Constructor given an initial reserved size.

Synopsis

Prototype
AjPUint2d ajUint2dNewRes (
      ajuint size
);

TypeNameRead/WriteDescription
ajuintsizeInputReserved size 1st dim
AjPUint2d RETURNPointer 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

Function ajUint2dNewResRes2

Constructor given an initial reserved size in both dimensions

Synopsis

Prototype
AjPUint2d ajUint2dNewResRes2 (
      ajuint size,
      ajuint size2
);

TypeNameRead/WriteDescription
ajuintsizeInputReserved size 1st dim
ajuintsize2InputReserved size 2nd dim
AjPUint2d RETURNPointer 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

Function ajUint2dDel

Default destructor for AJAX unsigned integer arrays.

If the given array is a NULL pointer, simply returns.

Synopsis

Prototype
void ajUint2dDel (
      AjPUint2d* thys
);

TypeNameRead/WriteDescription
AjPUint2d*thysDeletePointer 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
void:No return value

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

Function ajUint2dGet

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
);

TypeNameRead/WriteDescription
const AjPUint2dthysInputPointer to the ajuint array.
ajuintelem1Inputarray element.
ajuintelem2Inputarray element.
ajuint RETURNcontents 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

Function ajUint2dPut

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
);

TypeNameRead/WriteDescription
AjPUint2d*thysOutputPointer to the ajuint array.
ajuintelem1Inputarray element.
ajuintelem2Inputarray element.
ajuintvInputvalue to load.
AjBool RETURNtrue 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

Function ajUint2dLen

Get lengths of 2d ajuint array

Synopsis

Prototype
void ajUint2dLen (
      const AjPUint2d thys,
      ajuint* len1,
      ajuint* len2
);

TypeNameRead/WriteDescription
const AjPUint2dthysInputPointer to the ajuint array.
ajuint*len1OutputLength of 1st dim
ajuint*len2OutputLength 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
void:No return value

Description

Get lengths of 2d ajuint array

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajUint2dUint

Convert AjPUint2d to ajuint

Synopsis

Prototype
ajuint** ajUint2dUint (
      const AjPUint2d thys
);

TypeNameRead/WriteDescription
const AjPUint2dthysInputPointer to the ajuint array.
ajuint** RETURNconverted 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

Function ajUint3dNew

Default constructor for empty AJAX 3D unsigned integer arrays.

Synopsis

Prototype
AjPUint3d ajUint3dNew (
      void
);

TypeNameRead/WriteDescription
AjPUint3d RETURNPointer 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

Function ajUint3dNewRes

Constructor given an initial reserved size.

Synopsis

Prototype
AjPUint3d ajUint3dNewRes (
      ajuint size
);

TypeNameRead/WriteDescription
ajuintsizeInputReserved size 1st dim
AjPUint3d RETURNPointer 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

Function ajUint3dDel

Default destructor for AJAX unsigned integer arrays.

If the given array is a NULL pointer, simply returns.

Synopsis

Prototype
void ajUint3dDel (
      AjPUint3d* thys
);

TypeNameRead/WriteDescription
AjPUint3d*thysDeletePointer 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
void:No return value

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

Function ajUint3dGet

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
);

TypeNameRead/WriteDescription
const AjPUint3dthysInputPointer to the ajuint array.
ajuintelem1Inputarray element.
ajuintelem2Inputarray element.
ajuintelem3Inputarray element.
ajuint RETURNcontents 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

Function ajUint3dPut

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
);

TypeNameRead/WriteDescription
AjPUint3d*thysOutputPointer to the ajint array.
ajuintelem1Inputarray element.
ajuintelem2Inputarray element.
ajuintelem3Inputarray element.
ajuintvInputvalue to load.
AjBool RETURNtrue 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

Function ajUint3dLen

Get lengths of 3d ajuint array

Synopsis

Prototype
void ajUint3dLen (
      const AjPUint3d thys,
      ajuint* len1,
      ajuint* len2,
      ajuint* len3
);

TypeNameRead/WriteDescription
const AjPUint3dthysInputPointer to the ajuint array.
ajuint*len1OutputLength of 1st dim
ajuint*len2OutputLength of 2nd dim
ajuint*len3OutputLength 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
void:No return value

Description

Get lengths of 3d ajuint array

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajUint3dUint

Convert AjPUint3d to ajuint

Synopsis

Prototype
ajuint*** ajUint3dUint (
      const AjPUint3d thys
);

TypeNameRead/WriteDescription
const AjPUint3dthysInputPointer to the ajuint array.
ajuint*** RETURNconverted 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

Function ajFloat2dNew

Default constructor for empty AJAX 2D float arrays.

Synopsis

Prototype
AjPFloat2d ajFloat2dNew (
      void
);

TypeNameRead/WriteDescription
AjPFloat2d RETURNPointer 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

Function ajFloat2dNewRes

Constructor given an initial reserved size.

Synopsis

Prototype
AjPFloat2d ajFloat2dNewRes (
      ajuint size
);

TypeNameRead/WriteDescription
ajuintsizeInputReserved size 1st dim
AjPFloat2d RETURNPointer 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

Function ajFloat2dDel

Default destructor for AJAX float arrays.

If the given array is a NULL pointer, simply returns.

Synopsis

Prototype
void ajFloat2dDel (
      AjPFloat2d* thys
);

TypeNameRead/WriteDescription
AjPFloat2d*thysDeletePointer 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
void:No return value

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

Function ajFloat2dGet

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
);

TypeNameRead/WriteDescription
const AjPFloat2dthysInputPointer to the float array.
ajuintelem1Inputarray element.
ajuintelem2Inputarray element.
float RETURNcontents 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

Function ajFloat2dPut

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
);

TypeNameRead/WriteDescription
AjPFloat2d*thysOutputPointer to the float array.
ajuintelem1Inputarray element.
ajuintelem2Inputarray element.
floatvInputvalue to load.
AjBool RETURNtrue 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

Function ajFloat2dLen

Get lengths of 2d float array

Synopsis

Prototype
void ajFloat2dLen (
      const AjPFloat2d thys,
      ajuint* len1,
      ajuint* len2
);

TypeNameRead/WriteDescription
const AjPFloat2dthysInputPointer to the float array.
ajuint*len1OutputLength of 1st dim
ajuint*len2OutputLength 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
void:No return value

Description

Get lengths of 2d float array

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajFloat2dFloat

Convert AjPFloat2d to float

Synopsis

Prototype
float** ajFloat2dFloat (
      const AjPFloat2d thys
);

TypeNameRead/WriteDescription
const AjPFloat2dthysInputPointer to the float array.
float** RETURNconverted 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

Function ajFloat3dNew

Default constructor for empty AJAX 3D float arrays.

Synopsis

Prototype
AjPFloat3d ajFloat3dNew (
      void
);

TypeNameRead/WriteDescription
AjPFloat3d RETURNPointer 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

Function ajFloat3dNewRes

Constructor given an initial reserved size.

Synopsis

Prototype
AjPFloat3d ajFloat3dNewRes (
      ajuint size
);

TypeNameRead/WriteDescription
ajuintsizeInputReserved size 1st dim
AjPFloat3d RETURNPointer 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

Function ajFloat3dDel

Default destructor for AJAX float arrays.

If the given array is a NULL pointer, simply returns.

Synopsis

Prototype
void ajFloat3dDel (
      AjPFloat3d* thys
);

TypeNameRead/WriteDescription
AjPFloat3d*thysDeletePointer 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
void:No return value

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

Function ajFloat3dGet

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
);

TypeNameRead/WriteDescription
const AjPFloat3dthysInputPointer to the float array.
ajuintelem1Inputarray element.
ajuintelem2Inputarray element.
ajuintelem3Inputarray element.
float RETURNcontents 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

Function ajFloat3dPut

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
);

TypeNameRead/WriteDescription
AjPFloat3d*thysOutputPointer to the float array.
ajuintelem1Inputarray element.
ajuintelem2Inputarray element.
ajuintelem3Inputarray element.
floatvInputvalue to load.
AjBool RETURNtrue 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

Function ajFloat3dLen

Get lengths of 3d float array

Synopsis

Prototype
void ajFloat3dLen (
      const AjPFloat3d thys,
      ajuint* len1,
      ajuint* len2,
      ajuint* len3
);

TypeNameRead/WriteDescription
const AjPFloat3dthysInputPointer to the float array.
ajuint*len1OutputLength of 1st dim
ajuint*len2OutputLength of 2nd dim
ajuint*len3OutputLength 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
void:No return value

Description

Get lengths of 3d float array

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajFloat3dFloat

Convert AjPFloat3d to float

Synopsis

Prototype
float*** ajFloat3dFloat (
      const AjPFloat3d thys
);

TypeNameRead/WriteDescription
const AjPFloat3dthysInputPointer to the float array.
float*** RETURNconverted 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

Function ajDouble2dNew

Default constructor for empty AJAX 2D double arrays.

Synopsis

Prototype
AjPDouble2d ajDouble2dNew (
      void
);

TypeNameRead/WriteDescription
AjPDouble2d RETURNPointer 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

Function ajDouble2dNewRes

Constructor given an initial reserved size.

Synopsis

Prototype
AjPDouble2d ajDouble2dNewRes (
      ajuint size
);

TypeNameRead/WriteDescription
ajuintsizeInputReserved size 1st dim
AjPDouble2d RETURNPointer 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

Function ajDouble2dDel

Default destructor for AJAX double arrays.

If the given array is a NULL pointer, simply returns.

Synopsis

Prototype
void ajDouble2dDel (
      AjPDouble2d* thys
);

TypeNameRead/WriteDescription
AjPDouble2d*thysDeletePointer 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
void:No return value

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

Function ajDouble2dGet

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
);

TypeNameRead/WriteDescription
const AjPDouble2dthysInputPointer to the double array.
ajuintelem1Inputarray element.
ajuintelem2Inputarray element.
double RETURNcontents 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

Function ajDouble2dPut

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
);

TypeNameRead/WriteDescription
AjPDouble2d*thysOutputPointer to the double array.
ajuintelem1Inputarray element.
ajuintelem2Inputarray element.
doublevInputvalue to load.
AjBool RETURNtrue 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

Function ajDouble2dLen

Get lengths of 2d double array

Synopsis

Prototype
void ajDouble2dLen (
      const AjPDouble2d thys,
      ajuint* len1,
      ajuint* len2
);

TypeNameRead/WriteDescription
const AjPDouble2dthysInputPointer to the double array.
ajuint*len1OutputLength of 1st dim
ajuint*len2OutputLength 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
void:No return value

Description

Get lengths of 2d double array

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajDouble2dDouble

Convert AjPDouble2d to double

Synopsis

Prototype
double** ajDouble2dDouble (
      const AjPDouble2d thys
);

TypeNameRead/WriteDescription
const AjPDouble2dthysInputPointer to the double array.
double** RETURNconverted 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

Function ajDouble3dNew

Default constructor for empty AJAX 3D double arrays.

Synopsis

Prototype
AjPDouble3d ajDouble3dNew (
      void
);

TypeNameRead/WriteDescription
AjPDouble3d RETURNPointer 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

Function ajDouble3dNewRes

Constructor given an initial reserved size.

Synopsis

Prototype
AjPDouble3d ajDouble3dNewRes (
      ajuint size
);

TypeNameRead/WriteDescription
ajuintsizeInputReserved size 1st dim
AjPDouble3d RETURNPointer 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

Function ajDouble3dDel

Default destructor for AJAX double arrays.

If the given array is a NULL pointer, simply returns.

Synopsis

Prototype
void ajDouble3dDel (
      AjPDouble3d* thys
);

TypeNameRead/WriteDescription
AjPDouble3d*thysDeletePointer 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
void:No return value

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

Function ajDouble3dGet

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
);

TypeNameRead/WriteDescription
const AjPDouble3dthysInputPointer to the double array.
ajuintelem1Inputarray element.
ajuintelem2Inputarray element.
ajuintelem3Inputarray element.
double RETURNcontents 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

Function ajDouble3dPut

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
);

TypeNameRead/WriteDescription
AjPDouble3d*thysOutputPointer to the double array.
ajuintelem1Inputarray element.
ajuintelem2Inputarray element.
ajuintelem3Inputarray element.
doublevInputvalue to load.
AjBool RETURNtrue 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

Function ajDouble3dLen

Get lengths of 3d double array

Synopsis

Prototype
void ajDouble3dLen (
      const AjPDouble3d thys,
      ajuint* len1,
      ajuint* len2,
      ajuint* len3
);

TypeNameRead/WriteDescription
const AjPDouble3dthysInputPointer to the double array.
ajuint*len1OutputLength of 1st dim
ajuint*len2OutputLength of 2nd dim
ajuint*len3OutputLength 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
void:No return value

Description

Get lengths of 3d double array

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajDouble3dDouble

Convert AjPDouble3d to double

Synopsis

Prototype
double*** ajDouble3dDouble (
      const AjPDouble3d thys
);

TypeNameRead/WriteDescription
const AjPDouble3dthysInputPointer to the double array.
double*** RETURNconverted 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

Function ajShort2dNew

Default constructor for empty AJAX 2D short arrays.

Synopsis

Prototype
AjPShort2d ajShort2dNew (
      void
);

TypeNameRead/WriteDescription
AjPShort2d RETURNPointer 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

Function ajShort2dNewRes

Constructor given an initial reserved size.

Synopsis

Prototype
AjPShort2d ajShort2dNewRes (
      ajuint size
);

TypeNameRead/WriteDescription
ajuintsizeInputReserved size 1st dim
AjPShort2d RETURNPointer 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

Function ajShort2dDel

Default destructor for AJAX short arrays.

If the given array is a NULL pointer, simply returns.

Synopsis

Prototype
void ajShort2dDel (
      AjPShort2d* thys
);

TypeNameRead/WriteDescription
AjPShort2d*thysDeletePointer 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
void:No return value

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

Function ajShort2dGet

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
);

TypeNameRead/WriteDescription
const AjPShort2dthysInputPointer to the short array.
ajuintelem1Inputarray element.
ajuintelem2Inputarray element.
short RETURNcontents 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

Function ajShort2dPut

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
);

TypeNameRead/WriteDescription
AjPShort2d*thysOutputPointer to the short array.
ajuintelem1Inputarray element.
ajuintelem2Inputarray element.
shortvInputvalue to load.
AjBool RETURNtrue 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

Function ajShort2dLen

Get lengths of 2d short array

Synopsis

Prototype
void ajShort2dLen (
      const AjPShort2d thys,
      ajuint* len1,
      ajuint* len2
);

TypeNameRead/WriteDescription
const AjPShort2dthysInputPointer to the short array.
ajuint*len1OutputLength of 1st dim
ajuint*len2OutputLength 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
void:No return value

Description

Get lengths of 2d short array

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajShort2dShort

Convert AjPShort2d to short

Synopsis

Prototype
short** ajShort2dShort (
      const AjPShort2d thys
);

TypeNameRead/WriteDescription
const AjPShort2dthysInputPointer to the short array.
short** RETURNconverted values

Input
thys:(Input)Pointer to the short array.
Returns
short**:converted values

Description

Convert AjPShort2d to short

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajShort3dNew

Default constructor for empty AJAX 3D short arrays.

Synopsis

Prototype
AjPShort3d ajShort3dNew (
      void
);

TypeNameRead/WriteDescription
AjPShort3d RETURNPointer 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

Function ajShort3dNewRes

Constructor given an initial reserved size.

Synopsis

Prototype
AjPShort3d ajShort3dNewRes (
      ajuint size
);

TypeNameRead/WriteDescription
ajuintsizeInputReserved size 1st dim
AjPShort3d RETURNPointer 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

Function ajShort3dDel

Default destructor for AJAX short arrays.

If the given array is a NULL pointer, simply returns.

Synopsis

Prototype
void ajShort3dDel (
      AjPShort3d* thys
);

TypeNameRead/WriteDescription
AjPShort3d*thysDeletePointer 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
void:No return value

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

Function ajShort3dGet

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
);

TypeNameRead/WriteDescription
const AjPShort3dthysInputPointer to the short array.
ajuintelem1Inputarray element.
ajuintelem2Inputarray element.
ajuintelem3Inputarray element.
short RETURNcontents 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

Function ajShort3dPut

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
);

TypeNameRead/WriteDescription
AjPShort3d*thysOutputPointer to the short array.
ajuintelem1Inputarray element.
ajuintelem2Inputarray element.
ajuintelem3Inputarray element.
shortvInputvalue to load.
AjBool RETURNtrue 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

Function ajShort3dLen

Get lengths of 3d short array

Synopsis

Prototype
void ajShort3dLen (
      const AjPShort3d thys,
      ajuint* len1,
      ajuint* len2,
      ajuint* len3
);

TypeNameRead/WriteDescription
const AjPShort3dthysInputPointer to the short array.
ajuint*len1OutputLength of 1st dim
ajuint*len2OutputLength of 2nd dim
ajuint*len3OutputLength 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
void:No return value

Description

Get lengths of 3d short array

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajShort3dShort

Convert AjPShort3d to short

Synopsis

Prototype
short*** ajShort3dShort (
      const AjPShort3d thys
);

TypeNameRead/WriteDescription
const AjPShort3dthysInputPointer to the short array.
short*** RETURNconverted 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

Function ajLong2dNew

Default constructor for empty AJAX 2D ajlong arrays.

Synopsis

Prototype
AjPLong2d ajLong2dNew (
      void
);

TypeNameRead/WriteDescription
AjPLong2d RETURNPointer 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

Function ajLong2dNewRes

Constructor given an initial reserved size.

Synopsis

Prototype
AjPLong2d ajLong2dNewRes (
      ajuint size
);

TypeNameRead/WriteDescription
ajuintsizeInputReserved size 1st dim
AjPLong2d RETURNPointer 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

Function ajLong2dDel

Default destructor for AJAX ajlong arrays.

If the given array is a NULL pointer, simply returns.

Synopsis

Prototype
void ajLong2dDel (
      AjPLong2d* thys
);

TypeNameRead/WriteDescription
AjPLong2d*thysDeletePointer 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
void:No return value

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

Function ajLong2dGet

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
);

TypeNameRead/WriteDescription
const AjPLong2dthysInputPointer to the ajlong array.
ajuintelem1Inputarray element.
ajuintelem2Inputarray element.
ajlong RETURNcontents 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

Function ajLong2dPut

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
);

TypeNameRead/WriteDescription
AjPLong2d*thysOutputPointer to the ajlong array.
ajuintelem1Inputarray element.
ajuintelem2Inputarray element.
ajlongvInputvalue to load.
AjBool RETURNtrue 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

Function ajLong2dLen

Get lengths of 2d ajlong array

Synopsis

Prototype
void ajLong2dLen (
      const AjPLong2d thys,
      ajuint* len1,
      ajuint* len2
);

TypeNameRead/WriteDescription
const AjPLong2dthysInputPointer to the ajlong array.
ajuint*len1OutputLength of 1st dim
ajuint*len2OutputLength 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
void:No return value

Description

Get lengths of 2d ajlong array

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajLong2dLong

Convert AjPLong2d to ajlong

Synopsis

Prototype
ajlong** ajLong2dLong (
      const AjPLong2d thys
);

TypeNameRead/WriteDescription
const AjPLong2dthysInputPointer to the ajlong array.
ajlong** RETURNconverted 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

Function ajLong3dNew

Default constructor for empty AJAX 3D ajlong arrays.

Synopsis

Prototype
AjPLong3d ajLong3dNew (
      void
);

TypeNameRead/WriteDescription
AjPLong3d RETURNPointer 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

Function ajLong3dNewRes

Constructor given an initial reserved size.

Synopsis

Prototype
AjPLong3d ajLong3dNewRes (
      ajuint size
);

TypeNameRead/WriteDescription
ajuintsizeInputReserved size 1st dim
AjPLong3d RETURNPointer 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

Function ajLong3dDel

Default destructor for AJAX ajlong arrays.

If the given array is a NULL pointer, simply returns.

Synopsis

Prototype
void ajLong3dDel (
      AjPLong3d* thys
);

TypeNameRead/WriteDescription
AjPLong3d*thysDeletePointer 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
void:No return value

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

Function ajLong3dGet

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
);

TypeNameRead/WriteDescription
const AjPLong3dthysInputPointer to the ajlong array.
ajuintelem1Inputarray element.
ajuintelem2Inputarray element.
ajuintelem3Inputarray element.
ajlong RETURNcontents 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

Function ajLong3dPut

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
);

TypeNameRead/WriteDescription
AjPLong3d*thysOutputPointer to the ajlong array.
ajuintelem1Inputarray element.
ajuintelem2Inputarray element.
ajuintelem3Inputarray element.
ajlongvInputvalue to load.
AjBool RETURNtrue 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

Function ajLong3dLen

Get lengths of 3d ajlong array

Synopsis

Prototype
void ajLong3dLen (
      const AjPLong3d thys,
      ajuint* len1,
      ajuint* len2,
      ajuint* len3
);

TypeNameRead/WriteDescription
const AjPLong3dthysInputPointer to the ajlong array.
ajuint*len1OutputLength of 1st dim
ajuint*len2OutputLength of 2nd dim
ajuint*len3OutputLength 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
void:No return value

Description

Get lengths of 3d ajlong array

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajLong3dLong

Convert AjPLong3d to ajlong

Synopsis

Prototype
ajlong*** ajLong3dLong (
      const AjPLong3d thys
);

TypeNameRead/WriteDescription
const AjPLong3dthysInputPointer to the ajlong array.
ajlong*** RETURNconverted 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

Function ajArrExit

Cleanup of array handling internals, and debug report of memory use

Synopsis

Prototype
void ajArrExit (
      void
);

TypeNameRead/WriteDescription
void RETURN

Returns
void:No return value

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