Cleanup: remove redundant doxygen \file argument
[blender.git] / source / blender / blenlib / intern / array_store_utils.c
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  */
16
17 /** \file \ingroup bli
18  *  \brief Helper functions for BLI_array_store API.
19  */
20
21 #include "MEM_guardedalloc.h"
22
23 #include "BLI_utildefines.h"
24
25 #include "BLI_array_store.h"
26 #include "BLI_array_store_utils.h"  /* own include */
27
28 #include "BLI_math_base.h"
29
30 BArrayStore *BLI_array_store_at_size_ensure(
31         struct BArrayStore_AtSize *bs_stride,
32         const int stride, const int chunk_size)
33 {
34         if (bs_stride->stride_table_len < stride) {
35                 bs_stride->stride_table_len = stride;
36                 bs_stride->stride_table = MEM_recallocN(bs_stride->stride_table, sizeof(*bs_stride->stride_table) * stride);
37         }
38         BArrayStore **bs_p = &bs_stride->stride_table[stride - 1];
39
40         if ((*bs_p) == NULL) {
41                 /* calculate best chunk-count to fit a power of two */
42                 unsigned int chunk_count = chunk_size;
43                 {
44                         unsigned int size = chunk_count * stride;
45                         size = power_of_2_max_u(size);
46                         size = MEM_SIZE_OPTIMAL(size);
47                         chunk_count = size / stride;
48                 }
49
50                 (*bs_p) = BLI_array_store_create(stride, chunk_count);
51         }
52         return *bs_p;
53 }
54
55 BArrayStore *BLI_array_store_at_size_get(
56         struct BArrayStore_AtSize *bs_stride,
57         const int stride)
58 {
59         BLI_assert(stride > 0 && stride <= bs_stride->stride_table_len);
60         return bs_stride->stride_table[stride - 1];
61 }
62
63 void BLI_array_store_at_size_clear(
64         struct BArrayStore_AtSize *bs_stride)
65 {
66         for (int i = 0; i < bs_stride->stride_table_len; i += 1) {
67                 if (bs_stride->stride_table[i]) {
68                         BLI_array_store_destroy(bs_stride->stride_table[i]);
69                 }
70         }
71
72         MEM_freeN(bs_stride->stride_table);
73         bs_stride->stride_table = NULL;
74         bs_stride->stride_table_len = 0;
75 }
76
77
78 void BLI_array_store_at_size_calc_memory_usage(
79         struct BArrayStore_AtSize *bs_stride,
80         size_t *r_size_expanded, size_t *r_size_compacted)
81 {
82         size_t size_compacted = 0;
83         size_t size_expanded  = 0;
84         for (int i = 0; i < bs_stride->stride_table_len; i++) {
85                 BArrayStore *bs = bs_stride->stride_table[i];
86                 if (bs) {
87                         size_compacted += BLI_array_store_calc_size_compacted_get(bs);
88                         size_expanded  += BLI_array_store_calc_size_expanded_get(bs);
89                 }
90         }
91
92         *r_size_expanded = size_expanded;
93         *r_size_compacted = size_compacted;
94 }