Array Struct Reference

#include <Array.h>

Overview

Arrays.

Definition at line 56 of file Array.h.

Inheritance diagram for Array:

Properties
size_t	count
	The count of elements.
Object	object
	The superclass.
Properties inherited from Object
Class *	clazz
	Every instance of Object begins with a pointer to its Class.
unsigned int	magic
	A header to allow introspection of Object types.

Methods
Class *	_Array (void)
	The Array archetype.
void	addObject (Array *self, const ident obj)
	Adds the specified Object to this Array.
void	addObjects (Array *self, const ident obj,...)
	Adds the specified objects to this Array.
void	addObjectsFromArray (Array *self, const Array *array)
	Adds the Objects contained in array to this Array.
Array *	array (void)
	Returns a new Array.
Array *	arrayWithArray (const Array *array)
	Returns a new Array containing the contents of array.
Array *	arrayWithCapacity (size_t capacity)
	Returns a new Array with the given capacity.
Array *	arrayWithObjects (ident obj,...)
	Returns a new Array containing the given Objects.
Array *	arrayWithVaList (va_list args)
	Returns a new Array containing the Objects in the given va_list.
String *	componentsJoinedByCharacters (const Array *self, const char *chars)
	Returns the components of this Array joined by chars.
String *	componentsJoinedByString (const Array *self, const String *string)
	Returns the components of this Array joined by the specified String.
bool	containsObject (const Array *self, const ident obj)
void	enumerate (const Array *self, ArrayEnumerator enumerator, ident data)
	Enumerate the elements of this Array with the given function.
void	filter (Array *self, Predicate predicate, ident data)
	Filters this Array in place using predicate.
Array *	filteredArray (const Array *self, Predicate predicate, ident data)
	Creates a new Array with elements that pass predicate.
ident	find (const Array *self, Predicate predicate, ident data)
ident	firstObject (const Array *self)
ssize_t	indexOfObject (const Array *self, const ident obj)
Array *	init (Array *self)
	Initializes this Array.
Array *	initWithArray (Array *self, const Array *array)
	Initializes this Array to contain the Objects in array.
Array *	initWithCapacity (Array *self, size_t capacity)
	Initializes this Array with the specified capacity.
Array *	initWithObjects (Array *self,...)
	Initializes this Array to contain the Objects in the NULL-terminated arguments list.
Array *	initWithVaList (Array *self, va_list args)
	Initializes this Array to contain the Objects in the NULL-terminated va_list.
void	insertObjectAtIndex (Array *self, ident obj, size_t index)
	Inserts the Object at the specified index.
ident	lastObject (const Array *self)
void	map (Array *self, Functor functor, ident data)
	Transforms the elements in this Array in place using functor.
Array *	mappedArray (const Array *self, Functor functor, ident data)
	Transforms the elements in this Array by functor.
ident	objectAtIndex (const Array *self, size_t index)
ident	reduce (const Array *self, Reducer reducer, ident accumulator, ident data)
void	removeAllObjects (Array *self)
	Removes all Objects from this Array.
void	removeAllObjectsWithEnumerator (Array *self, ArrayEnumerator enumerator, ident data)
	Removes all Objects from this Array, invoking enumerator for each Object.
void	removeLastObject (Array *self)
	Removes the last Object from this Array.
void	removeObject (Array *self, const ident obj)
	Removes the specified Object from this Array.
void	removeObjectAtIndex (Array *self, size_t index)
	Removes the Object at the specified index.
void	setObjectAtIndex (Array *self, const ident obj, size_t index)
	Replaces the Object at the specified index.
void	sort (Array *self, Comparator comparator)
	Sorts this Array in place using comparator.
Array *	sortedArray (const Array *self, Comparator comparator)
Methods inherited from Object
Class *	_Object (void)
	The Object archetype.
Object *	copy (const Object *self)
	Creates a shallow copy of this Object.
void	dealloc (Object *self)
	Frees all resources held by this Object.
String *	description (const Object *self)
int	hash (const Object *self)
Object *	init (Object *self)
	Initializes this Object.
bool	isEqual (const Object *self, const Object *other)
	Tests equality of the other Object.
bool	isKindOfClass (const Object *self, const Class *clazz)
	Tests for Class hierarchy membership.

Protected Attributes
ArrayInterface *	interface
	The interface.
Protected Attributes inherited from Object
ObjectInterface *	interface
	The interface.

Property Details

count

size_t Array::count

The count of elements.

Definition at line 72 of file Array.h.

interface

ArrayInterface* Array::interface

protected

The interface.

Definition at line 67 of file Array.h.

object

Object Array::object

The superclass.

Definition at line 61 of file Array.h.

Method Details

_Array()

Class * _Array

(

void

)

The Array archetype.

Returns

The Array Class.

Definition at line 760 of file Array.c.

                    {
  static Class *clazz;
  static Once once;
 
  do_once(&once, {
    clazz = _initialize(&(const ClassDef) {
      .name = "Array",
      .superclass = _Object(),
      .instanceSize = sizeof(Array),
      .interfaceOffset = offsetof(Array, interface),
      .interfaceSize = sizeof(ArrayInterface),
      .initialize = initialize,
    });
  });
 
  return clazz;
}

addObject()

void addObject	(	Array *	self,
		const ident	obj
	)

Adds the specified Object to this Array.

Parameters

self	The Array.
obj	The Object to add.

Definition at line 181 of file Array.c.

                                                    {
 
  if (self->count == self->capacity) {
 
    self->capacity += ARRAY_CHUNK_SIZE;
 
    if (self->elements) {
      self->elements = realloc(self->elements, self->capacity * sizeof(ident));
    } else {
      self->elements = calloc(self->capacity, sizeof(ident));
    }
 
    assert(self->elements);
  }
 
  self->elements[self->count++] = retain(obj);
}

addObjects()

void addObjects	(	Array *	self,
		const ident	obj,
			...
	)

Adds the specified objects to this Array.

Parameters

self	The Array.
obj	The NULL-terminated list of objects.

Definition at line 203 of file Array.c.

                                                          {
 
  va_list args;
  va_start(args, obj);
 
  ident object = obj;
  while (object) {
    $(self, addObject, object);
    object = va_arg(args, ident);
  }
 
  va_end(args);
}

addObjectsFromArray()

void addObjectsFromArray	(	Array *	self,
		const Array *	array
	)

Adds the Objects contained in array to this Array.

Parameters

self	The Array.
array	An Array.

Definition at line 221 of file Array.c.

                                                                 {
 
  if (array) {
    for (size_t i = 0; i < array->count; i++) {
      $(self, addObject, array->elements[i]);
    }
  }
}

array()

Array * array

(

void

)

Returns a new Array.

Returns

The new Array, or NULL on error.

Definition at line 234 of file Array.c.

                          {
 
  return $(alloc(Array), init);
}

arrayWithArray()

Array * arrayWithArray

(

const Array *

array

)

Returns a new Array containing the contents of array.

Parameters

array

An Array.

Returns

The new Array, or NULL on error.

Definition at line 243 of file Array.c.

                                                 {
 
  return $(alloc(Array), initWithArray, array);
}

arrayWithCapacity()

Array * arrayWithCapacity

(

size_t

capacity

)

Returns a new Array with the given capacity.

Parameters

capacity

The desired initial capacity.

Returns

The new Array, or NULL on error.

Definition at line 252 of file Array.c.

                                                 {
 
  return $(alloc(Array), initWithCapacity, capacity);
}

arrayWithObjects()

Array * arrayWithObjects	(	ident	obj,
			...
	)

Returns a new Array containing the given Objects.

Parameters

obj	The first in a NULL-terminated list of Objects.

Returns

The new Array, or NULL on error.

Definition at line 261 of file Array.c.

                                               {
 
  Array *array = (Array *) super(Object, alloc(Array), init);
  if (array) {
    va_list args;
    va_start(args, obj);
 
    while (obj) {
      array->elements = realloc(array->elements, ++array->count * sizeof(ident));
      assert(array->elements);
 
      array->elements[array->count - 1] = retain(obj);
      obj = va_arg(args, ident);
    }
 
    va_end(args);
  }
 
  return array;
}

arrayWithVaList()

Array * arrayWithVaList

(

va_list

args

)

Returns a new Array containing the Objects in the given va_list.

Parameters

args	The NULL-terminated va_list of Objects.

Returns

The new Array, or NULL on error.

Definition at line 286 of file Array.c.

                                            {
 
  return $(alloc(Array), initWithVaList, args);
}

componentsJoinedByCharacters()

String * componentsJoinedByCharacters	(	const Array *	self,
		const char *	chars
	)

Returns the components of this Array joined by chars.

Parameters

self	The Array.
chars	The joining characters.

Returns

A String comprised of the components of this Array, joined by chars.

Definition at line 295 of file Array.c.

                                                                                  {
 
  String *string = $(alloc(String), init);
 
  for (size_t i = 0; i < self->count; i++) {
 
    String *desc = $((Object *) self->elements[i], description);
    $(string, appendString, desc);
 
    release(desc);
 
    if (i < self->count - 1) {
      $(string, appendCharacters, chars);
    }
  }
 
  return (String *) string;
}

componentsJoinedByString()

String * componentsJoinedByString	(	const Array *	self,
		const String *	string
	)

Returns the components of this Array joined by the specified String.

Parameters

self	The Array.
string	The joining String.

Returns

A String comprised of the components of this Array, joined by string.

Definition at line 318 of file Array.c.

                                                                                 {
  return $(self, componentsJoinedByCharacters, string->chars);
}

containsObject()

bool containsObject	(	const Array *	self,
		const ident	obj
	)

Parameters

self	The Array.
obj	An Object.

Returns

true if this Array contains the given Object, false otherwise.

Definition at line 326 of file Array.c.

                                                               {
  return $(self, indexOfObject, obj) != -1;
}

enumerate()

void enumerate	(	const Array *	self,
		ArrayEnumerator	enumerator,
		ident	data
	)

Enumerate the elements of this Array with the given function.

Parameters

self	The Array.
enumerator	The enumerator function.
data	User data.

Definition at line 334 of file Array.c.

                                                                                 {
 
  assert(enumerator);
 
  for (size_t i = 0; i < self->count; i++) {
    enumerator(self, self->elements[i], data);
  }
}

filter()

void filter	(	Array *	self,
		Predicate	predicate,
		ident	data
	)

Filters this Array in place using predicate.

Parameters

self	The Array.
predicate	A Predicate.
data	User data.

Definition at line 347 of file Array.c.

                                                                 {
 
  assert(predicate);
 
  for (size_t i = 0; i < self->count; i++) {
    if (predicate(self->elements[i], data) == false) {
      $(self, removeObjectAtIndex, i--);
    }
  }
}

filteredArray()

Array * filteredArray	(	const Array *	self,
		Predicate	predicate,
		ident	data
	)

Creates a new Array with elements that pass predicate.

Parameters

self	The Array.
predicate	The predicate function.
data	User data.

Returns

The new, filtered Array.

Definition at line 362 of file Array.c.

                                                                                {
 
  assert(predicate);
 
  Array *copy = (Array *) $((Object *) self, copy);
 
  $(copy, filter, predicate, data);
 
  return copy;
}

find()

ident find	(	const Array *	self,
		Predicate	predicate,
		ident	data
	)

Parameters

self	The Array.
predicate	The predicate function.
data	User data.

Returns

The first element of this Array to pass the predicate function.

Definition at line 377 of file Array.c.

                                                                      {
 
  assert(predicate);
 
  for (size_t i = 0; i < self->count; i++) {
    if (predicate(self->elements[i], data)) {
      return self->elements[i];
    }
  }
 
  return NULL;
}

firstObject()

ident firstObject

(

const Array *

self

)

Parameters

self	The Array.

Returns

The first Object in this Array, or NULL if empty.

Definition at line 394 of file Array.c.

                                            {
 
  return self->count ? $(self, objectAtIndex, 0) : NULL;
}

indexOfObject()

ssize_t indexOfObject	(	const Array *	self,
		const ident	obj
	)

Parameters

self	The Array.
obj	An Object.

Returns

The index of the given Object, or -1 if not found.

Definition at line 403 of file Array.c.

                                                                 {
 
  assert(obj);
 
  for (size_t i = 0; i < self->count; i++) {
    if ($((Object * ) self->elements[i], isEqual, obj)) {
      return i;
    }
  }
 
  return -1;
}

init()

Array * init

(

Array *

self

)

Initializes this Array.

Parameters

self	The Array.

Returns

The initialized Array, or NULL on error.

Definition at line 420 of file Array.c.

                                {
 
  return $(self, initWithCapacity, 0);
}

initWithArray()

Array * initWithArray	(	Array *	self,
		const Array *	array
	)

Initializes this Array to contain the Objects in array.

Parameters

self	The Array.
array	An Array.

Returns

The initialized Array, or NULL on error.

Definition at line 429 of file Array.c.

                                                             {
 
  self = (Array *) super(Object, self, init);
  if (self) {
 
    self->count = array->count;
    if (self->count) {
 
      self->elements = calloc(self->count, sizeof(ident));
      assert(self->elements);
 
      for (size_t i = 0; i < self->count; i++) {
        self->elements[i] = retain(array->elements[i]);
      }
    }
  }
 
  return self;
}

initWithCapacity()

Array * initWithCapacity	(	Array *	self,
		size_t	capacity
	)

Initializes this Array with the specified capacity.

Parameters

self	The Array.
capacity	The desired initial capacity.

Returns

The initialized Array, or NULL on error.

Definition at line 453 of file Array.c.

                                                             {
 
  self = (Array *) super(Object, self, init);
  if (self) {
 
    self->capacity = capacity;
    if (self->capacity) {
 
      self->elements = calloc(self->capacity, sizeof(ident));
      assert(self->elements);
    }
  }
 
  return self;
}

initWithObjects()

Array * initWithObjects	(	Array *	self,
			...
	)

Initializes this Array to contain the Objects in the NULL-terminated arguments list.

Parameters

self	The Array.

Returns

The initialized Array, or NULL on error.

Definition at line 473 of file Array.c.

                                                {
 
  va_list args;
  va_start(args, self);
 
  self = $(self, initWithVaList, args);
 
  va_end(args);
  return self;
}

initWithVaList()

Array * initWithVaList	(	Array *	self,
		va_list	args
	)

Initializes this Array to contain the Objects in the NULL-terminated va_list.

Parameters

self	The Array.
args	The NULL-terminated va_list of Objects.

Returns

The initialized Array, or NULL on error.

Definition at line 488 of file Array.c.

                                                        {
 
  self = (Array *) super(Object, self, init);
  if (self) {
 
    ident element = va_arg(args, ident);
    while (element) {
      self->elements = realloc(self->elements, ++self->count * sizeof(ident));
      assert(self->elements);
 
      self->elements[self->count - 1] = retain(element);
      element = va_arg(args, ident);
    }
  }
 
  return self;
}

insertObjectAtIndex()

void insertObjectAtIndex	(	Array *	self,
		ident	obj,
		size_t	index
	)

Inserts the Object at the specified index.

Parameters

self	The Array.
obj	The Object to insert.
index	The index at which to insert.

Definition at line 510 of file Array.c.

                                                                      {
 
  assert(index <= self->count);
 
  $(self, addObject, obj);
 
  for (size_t i = self->count - 1; i > index; i--) {
    self->elements[i] = self->elements[i - 1];
  }
 
  self->elements[index] = obj;
}

lastObject()

ident lastObject

(

const Array *

self

)

Parameters

self	The Array.

Returns

The last Object in this Array, or NULL if empty.

Definition at line 527 of file Array.c.

                                           {
 
  return self->count ? $(self, objectAtIndex, self->count - 1) : NULL;
}

map()

void map	(	Array *	self,
		Functor	functor,
		ident	data
	)

Transforms the elements in this Array in place using functor.

Parameters

self	The Array.
functor	The Functor.
data	User data.

Definition at line 536 of file Array.c.

                                                          {
 
  assert(functor);
 
  for (size_t i = 0; i < self->count; i++) {
    ident obj = functor(self->elements[i], data);
 
    retain(obj);
 
    release(self->elements[i]);
 
    self->elements[i] = obj;
  }
}

mappedArray()

Array * mappedArray	(	const Array *	self,
		Functor	functor,
		ident	data
	)

Transforms the elements in this Array by functor.

Parameters

self	The Array.
functor	The Functor.
data	User data.

Returns

An Array containing the transformed elements of this Array.

Definition at line 555 of file Array.c.

                                                                          {
 
  assert(functor);
 
  Array *array = $(alloc(Array), initWithCapacity, self->count);
  assert(array);
  
  for (size_t i = 0; i < self->count; i++) {
 
    ident obj = functor(self->elements[i], data);
 
    $(array, addObject, obj);
 
    release(obj);
  }
 
  return array;
}

objectAtIndex()

ident objectAtIndex	(	const Array *	self,
		size_t	index
	)

Parameters

self	The Array.
index	The index of the desired Object.

Returns

The Object at the specified index.

Definition at line 578 of file Array.c.

                                                            {
 
  assert(index < self->count);
 
  return self->elements[index];
}

reduce()

ident reduce	(	const Array *	self,
		Reducer	reducer,
		ident	accumulator,
		ident	data
	)

Parameters

self	The Array.
reducer	The Reducer.
accumulator	The initial accumulator value.
data	User data.

Returns

The reduction result.

Definition at line 589 of file Array.c.

                                                                                       {
 
  assert(reducer);
 
  for (size_t i = 0; i < self->count; i++) {
    accumulator = reducer(self->elements[i], accumulator, data);
  }
 
  return accumulator;
}

removeAllObjects()

void removeAllObjects

(

Array *

self

)

Removes all Objects from this Array.

Parameters

self	The Array.

Definition at line 604 of file Array.c.

                                          {
 
  while (self->count) {
    $(self, removeLastObject);
  }
}

removeAllObjectsWithEnumerator()

void removeAllObjectsWithEnumerator	(	Array *	self,
		ArrayEnumerator	enumerator,
		ident	data
	)

Removes all Objects from this Array, invoking enumerator for each Object.

Parameters

self	The Array.
enumerator	The enumerator.
data	The data.

Definition at line 615 of file Array.c.

                                                                                                {
 
  assert(enumerator);
 
  while (self->count) {
 
    enumerator(self, $(self, lastObject), data);
 
    $(self, removeLastObject);
  }
}

removeLastObject()

void removeLastObject

(

Array *

self

)

Removes the last Object from this Array.

Parameters

self

The Array

Definition at line 631 of file Array.c.

                                          {
 
  if (self->count) {
    $(self, removeObjectAtIndex, self->count - 1);
  }
}

removeObject()

void removeObject	(	Array *	self,
		const ident	obj
	)

Removes the specified Object from this Array.

Parameters

self	The Array.
obj	The Object to remove.

Definition at line 642 of file Array.c.

                                                       {
 
  const ssize_t index = $(self, indexOfObject, obj);
  if (index > -1) {
    $(self, removeObjectAtIndex, index);
  }
}

removeObjectAtIndex()

void removeObjectAtIndex	(	Array *	self,
		size_t	index
	)

Removes the Object at the specified index.

Parameters

self	The Array.
index	The index of the Object to remove.

Definition at line 654 of file Array.c.

                                                           {
 
  assert(index < self->count);
 
  release(self->elements[index]);
 
  for (size_t i = index; i < self->count - 1; i++) {
    self->elements[i] = self->elements[i + 1];
  }
 
  self->count--;
}

setObjectAtIndex()

void setObjectAtIndex	(	Array *	self,
		const ident	obj,
		size_t	index
	)

Replaces the Object at the specified index.

Parameters

self	The Array.
obj	The Object with which to replace.
index	The index of the Object to replace.

Remarks

The index must not exceed the size of the Array.

Definition at line 671 of file Array.c.

                                                                         {
 
  assert(index < self->count);
 
  retain(obj);
 
  release(self->elements[index]);
 
  self->elements[index] = obj;
}

sort()

void sort	(	Array *	self,
		Comparator	comparator
	)

Sorts this Array in place using comparator.

Parameters

self	The Array.
comparator	The Comparator.

Definition at line 686 of file Array.c.

                                                     {
  quicksort(self->elements, self->count, sizeof(ident), comparator, NULL);
}

sortedArray()

Array * sortedArray	(	const Array *	self,
		Comparator	comparator
	)

Parameters

self	The Array.
comparator	The Comparator

Returns

A copy of this Array, sorted by the given Comparator.

Definition at line 694 of file Array.c.

                                                                    {
 
  assert(comparator);
 
  Array *array = (Array *) $((Object *) self, copy);
 
  $(array, sort, comparator);
 
  return array;
}

---

The documentation for this struct was generated from the following files:

• Sources/Objectively/Array.h
• Sources/Objectively/Array.c