IndexSet Struct Reference

#include <IndexSet.h>

Overview

Immutable collections of unique index values.

Definition at line 41 of file IndexSet.h.

Inheritance diagram for IndexSet:

Properties
size_t	count
	The count of indexes. More...
size_t *	indexes
	The indexes. 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 *	_IndexSet (void)
	The IndexSet archetype. More...
_Bool	containsIndex (const IndexSet *self, size_t index)
IndexSet *	initWithIndex (IndexSet *self, size_t index)
	Initializes this IndexSet with the specified index. More...
IndexSet *	initWithIndexes (IndexSet *self, size_t *indexes, size_t count)
	Initializes this IndexSet with the specified indexes and count. 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
IndexSetInterface *	interface
	The interface. More...
Protected Attributes inherited from Object
ObjectInterface *	interface
	The interface. More...

Property Details

count

size_t IndexSet::count

The count of indexes.

Definition at line 62 of file IndexSet.h.

indexes

size_t* IndexSet::indexes

The indexes.

Definition at line 57 of file IndexSet.h.

interface

IndexSetInterface* IndexSet::interface

protected

The interface.

Definition at line 52 of file IndexSet.h.

object

Object IndexSet::object

The superclass.

Definition at line 46 of file IndexSet.h.

Method Details

_IndexSet()

Class * _IndexSet

(

void

)

The IndexSet archetype.

Returns

The IndexSet Class.

Definition at line 218 of file IndexSet.c.

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

containsIndex()

_Bool containsIndex	(	const IndexSet *	self,
		size_t	index
	)

Parameters

self	The IndexSet.
index	The index.

Returns

True if this IndexSet contains index, false otherwise.

Definition at line 155 of file IndexSet.c.

                                                               {
 
    for (size_t i = 0; i < self->count; i++) {
        if (self->indexes[i] == index) {
            return true;
        }
    }
 
    return false;
}

initWithIndex()

IndexSet * initWithIndex	(	IndexSet *	self,
		size_t	index
	)

Initializes this IndexSet with the specified index.

Parameters

self	The IndexSet.
index	The index.

Returns

The intialized IndexSet, or NULL on error.

Definition at line 170 of file IndexSet.c.

                                                             {
    return $(self, initWithIndexes, &index, 1);
}

initWithIndexes()

IndexSet * initWithIndexes	(	IndexSet *	self,
		size_t *	indexes,
		size_t	count
	)

Initializes this IndexSet with the specified indexes and count.

Parameters

self	The IndexSet.
indexes	The indexes.
count	The count of indexes.

Returns

The intialized IndexSet, or NULL on error.

Definition at line 178 of file IndexSet.c.

                                                                                {
 
    self = (IndexSet *) super(Object, self, init);
    if (self) {
 
        self->count = compact(indexes, count);
        if (self->count) {
 
            self->indexes = calloc(sizeof(size_t), self->count);
            assert(self->indexes);
 
            memcpy(self->indexes, indexes, sizeof(size_t) * self->count);
        }
    }
 
    return self;
}

---

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

• Sources/Objectively/IndexSet.h
• Sources/Objectively/IndexSet.c