comparison: src/cx/array_list.h
src/cx/array_list.h
- changeset 606
- 314e9288af2f
- child 608
- 2e93521145ac
equal
deleted
inserted
replaced
| 605:be5a4902d405 | 606:314e9288af2f |
|---|---|
| 1 /* | |
| 2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. | |
| 3 * | |
| 4 * Copyright 2021 Mike Becker, Olaf Wintermann All rights reserved. | |
| 5 * | |
| 6 * Redistribution and use in source and binary forms, with or without | |
| 7 * modification, are permitted provided that the following conditions are met: | |
| 8 * | |
| 9 * 1. Redistributions of source code must retain the above copyright | |
| 10 * notice, this list of conditions and the following disclaimer. | |
| 11 * | |
| 12 * 2. Redistributions in binary form must reproduce the above copyright | |
| 13 * notice, this list of conditions and the following disclaimer in the | |
| 14 * documentation and/or other materials provided with the distribution. | |
| 15 * | |
| 16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" | |
| 17 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | |
| 18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | |
| 19 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE | |
| 20 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR | |
| 21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF | |
| 22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS | |
| 23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN | |
| 24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) | |
| 25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE | |
| 26 * POSSIBILITY OF SUCH DAMAGE. | |
| 27 */ | |
| 28 /** | |
| 29 * \file array_list.h | |
| 30 * \brief Array list implementation. | |
| 31 * \details Also provides several low-level functions for custom array list implementations. | |
| 32 * \author Mike Becker | |
| 33 * \author Olaf Wintermann | |
| 34 * \version 3.0 | |
| 35 * \copyright 2-Clause BSD License | |
| 36 */ | |
| 37 | |
| 38 | |
| 39 #ifndef UCX_ARRAY_LIST_H | |
| 40 #define UCX_ARRAY_LIST_H | |
| 41 | |
| 42 #include "cx/list.h" | |
| 43 | |
| 44 #ifdef __cplusplus | |
| 45 extern "C" { | |
| 46 #endif | |
| 47 | |
| 48 /** | |
| 49 * Allocates an array list for storing elements with \p item_size bytes each. | |
| 50 * | |
| 51 * @param allocator the allocator for allocating the list memory | |
| 52 * @param comparator the comparator for the elements | |
| 53 * @param item_size the size of each element in bytes | |
| 54 * @param initial_capacity the initial number of elements the array can store | |
| 55 * @return the created list | |
| 56 */ | |
| 57 CxList *cxArrayListCreate( | |
| 58 CxAllocator const *allocator, | |
| 59 CxListComparator comparator, | |
| 60 size_t item_size, | |
| 61 size_t initial_capacity | |
| 62 ) __attribute__((__nonnull__)); | |
| 63 | |
| 64 | |
| 65 #ifdef __cplusplus | |
| 66 } /* extern "C" */ | |
| 67 #endif | |
| 68 | |
| 69 #endif /* UCX_ARRAY_LIST_H */ |
