Array Struct Reference

#include <Array.h>

Overview

Immutable arrays.

Definition at line 56 of file Array.h.

Inheritance diagram for Array:

Properties
size_t	count
	The count of elements. More...
Object	object
	The superclass. More...
Properties inherited from Object
Class *	clazz
	Every instance of Object begins with a pointer to its Class. More...

Methods
Class *	_Array (void)
	The Array archetype. More...
Array *	arrayWithArray (const Array *array)
	Returns a new Array containing the contents of array. More...
Array *	arrayWithObjects (ident obj,...)
	Returns a new Array containing the given Objects. More...
Array *	arrayWithVaList (va_list args)
	Returns a new Array containing the Objects in the given va_list. More...
String *	componentsJoinedByCharacters (const Array *self, const char *chars)
	Returns the components of this Array joined by chars. More...
String *	componentsJoinedByString (const Array *self, const String *string)
	Returns the components of this Array joined by the specified String. More...
_Bool	containsObject (const Array *self, const ident obj)
void	enumerateObjects (const Array *self, ArrayEnumerator enumerator, ident data)
	Enumerate the elements of this Array with the given function. More...
Array *	filteredArray (const Array *self, Predicate predicate, ident data)
	Creates a new Array with elements that pass predicate. More...
ident	findObject (const Array *self, Predicate predicate, ident data)
ident	firstObject (const Array *self)
ssize_t	indexOfObject (const Array *self, const ident obj)
Array *	initWithArray (Array *self, const Array *array)
	Initializes this Array to contain the Objects in array. More...
Array *	initWithObjects (Array *self,...)
	Initializes this Array to contain the Objects in the NULL-terminated arguments list. More...
Array *	initWithVaList (Array *self, va_list args)
	Initializes this Array to contain the Objects in the NULL-terminated va_list. More...
ident	lastObject (const Array *self)
Array *	mappedArray (const Array *self, Functor functor, ident data)
	Transforms the elements in this Array by functor. More...
MutableArray *	mutableCopy (const Array *self)
ident	objectAtIndex (const Array *self, int index)
ident	reduce (const Array *self, Reducer reducer, ident accumulator, ident data)
Array *	sortedArray (const Array *self, Comparator comparator)
Methods inherited from Object
Class *	_Object (void)
	The Object archetype. More...
Object *	copy (const Object *self)
	Creates a shallow copy of this Object. More...
void	dealloc (Object *self)
	Frees all resources held by this Object. More...
String *	description (const Object *self)
int	hash (const Object *self)
Object *	init (Object *self)
	Initializes this Object. More...
_Bool	isEqual (const Object *self, const Object *other)
	Tests equality of the other Object. More...
_Bool	isKindOfClass (const Object *self, const Class *clazz)
	Tests for Class hierarchy membership. More...

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

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 470 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;
}

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 133 of file Array.c.

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

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 142 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 167 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 176 of file Array.c.

                                                                                  {
 
    MutableString *string = $(alloc(MutableString), 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 200 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 208 of file Array.c.

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

enumerateObjects()

void enumerateObjects	(	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 217 of file Array.c.

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

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 230 of file Array.c.

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

findObject()

ident findObject	(	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 245 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 262 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 271 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;
}

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 288 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;
}

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 312 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 327 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;
}

lastObject()

ident lastObject

(

const Array *

self

)

Parameters

self	The Array.

Returns

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

Definition at line 349 of file Array.c.

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

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 358 of file Array.c.

                                                                          {
 
    assert(functor);
 
    MutableArray *array = $$(MutableArray, arrayWithCapacity, 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 *) array;
}

mutableCopy()

MutableArray * mutableCopy

(

const Array *

self

)

Parameters

self	The Array.

Returns

A MutableArray with the contents of this Array.

Definition at line 381 of file Array.c.

                                                    {
 
    MutableArray *copy = $(alloc(MutableArray), initWithCapacity, self->count);
    assert(copy);
 
    $(copy, addObjectsFromArray, self);
    return copy;
}

objectAtIndex()

ident objectAtIndex	(	const Array *	self,
		int	index
	)

Parameters

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

Returns

The Object at the specified 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 405 of file Array.c.

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

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 420 of file Array.c.

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

---

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

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