libacfutils/vector_8h_source.html

/*

 * CDDL HEADER START

 *

 * The contents of this file are subject to the terms of the

 * Common Development and Distribution License, Version 1.0 only

 * (the "License").  You may not use this file except in compliance

 * with the License.

 *

 * You can obtain a copy of the license in the file COPYING

 * or http://www.opensource.org/licenses/CDDL-1.0.

 * See the License for the specific language governing permissions

 * and limitations under the License.

 *

 * When distributing Covered Code, include this CDDL HEADER in each

 * file and include the License file COPYING.

 * If applicable, add the following below this CDDL HEADER, with the

 * fields enclosed by brackets "[]" replaced with your own identifying

 * information: Portions Copyright [yyyy] [name of copyright owner]

 *

 * CDDL HEADER END

 */

/*

 * Copyright 2024 Saso Kiselkov. All rights reserved.

 */

#ifndef _ACF_UTILS_VECTOR_H_

#define _ACF_UTILS_VECTOR_H_


#include <acfutils/optional.h>

#include <acfutils/sysmacros.h>


#include "vector_impl.h"


#ifdef  __cplusplus

extern "C" {

#endif


void vector_create(vector_t REQ_PTR(v));

void vector_create_cap(vector_t REQ_PTR(v), size_t cap_hint);

void vector_destroy(vector_t REQ_PTR(v));

size_t vector_len(const vector_t REQ_PTR(v));

void *vector_get(const vector_t REQ_PTR(v), size_t index);

void *vector_head(const vector_t REQ_PTR(v));

void *vector_tail(const vector_t REQ_PTR(v));

opt_size_t vector_find(const vector_t REQ_PTR(v), const void *item);

void vector_insert(vector_t REQ_PTR(v), void *elem, size_t index);

void vector_insert_tail(vector_t REQ_PTR(v), void *elem);

void *vector_replace(vector_t REQ_PTR(v), void *new_elem, size_t index);

void *vector_remove(vector_t REQ_PTR(v), size_t index);

void *vector_remove_head(vector_t REQ_PTR(v));

void *vector_remove_tail(vector_t REQ_PTR(v));

size_t vector_shrink(vector_t REQ_PTR(v));

size_t vector_cap(const vector_t REQ_PTR(v));

void vector_move_all(vector_t REQ_PTR(src), vector_t REQ_PTR(dest));

void vector_sort(vector_t REQ_PTR(v),

    int (*sort_func)(const void *a, const void *b));

void vector_sort_r(vector_t REQ_PTR(v),

    int (*sort_func)(const void *a, const void *b, void *userinfo),

    void *userinfo);


#ifdef  __cplusplus

}

#endif


#endif  /* _ACF_UTILS_VECTOR_H_ */

optional.h

opt_uint64_t
An optional type for wrapping a uint64_t value.
Definition optional.h:741

vector_t
Definition vector_impl.h:37

sysmacros.h

REQ_PTR
#define REQ_PTR(x)
Definition sysmacros.h:334

vector_move_all
void vector_move_all(vector_t REQ_PTR(src), vector_t REQ_PTR(dest))
Moves all elements from the src vector to the dest vector.

vector_len
size_t vector_len(const vector_t REQ_PTR(v))
Returns the current number of elements contained inside the vector.

vector_create
void vector_create(vector_t REQ_PTR(v))
Initializes a new vector_t to a blank state, with zero starting capacity.

vector_remove_tail
void * vector_remove_tail(vector_t REQ_PTR(v))
Removes and returns the last element in a vector, if any.

vector_remove
void * vector_remove(vector_t REQ_PTR(v), size_t index)
Removes an element from the vector at a given index.

vector_sort
void vector_sort(vector_t REQ_PTR(v), int(*sort_func)(const void *a, const void *b))
Sorts a vector using the and a sorting predicate.

vector_replace
void * vector_replace(vector_t REQ_PTR(v), void *new_elem, size_t index)
Replaces an element in the vector in-place.

vector_insert
void vector_insert(vector_t REQ_PTR(v), void *elem, size_t index)
Inserts a new element into the vector at a given index.

vector_shrink
size_t vector_shrink(vector_t REQ_PTR(v))
Orders the vector to shrink to the nearest power-of-2 capacity suitable to hold its current contents.

vector_insert_tail
void vector_insert_tail(vector_t REQ_PTR(v), void *elem)
Inserts a new element at the tail of the vector.

vector_tail
void * vector_tail(const vector_t REQ_PTR(v))
Retrieves the element at the tail of the vector, if any.

vector_remove_head
void * vector_remove_head(vector_t REQ_PTR(v))
Removes and returns the first element in a vector, if any.

vector_sort_r
void vector_sort_r(vector_t REQ_PTR(v), int(*sort_func)(const void *a, const void *b, void *userinfo), void *userinfo)
Sorts a vector using the and a thread-safe sorting predicate.

vector_get
void * vector_get(const vector_t REQ_PTR(v), size_t index)
Retrieves elements within the vector.

vector_find
opt_size_t vector_find(const vector_t REQ_PTR(v), const void *item)
Locates an element in the vector by value.

vector_create_cap
void vector_create_cap(vector_t REQ_PTR(v), size_t cap_hint)
Initializes a new vector_t with a capacity hint.

vector_head
void * vector_head(const vector_t REQ_PTR(v))
Retrieves the element at the head of the vector, if any.

vector_cap
size_t vector_cap(const vector_t REQ_PTR(v))
Returns the current element capacity of the vector.

vector_destroy
void vector_destroy(vector_t REQ_PTR(v))
Destroys a vector previously created using vector_create().