Description

Represents a 2D array.

kArray2 represents 2D array of objects or values. The kArray2 constructor accepts arguments that determine the array item type (kType) and array dimension lengths.

For arrays that contain objects (e.g. kImage) as opposed to values (e.g. k32s), the objects are not automatically destroyed when the array is destroyed. To recursively destroy both the array and the array items, use kObject_Dispose.

Inheritance diagram for kArray2:

Public Member Functions
kStatus	kArray2_Allocate (kArray2 array, kType itemType, kSize length0, kSize length1)
	Reallocates the internal array item buffer. More...

kStatus	kArray2_Assign (kArray2 array, kArray2 source)
	Performs a shallow copy of the source array. More...

void *	kArray2_At (kArray2 array, kSize index0, kSize index1)
	Returns a pointer to the specified item in the array. More...

kStatus	kArray2_Attach (kArray2 array, void *items, kType itemType, kSize length0, kSize length1)
	Attaches the array to an external item buffer. More...

kStatus	kArray2_Construct (kArray2 *array, kType itemType, kSize length0, kSize length1, kAlloc allocator)
	Constructs a kArray2 object. More...

kSize	kArray2_Count (kArray2 array)
	Returns the array item count, in elements. More...

void *	kArray2_Data (kArray2 array)
	Returns a pointer to the array item buffer. More...

kSize	kArray2_DataSize (kArray2 array)
	Reports the size, in bytes, of the array item buffer. More...

kStatus	kArray2_Item (kArray2 array, kSize index0, kSize index1, void *item)
	Gets the value of an item. More...

kSize	kArray2_ItemSize (kArray2 array)
	Returns the array item size. More...

kType	kArray2_ItemType (kArray2 array)
	Returns the array item type. More...

kSize	kArray2_Length (kArray2 array, kSize dimension)
	Returns the length of the specified array dimension, in elements. More...

kStatus	kArray2_SetItem (kArray2 array, kSize index0, kSize index1, const void *item)
	Sets the value of an item. More...

kStatus	kArray2_Zero (kArray2 array)
	Sets all array element bits to zero. More...

kSize	kCollection_Count (kCollection collection)
	Gets the collection element count. More...

kIterator	kCollection_GetIterator (kCollection collection)
	Returns an iterator to the first element in the collection. More...

kBool	kCollection_HasNext (kCollection collection, kIterator iterator)
	Determines whether a collection has another item. More...

kType	kCollection_ItemType (kCollection collection)
	Gets the collection element type. More...

void *	kCollection_Next (kCollection collection, kIterator *iterator)
	Gets the next collection element and then advances the iterator. More...

kAlloc	kObject_Alloc (kObject object)
	Gets the memory allocator associated with this object. More...

kStatus	kObject_Clone (kObject *object, kObject source, kAlloc allocator)
	Constructs a new object by copying an existing object, including any aggregated child elements. More...

kStatus	kObject_Destroy (kObject object)
	Destroys the object. More...

kStatus	kObject_Dispose (kObject object)
	Destroys the object and any aggregated child elements. More...

kBool	kObject_Equals (kObject object, kObject other)
	Determines whether the object is equal to another object. More...

kSize	kObject_HashCode (kObject object)
	Gets a hash code representing the state of this object. More...

kBool	kObject_Is (kObject object, kType type)
	Determines whether this object is an instance of the specified type. More...

kBool	kObject_IsShared (kObject object)
	Reports whether the object is currently shared (reference count greater than one). More...

kStatus	kObject_SetPool (kObject object, kObjectPool pool)
	Sets the object pool associated with this object. More...

kStatus	kObject_Share (kObject object)
	Increments the reference count associated with this object. More...

kSize	kObject_Size (kObject object)
	Estimates the memory consumed by this object, including any aggregated child elements. More...

kType	kObject_Type (kObject object)
	Returns the type of the object. More...

Member Function Documentation

kStatus kArray2_Allocate	(	kArray2	array,
		kType	itemType,
		kSize	length0,
		kSize	length1
	)

Reallocates the internal array item buffer.

Parameters

array	Array object.
itemType	Type of array element.
length0	Length of first array dimension (outermost).
length1	Length of second array dimension (innermost).

Returns: Operation status.

kStatus kArray2_Assign	(	kArray2	array,
		kArray2	source
	)

Performs a shallow copy of the source array.

Source items are copied by value; if the source array contains objects, the object handles are copied but the objects are not cloned.

Parameters

array	Array object.
source	Source array to be copied.

Returns: Operation status.

void * kArray2_At	(	kArray2	array,
		kSize	index0,
		kSize	index1
	)

Returns a pointer to the specified item in the array.

Parameters

array	Array object.
index0	First dimension index.
index1	Second dimension index.

Returns: Pointer to item.

kStatus kArray2_Attach	(	kArray2	array,
		void *	items,
		kType	itemType,
		kSize	length0,
		kSize	length1
	)

Attaches the array to an external item buffer.

Attached item buffers are not freed when the array is destroyed.

Parameters

array	Array object.
items	External item buffer.
itemType	Type of array element.
length0	Length of first array dimension (outermost).
length1	Length of second array dimension (innermost).

Returns: Operation status.

kStatus kArray2_Construct	(	kArray2 *	array,
		kType	itemType,
		kSize	length0,
		kSize	length1,
		kAlloc	allocator
	)

Constructs a kArray2 object.

Parameters

array	Receives the constructed object.
itemType	Type of array element.
length0	Length of first array dimension (outermost).
length1	Length of second array dimension (innermost).
allocator	Memory allocator (or kNULL for default).

Returns: Operation status.

kSize kArray2_Count ( kArray2 array )

Returns the array item count, in elements.

Parameters

array Array object.

Returns: Array item count (in elements).

void * kArray2_Data ( kArray2 array )

Returns a pointer to the array item buffer.

Parameters

array Array object.

Returns: Pointer to array item buffer.

kSize kArray2_DataSize ( kArray2 array )

Reports the size, in bytes, of the array item buffer.

Parameters

array Array object.

Returns: Size of array item buffer (bytes).

kStatus kArray2_Item	(	kArray2	array,
		kSize	index0,
		kSize	index1,
		void *	item
	)

Gets the value of an item.

Parameters

array	Array object.
index0	First dimension index.
index1	Second dimension index.
item	Destination for item that will be copied (by value) from the array.

Returns: Operation status.

kSize kArray2_ItemSize ( kArray2 array )

Returns the array item size.

Parameters

array Array object.

Returns: Array item size.

kType kArray2_ItemType ( kArray2 array )

Returns the array item type.

Parameters

array Array object.

Returns: Array item type.

kSize kArray2_Length	(	kArray2	array,
		kSize	dimension
	)

Returns the length of the specified array dimension, in elements.

Parameters

array	Array object.
dimension	Array dimension object.

Returns: Array dimension length (in elements).

kStatus kArray2_SetItem	(	kArray2	array,
		kSize	index0,
		kSize	index1,
		const void *	item
	)

Sets the value of an item.

Parameters

array	Array object.
index0	First dimension index.
index1	Second dimension index.
item	Pointer to item that will be copied (by value) into the array.

Returns: Operation status.

kStatus kArray2_Zero ( kArray2 array )

Sets all array element bits to zero.

Parameters

array Array object.

Returns: Operation status.

kSize kCollection_Count ( kCollection collection )

inherited

Gets the collection element count.

Parameters

collection Collection object.

Returns: Item count.

kIterator kCollection_GetIterator ( kCollection collection )

inherited

Returns an iterator to the first element in the collection.

Parameters

collection Collection object.

Returns: Iterator.

kBool kCollection_HasNext	(	kCollection	collection,
		kIterator	iterator
	)

inherited

Determines whether a collection has another item.

Parameters

collection	Collection object.
iterator	Collection iterator.

Returns: kTRUE if the collection has a next element.

kType kCollection_ItemType ( kCollection collection )

inherited

Gets the collection element type.

Parameters

collection Collection object.

Returns: Item type.

void * kCollection_Next	(	kCollection	collection,
		kIterator *	iterator
	)

inherited

Gets the next collection element and then advances the iterator.

Parameters

collection	Collection object.
iterator	Pointer to collection iterator.

Returns: Pointer to next collection element.

kAlloc kObject_Alloc ( kObject object )

inherited

Gets the memory allocator associated with this object.

Most objects are constructed with an allocator, which is used to allocate the memory required by the object. Objects retain a reference to this allocator to enable further allocations and to free memory when the object is destroyed.

Parameters

object Object.

Returns: Memory allocator.

See also: kAlloc, kObject_Alloc_

kStatus kObject_Clone	(	kObject *	object,
		kObject	source,
		kAlloc	allocator
	)

inherited

Constructs a new object by copying an existing object, including any aggregated child elements.

If the source object is an object collection (e.g. kArrayList<kString>), any aggregated child objects are also cloned. In this case, the kObject_Dispose method can be used to free the cloned collection and its associated elements.

This method will fail if the source object (or an aggregated child element) does not support cloning.

Parameters

object	Receives the constructed object.
source	Source object.
allocator	Memory allocator (or kNULL for default).

Returns: Operation status.

See also: kObject_Dispose

kStatus kObject_Destroy ( kObject object )

inherited

Destroys the object.

The kObject_Destroy method destroys the object itself and any resources that are owned by the object. See Object Destruction for more information.

When an object is destroyed (or disposed), its reference count is decremented. The object is only truly destroyed when the reference count reaches zero. See Reference Counting for more information.

Parameters

object Object (or kNULL).

Returns: Operation status.

See also: Object Destruction, Reference Counting

kStatus kObject_Dispose ( kObject object )

inherited

Destroys the object and any aggregated child elements.

The kObject_Dispose method destroys the object itself, any resources that are owned by the object, and if the object represents a collection of objects, any child objects in the collection. See Object Destruction for more information.

When an object is destroyed (or disposed), its reference count is decremented. The object is only truly destroyed when the reference count reaches zero. See Reference Counting for more information.

Parameters

object Object (or kNULL).

Returns: Operation status.

See also: Object Destruction, Reference Counting

kBool kObject_Equals	(	kObject	object,
		kObject	other
	)

inherited

Determines whether the object is equal to another object.

By default, objects are compared by reference; objects are considered equal if the given handles refer to the same object instance. However, some classes override the Equals method to provide a more meaningful comparison (e.g. kString).

Parameters

object	Object.
other	Object for comparison.

Returns: kTRUE if the objects are equal.

kSize kObject_HashCode ( kObject object )

inherited

Gets a hash code representing the state of this object.

By default, objects return a hash code based on the object handle value. However, some classes override the HashCode method to provide a more useful hash (e.g. kString).

Parameters

object Object.

Returns: Hash code.

kBool kObject_Is	(	kObject	object,
		kType	type
	)

inherited

Determines whether this object is an instance of the specified type.

This function compares the type of this object with the given type. An object is considered to be an instance of a given type if a) the type represents a class and this object inherits from (or instantiates) that class, or b) the type represents an interface and this object implements the interface.

Parameters

object	Object.
type	Type.

Returns: kTRUE if the object is of the specified type; otherwise kFALSE.

See also: kObject_Is_, kType_Is

kBool kObject_IsShared ( kObject object )

inherited

Reports whether the object is currently shared (reference count greater than one).

Objects are initialized with a reference count of one. The kObject_Share method can be used to increment the reference count. The kObject_Destroy and kObject_Dispose methods decrease the reference count, and when the reference count reaches zero, the object is actually destroyed/disposed.

This method can be used to determine if the reference count of an object is currently greater than one.

This method is thread-safe.

Parameters

object Object.

Returns: kTRUE if the object is shared; kFALSE otherwise.

See also: Reference Counting, kObject_Share

kStatus kObject_SetPool	(	kObject	object,
		kObjectPool	pool
	)

inherited

Sets the object pool associated with this object.

Object pools can be used to implement custom lifecycle management. If an object has an assigned pool, then the kObjectPool_Reclaim method will be called just prior to destruction, to provide an opportunity for the object to be reclaimed.

Parameters

object	Object.
pool	Pool object (or kNULL to clear the pool assignment).

Returns: Operation status.

kStatus kObject_Share ( kObject object )

inherited

Increments the reference count associated with this object.

This method is thread-safe.

Parameters

object Object.

Returns: Operation status.

See also: reference-counting

kSize kObject_Size ( kObject object )

inherited

Estimates the memory consumed by this object, including any aggregated child elements.

This method can be optionally overridden by kObject-derived classes to report the amount of memory consumed by an object. The default implementation reports only the size of the class instance (additional allocations performed by the class are excluded).

Parameters

object Object.

Returns: Object size, in bytes.

kType kObject_Type ( kObject object )

inherited

Returns the type of the object.

Each object is an instance of a specific class type. The type handle returned by this function can be used to learn about the class.

Parameters

object Object.

Returns: Type.

See also: kType, kObject_Type_

The documentation for this class was generated from the following file:

Data/kArray2.h

Description

Public Member Functions

Member Function Documentation