<Float32MatrixArray> Data Interface

Provides script language access to C++ objects of this type.

Class HierarchyNo registered superclass.

Function Members

Function members are as follows:

Return Type Function Name Documentation
<Float32MatrixArray>Float32MatrixArrayThe <Float32MatrixArray> constructor.
int32AddAdds a matrix to the end of the array.
int32BindIteratorsBinds iterators to this object.
int32BindPointerBinds a <MemoryPointer> or subclass to this object. The <MemoryPointer> becomes a pointer to this object that can be passed to compatible functions.
int32ClearClears the array and frees the underlying memory.
int32CombineGiven an array of matrix objects called ArrayA ( this array ) and an array of <Matrix> objects called ArrayB ( not this array ), combines ArrayB with ArrayA at the specified index in ArrayA.
int32ConvertBytesToCountSets the array count to a value guaranteed to be large enough to store an array of N matrices. Will round up to the nearest positive <int32> if the byte count provided does not align with the number of bytes per element.
int32CopyCopies the value of the source onto the destination.
int32DelRemoves an item from the array at the specified index.
int32ElementSizeReturns the size in bytes of each element of the array.
int32FillSets every row and column index of every object in the array to this value.
int32FindFinds an object in the array.
<Float32Iterator>FirstReturns an iterator positioned at the start of the collection.
<Float32Matrix>GetReturns a pointer to the object at the specified index.
int32GetCountReturns the count of the underlying array object.
<Float32Matrix>GetFirstReturns a pointer to the first object in the array or returns nullptr if the array is empty.
<Float32Matrix>GetLastReturns a pointer to the last object in the array or returns nullptr if the array is empty.
<Float32Pointer>GetPointerReturns a pointer to this object. The pointer object is allocated with new so you must use auto in the declaration or you must manually delete the pointer object. For example: auto Float32Pointer ptr = object.GetPointer().
<Float32ArrayView>GetViewReturns a <Float32ArrayView> that contains first and last iterators for the collection.
int32InsertInserts a value into the array. May incur re-allocation costs depending on the size of any allocated reserve.
<Float32Iterator>LastReturns an iterator positioned at the end of the collection.
int32MergeAdds an object to the end of the array if the value is not already in the array.
int32MoveRelocates a chunk of the array to a new index.
int32PopPops the first item off the top of the stack.
int32Print1DPrints the array in 1D into a <StrList> object.
int32Print2DPrints the array in 2D into a <StrList> object.
int32PushPushes an item onto the stack ( at the end ).
int32RelocateRelocates a chunk of the array to a new index.
<Float32Matrix>RemoveRemoves an object from the array, but does not destroy it. Returns a pointer to the object that was removed from the array.
int32SetSets the value of the element at the specified index.
int32ShrinkShrinks the array to a sub-range.
int32SizeInBytesReturns the size in bytes of the array, which is the total number of bytes currently being used by the array, and does not include any allocated reserve.

Object Members

Object members are as follows:

Type Name Accessor Name Documentation
Float32Matrix[]Objects[ index ]Gets or sets the value of an element in the array at the specified index. The syntax is array.Objects[ n ], where n is a valid index into the array.
<Float32MatrixArray>ValueReturns the value of this object's underlying array. For example: to assign the value of this object to another array.
int32CountGets or sets the number of objects in the array. Setting the count to zero frees all the memory owned by the array, but does not destroy the array object.
int32ReserveGets or sets the reserve allocation. Note: this does not change the array count, it merely changes the size of the underlying buffer.