MutableSet Struct Reference

#include <MutableSet.h>

Overview

Mutable sets.

Definition at line 40 of file MutableSet.h.

Inheritance diagram for MutableSet:

Properties
Set	set
	The superclass. More...
Properties inherited from Set
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 *	_MutableSet (void)
	The MutableSet archetype. More...
void	addObject (MutableSet *self, const ident obj)
	Adds the specified Object to this Set. More...
void	addObjectsFromArray (MutableSet *self, const Array *array)
	Adds the Objects contained in array to this Set. More...
void	addObjectsFromSet (MutableSet *self, const Set *set)
	Adds the Objects contained in set to this Set. More...
void	filter (MutableSet *self, Predicate predicate, ident data)
	Filters this MutableSet in place using predicate. More...
MutableSet *	init (MutableSet *self)
	Initializes this MutableSet. More...
MutableSet *	initWithCapacity (MutableSet *self, size_t capacity)
MutableSet *	initWithCapacity (MutableSet *self, size_t capacity)
	Initializes this Set with the specified capacity. More...
void	removeAllObjects (MutableSet *self)
	Removes all Objects from this Set. More...
void	removeObject (MutableSet *self, const ident obj)
	Removes the specified Object from this Set. More...
MutableSet *	set (void)
	Returns a new MutableSet. More...
MutableSet *	setWithCapacity (size_t capacity)
	Returns a new MutableSet with the given capacity. More...
Methods inherited from Set
Class *	_Set (void)
	The Set archetype. More...
Array *	allObjects (const Set *self)
_Bool	containsObject (const Set *self, const ident obj)
_Bool	containsObjectMatching (const Set *self, Predicate predicate, ident data)
void	enumerateObjects (const Set *self, SetEnumerator enumerator, ident data)
	Enumerate the elements of this Set with the given function. More...
Set *	filteredSet (const Set *self, Predicate predicate, ident data)
	Creates a new Set with elements that pass predicate. More...
Set *	initWithArray (Set *self, const Array *array)
	Initializes this Set to contain the Objects in array. More...
Set *	initWithObjects (Set *self,...)
	Initializes this Set with the specified objects. More...
Set *	initWithSet (Set *self, const Set *set)
	Initializes this Set to contain the Objects in set. More...
Set *	mappedSet (const Set *self, Functor functor, ident data)
	Transforms the elements in this Set by functor. More...
MutableSet *	mutableCopy (const Set *self)
ident	reduce (const Set *self, Reducer reducer, ident accumulator, ident data)
Set *	setWithArray (const Array *array)
	Returns a new Set with the contents of array. More...
Set *	setWithObjects (ident obj,...)
	Returns a new Set containing the specified Objects. More...
Set *	setWithSet (const Set *set)
	Returns a new Set with the contents of set. More...
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
MutableSetInterface *	interface
	The interface. More...
Protected Attributes inherited from Set
SetInterface *	interface
	The interface. More...
Protected Attributes inherited from Object
ObjectInterface *	interface
	The interface. More...

Property Details

interface

MutableSetInterface* MutableSet::interface

protected

The interface.

Definition at line 51 of file MutableSet.h.

set

MutableSet * set

(

void

)

The superclass.

Definition at line 45 of file MutableSet.h.

Method Details

_MutableSet()

Class * _MutableSet

(

void

)

The MutableSet archetype.

Returns

The MutableSet Class.

Definition at line 298 of file MutableSet.c.

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

addObject()

void addObject	(	MutableSet *	self,
		const ident	obj
	)

Adds the specified Object to this Set.

Parameters

self	The MutableSet.
obj	An Object.

Definition at line 96 of file MutableSet.c.

                                                         {
 
    Set *set = (Set *) self;
 
    addObject_resize(set);
 
    const size_t bin = HashForObject(HASH_SEED, obj) % set->capacity;
 
    MutableArray *array = set->elements[bin];
    if (array == NULL) {
        array = set->elements[bin] = $(alloc(MutableArray), init);
    }
 
    if ($((Array *) array, containsObject, obj) == false) {
        $(array, addObject, obj);
        set->count++;
    }
}

addObjectsFromArray()

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

Adds the Objects contained in array to this Set.

Parameters

self	The MutableSet.
array	An Array.

Definition at line 126 of file MutableSet.c.

                                                                      {
 
    if (array) {
        $(array, enumerateObjects, addObjectsFromArray_enumerator, self);
    }
}

addObjectsFromSet()

void addObjectsFromSet	(	MutableSet *	self,
		const Set *	set
	)

Adds the Objects contained in set to this Set.

Parameters

self	The MutableSet.
set	A Set.

Definition at line 144 of file MutableSet.c.

                                                                {
 
    if (set) {
        $(set, enumerateObjects, addObjectsFromSet_enumerator, self);
    }
}

filter()

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

Filters this MutableSet in place using predicate.

Parameters

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

Definition at line 155 of file MutableSet.c.

                                                                      {
 
    assert(predicate);
 
    self->set.count = 0;
 
    for (size_t i = 0; i < self->set.capacity; i++) {
 
        MutableArray *array = self->set.elements[i];
        if (array) {
 
            $(array, filter, predicate, data);
 
            if (array->array.count == 0) {
                release(array);
                self->set.elements[i] = NULL;
            } else {
                self->set.count += array->array.count;
            }
        }
    }
}

init()

MutableSet * init

(

MutableSet *

self

)

Initializes this MutableSet.

Parameters

self	The MutableSet.

Returns

The initialized MutableSet, or NULL on error.

Definition at line 182 of file MutableSet.c.

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

initWithCapacity() [1/2]

MutableSet * initWithCapacity	(	MutableSet *	self,
		size_t	capacity
	)

Definition at line 191 of file MutableSet.c.

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

initWithCapacity() [2/2]

MutableSet * initWithCapacity	(	MutableSet *	self,
		size_t	capacity
	)

Initializes this Set with the specified capacity.

Parameters

self	The MutableSet.
capacity	The desired initial capacity.

Returns

The initialized Set, or NULL on error.

Definition at line 191 of file MutableSet.c.

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

removeAllObjects()

void removeAllObjects

(

MutableSet *

self

)

Removes all Objects from this Set.

Parameters

self	The MutableSet.

Definition at line 211 of file MutableSet.c.

                                               {
 
    for (size_t i = 0; i < self->set.capacity; i++) {
 
        Array *array = self->set.elements[i];
        if (array) {
            release(array);
            self->set.elements[i] = NULL;
        }
    }
 
    self->set.count = 0;
}

removeObject()

void removeObject	(	MutableSet *	self,
		const ident	obj
	)

Removes the specified Object from this Set.

Parameters

self	The MutableSet.
obj	The Object to remove.

Definition at line 229 of file MutableSet.c.

                                                            {
 
    if (self->set.capacity == 0) {
        return;
    }
 
    const size_t bin = HashForObject(HASH_SEED, obj) % self->set.capacity;
 
    MutableArray *array = self->set.elements[bin];
    if (array) {
 
        const ssize_t index = $((Array *) array, indexOfObject, obj);
        if (index > -1) {
 
            $(array, removeObjectAtIndex, index);
 
            if (((Array *) array)->count == 0) {
                release(array);
                self->set.elements[bin] = NULL;
            }
 
            self->set.count--;
        }
    }
}

set()

MutableSet * set

(

void

)

Returns a new MutableSet.

Returns

The new MutableSet, or NULL on error.

Definition at line 259 of file MutableSet.c.

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

setWithCapacity()

MutableSet * setWithCapacity

(

size_t

capacity

)

Returns a new MutableSet with the given capacity.

Parameters

capacity

The desired initial capacity.

Returns

The new MutableSet, or NULL on error.

Definition at line 268 of file MutableSet.c.

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

---

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

• Sources/Objectively/MutableSet.h
• Sources/Objectively/MutableIndexSet.c
• Sources/Objectively/MutableSet.c