IndexPath Struct Reference

#include <IndexPath.h>

Overview

Index paths represent the path to an element or node within a tree or graph structure.

Definition at line 40 of file IndexPath.h.

Inheritance diagram for IndexPath:

Properties
size_t *	indexes
	The indexes. More...
size_t	length
	The length of 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 *	_IndexPath (void)
	The IndexPath archetype. More...
size_t	indexAtPosition (const IndexPath *self, size_t position)
IndexPath *	initWithIndex (IndexPath *self, size_t index)
	Initializes this IndexPath with the specified index. More...
IndexPath *	initWithIndexes (IndexPath *self, size_t *indexes, size_t length)
	Initializes this IndexPath with the specified indexes and length. 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
IndexPathInterface *	interface
	The interface. More...
Protected Attributes inherited from Object
ObjectInterface *	interface
	The interface. More...

Property Details

indexes

size_t* IndexPath::indexes

The indexes.

Definition at line 56 of file IndexPath.h.

interface

IndexPathInterface* IndexPath::interface

protected

The interface.

Definition at line 51 of file IndexPath.h.

length

size_t IndexPath::length

The length of indexes.

Definition at line 61 of file IndexPath.h.

object

Object IndexPath::object

The superclass.

Definition at line 45 of file IndexPath.h.

Method Details

_IndexPath()

Class * _IndexPath

(

void

)

The IndexPath archetype.

Returns

The IndexPath Class.

Definition at line 180 of file IndexPath.c.

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

indexAtPosition()

size_t indexAtPosition	(	const IndexPath *	self,
		size_t	position
	)

Parameters

self	The IndexPath.
position	The index position.

Returns

The index at the given position.

Definition at line 122 of file IndexPath.c.

                                                                      {
 
    assert(position < self->length);
 
    return self->indexes[position];
}

initWithIndex()

IndexPath * initWithIndex	(	IndexPath *	self,
		size_t	index
	)

Initializes this IndexPath with the specified index.

Parameters

self	The IndexPath.
index	The index.

Returns

The intialized IndexPath, or NULL on error.

Definition at line 133 of file IndexPath.c.

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

initWithIndexes()

IndexPath * initWithIndexes	(	IndexPath *	self,
		size_t *	indexes,
		size_t	length
	)

Initializes this IndexPath with the specified indexes and length.

Parameters

self	The IndexPath.
indexes	The indexes.
length	The length of indexes.

Returns

The intialized IndexPath, or NULL on error.

Definition at line 141 of file IndexPath.c.

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

---

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

• Sources/Objectively/IndexPath.h
• Sources/Objectively/IndexPath.c