IndexSet Struct Reference

#include <IndexSet.h>

Overview

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.
size_t *	indexes
	The indexes.
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 *	_IndexSet (void)
	The IndexSet archetype.
void	addIndex (IndexSet *self, size_t index)
	Adds the specified index to this IndexSet.
void	addIndexes (IndexSet *self, size_t *indexes, size_t count)
	Adds the specified indexes to this IndexSet.
void	addIndexesInRange (IndexSet *self, const Range range)
	Adds indexes in the specified Range to this IndexSet.
bool	containsIndex (const IndexSet *self, size_t index)
IndexSet *	init (IndexSet *self)
	Initializes this IndexSet.
IndexSet *	initWithCapacity (IndexSet *self, size_t capacity)
	Initializes this IndexSet with the specified capacity.
IndexSet *	initWithIndex (IndexSet *self, size_t index)
	Initializes this IndexSet with the specified index.
IndexSet *	initWithIndexes (IndexSet *self, size_t *indexes, size_t count)
	Initializes this IndexSet with the specified indexes and count.
void	removeAllIndexes (IndexSet *self)
	Removes all indexes from this IndexSet.
void	removeIndex (IndexSet *self, size_t index)
	Removes the specified index from this IndexSet.
void	removeIndexes (IndexSet *self, size_t *indexes, size_t count)
	Removes the specified indexes from this IndexSet.
void	removeIndexesInRange (IndexSet *self, const Range range)
	Removes indexes in the specified Range from this IndexSet.
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
IndexSetInterface *	interface
	The interface.
Protected Attributes inherited from Object
ObjectInterface *	interface
	The interface.

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

addIndex()

void addIndex	(	IndexSet *	self,
		size_t	index
	)

Adds the specified index to this IndexSet.

Parameters

self	The IndexSet.
index	The index to add.

Definition at line 205 of file IndexSet.c.

                                                   {
 
  IndexSet *this = self;
 
  size_t i;
  for (i = 0; i < this->count; i++) {
    if (this->indexes[i] == index) {
      return;
    }
    if (this->indexes[i] > index) {
      break;
    }
  }
 
  if (this->count == self->capacity) {
    self->capacity += INDEX_SET_CHUNK_SIZE;
 
    this->indexes = realloc(this->indexes, self->capacity * sizeof(size_t));
    assert(this->indexes);
  }
 
  for (size_t j = this->count; j > i; j--) {
    this->indexes[j] = this->indexes[j - 1];
  }
 
  this->indexes[i] = index;
  this->count++;
}

addIndexes()

void addIndexes	(	IndexSet *	self,
		size_t *	indexes,
		size_t	count
	)

Adds the specified indexes to this IndexSet.

Parameters

self	The IndexSet.
indexes	The indexes to add.
count	The count of indexes.

Definition at line 238 of file IndexSet.c.

                                                                      {
 
  for (size_t i = 0; i < count; i++) {
    $(self, addIndex, indexes[i]);
  }
}

addIndexesInRange()

void addIndexesInRange	(	IndexSet *	self,
		const Range	range
	)

Adds indexes in the specified Range to this IndexSet.

Parameters

self	The IndexSet.
range	The Range of indexes to add.

Definition at line 252 of file IndexSet.c.

                                                                 {
 
  for (size_t i = range.location; i < range.location + range.length; i++) {
    $(self, addIndex, i);
  }
}

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 157 of file IndexSet.c.

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

init()

IndexSet * init

(

IndexSet *

self

)

Initializes this IndexSet.

Parameters

self	The IndexSet.

Returns

The initialized IndexSet, or NULL on error.

Definition at line 263 of file IndexSet.c.

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

initWithCapacity()

IndexSet * initWithCapacity	(	IndexSet *	self,
		size_t	capacity
	)

Initializes this IndexSet with the specified capacity.

Parameters

self	The IndexSet.
capacity	The capacity.

Returns

The initialized IndexSet, or NULL on error.

Definition at line 271 of file IndexSet.c.

                                                                   {
 
  self = (IndexSet *) super(Object, self, init);
  if (self) {
    self->capacity = capacity;
 
    self->indexes = malloc(self->capacity * sizeof(size_t));
    assert(self->indexes);
  }
 
  return self;
}

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 172 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 180 of file IndexSet.c.

                                                                                {
 
  self = (IndexSet *) super(Object, self, init);
  if (self) {
 
    self->count = compact(indexes, count);
    self->capacity = self->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;
}

removeAllIndexes()

void removeAllIndexes

(

IndexSet *

self

)

Removes all indexes from this IndexSet.

Parameters

self	The IndexSet.

Definition at line 288 of file IndexSet.c.

                                             {
 
  IndexSet *this = self;
 
  free(this->indexes);
  this->indexes = NULL;
 
  this->count = 0;
  self->capacity = 0;
}

removeIndex()

void removeIndex	(	IndexSet *	self,
		size_t	index
	)

Removes the specified index from this IndexSet.

Parameters

self	The IndexSet.
index	The index to remove.

Definition at line 303 of file IndexSet.c.

                                                      {
 
  IndexSet *this = self;
  for (size_t i = 0; i < this->count; i++) {
    if (this->indexes[i] == index) {
      this->count--;
      for (size_t j = i; j < this->count; j++) {
        this->indexes[j] = this->indexes[j + 1];
      }
      return;
    }
  }
}

removeIndexes()

void removeIndexes	(	IndexSet *	self,
		size_t *	indexes,
		size_t	count
	)

Removes the specified indexes from this IndexSet.

Parameters

self	The IndexSet.
indexes	The indexes to remove.
count	The count of indexes.

Definition at line 321 of file IndexSet.c.

                                                                         {
 
  for (size_t i = 0; i < count; i++) {
    $(self, removeIndex, indexes[i]);
  }
}

removeIndexesInRange()

void removeIndexesInRange	(	IndexSet *	self,
		const Range	range
	)

Removes indexes in the specified Range from this IndexSet.

Parameters

self	The IndexSet.
range	The Range of indexes to remove.

Definition at line 332 of file IndexSet.c.

                                                                    {
 
  for (size_t i = range.location; i < range.location + range.length; i++) {
    $(self, removeIndex, i);
  }
}

---

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

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