Vector.h

Go to the documentation of this file.

/*
 * Objectively: Ultra-lightweight object oriented framework for GNU C.
 * Copyright (C) 2014 Jay Dolan <jay@jaydolan.com>
 *
 * This software is provided 'as-is', without any express or implied
 * warranty. In no event will the authors be held liable for any damages
 * arising from the use of this software.
 *
 * Permission is granted to anyone to use this software for any purpose,
 * including commercial applications, and to alter it and redistribute it
 * freely, subject to the following restrictions:
 *
 * 1. The origin of this software must not be misrepresented; you must not
 * claim that you wrote the original software. If you use this software
 * in a product, an acknowledgment in the product documentation would be
 * appreciated but is not required.
 *
 * 2. Altered source versions must be plainly marked as such, and must not be
 * misrepresented as being the original software.
 *
 * 3. This notice may not be removed or altered from any source distribution.
 */
 
#pragma once
 
#include <stdarg.h>
 
#include <Objectively/Object.h>
 
typedef struct Vector Vector;
typedef struct VectorInterface VectorInterface;
 
typedef void (*VectorEnumerator)(const Vector *vector, ident obj, ident data);
 
struct Vector {
 
    Object object;
 
    VectorInterface *interface;
 
    size_t capacity;
 
    size_t count;
 
    size_t size;
 
    ident elements;
};
 
#define VectorElement(vector, type, index) \
    (((type *) vector->elements) + (index))
 
struct VectorInterface {
 
    ObjectInterface objectInterface;
 
    void (*addElement)(Vector *self, const ident element);
 
    void (*enumerateElements)(const Vector *self, VectorEnumerator enumerator, ident data);
 
    void (*filterElements)(Vector *self, Predicate predicate, ident data);
 
    ident (*findElement)(const Vector *self, Predicate predicate, ident data);
 
    ssize_t (*indexOfElement)(const Vector *self, const ident element);
 
    Vector *(*initWithElements)(Vector *self, size_t size, size_t count, ident elements);
 
    Vector *(*initWithSize)(Vector *self, size_t size);
 
    void (*insertElementAtIndex)(Vector *self, const ident element, size_t index);
 
    ident (*reduce)(const Vector *self, Reducer reducer, ident accumulator, ident data);
 
    void (*removeAllElements)(Vector *self);
    
    void (*removeElementAtIndex)(Vector *self, size_t index);
 
    void (*resize)(Vector *self, size_t capacity);
 
    void (*sort)(Vector *self, Comparator comparator);
 
    Vector *(*vectorWithSize)(size_t size);
 
    Vector *(*vectorWithElements)(size_t size, size_t count, ident elements);
};
 
OBJECTIVELY_EXPORT Class *_Vector(void);