Welcome to mirror list, hosted at ThFree Co, Russian Federation.

FN_generic_vector_array.hh « functions « blender « source - git.blender.org/blender.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: 6be1b68da4d8f825140ed6a0e61a2721b9db20dc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
/*
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 */

#ifndef __FN_GENERIC_VECTOR_ARRAY_HH__
#define __FN_GENERIC_VECTOR_ARRAY_HH__

/** \file
 * \ingroup fn
 *
 * A `GVectorArray` is a container for a fixed amount of dynamically growing arrays with a generic
 * type. Its main use case is to store many small vectors with few separate allocations. Using this
 * structure is generally more efficient than allocating each small vector separately.
 *
 * `GVectorArrayRef<T>` is a typed reference to a GVectorArray and makes it easier and safer to
 * work with the class when the type is known at compile time.
 */

#include "FN_array_spans.hh"
#include "FN_cpp_type.hh"

#include "BLI_array.hh"
#include "BLI_linear_allocator.hh"
#include "BLI_utility_mixins.hh"

namespace blender {
namespace fn {

template<typename T> class GVectorArrayRef;

class GVectorArray : NonCopyable, NonMovable {
 private:
  const CPPType &m_type;
  uint m_element_size;
  Array<void *, 1> m_starts;
  Array<uint, 1> m_lengths;
  Array<uint, 1> m_capacities;
  LinearAllocator<> m_allocator;

  template<typename T> friend class GVectorArrayRef;

 public:
  GVectorArray() = delete;

  GVectorArray(const CPPType &type, uint array_size)
      : m_type(type),
        m_element_size(type.size()),
        m_starts(array_size),
        m_lengths(array_size),
        m_capacities(array_size)
  {
    m_starts.fill(nullptr);
    m_lengths.fill(0);
    m_capacities.fill(0);
  }

  ~GVectorArray()
  {
    if (m_type.is_trivially_destructible()) {
      return;
    }

    for (uint i : m_starts.index_range()) {
      m_type.destruct_n(m_starts[i], m_lengths[i]);
    }
  }

  operator GVArraySpan() const
  {
    return GVArraySpan(m_type, m_starts.as_span(), m_lengths);
  }

  bool is_empty() const
  {
    return m_starts.size() == 0;
  }

  uint size() const
  {
    return m_starts.size();
  }

  const CPPType &type() const
  {
    return m_type;
  }

  Span<const void *> starts() const
  {
    return m_starts.as_span();
  }

  Span<uint> lengths() const
  {
    return m_lengths;
  }

  void append(uint index, const void *src)
  {
    uint old_length = m_lengths[index];
    if (old_length == m_capacities[index]) {
      this->grow_at_least_one(index);
    }

    void *dst = POINTER_OFFSET(m_starts[index], m_element_size * old_length);
    m_type.copy_to_uninitialized(src, dst);
    m_lengths[index]++;
  }

  void extend(uint index, GVSpan span)
  {
    BLI_assert(m_type == span.type());
    for (uint i = 0; i < span.size(); i++) {
      this->append(index, span[i]);
    }
  }

  void extend(IndexMask mask, GVArraySpan array_span)
  {
    BLI_assert(m_type == array_span.type());
    BLI_assert(mask.min_array_size() <= array_span.size());
    for (uint i : mask) {
      this->extend(i, array_span[i]);
    }
  }

  GMutableSpan operator[](uint index)
  {
    BLI_assert(index < m_starts.size());
    return GMutableSpan(m_type, m_starts[index], m_lengths[index]);
  }
  template<typename T> GVectorArrayRef<T> typed()
  {
    return GVectorArrayRef<T>(*this);
  }

 private:
  void grow_at_least_one(uint index)
  {
    BLI_assert(m_lengths[index] == m_capacities[index]);
    uint new_capacity = m_lengths[index] * 2 + 1;

    void *new_buffer = m_allocator.allocate(m_element_size * new_capacity, m_type.alignment());
    m_type.relocate_to_uninitialized_n(m_starts[index], new_buffer, m_lengths[index]);

    m_starts[index] = new_buffer;
    m_capacities[index] = new_capacity;
  }
};

template<typename T> class GVectorArrayRef {
 private:
  GVectorArray *m_vector_array;

 public:
  GVectorArrayRef(GVectorArray &vector_array) : m_vector_array(&vector_array)
  {
    BLI_assert(vector_array.m_type.is<T>());
  }

  void append(uint index, const T &value)
  {
    m_vector_array->append(index, &value);
  }

  void extend(uint index, Span<T> values)
  {
    m_vector_array->extend(index, values);
  }

  void extend(uint index, VSpan<T> values)
  {
    m_vector_array->extend(index, GVSpan(values));
  }

  MutableSpan<T> operator[](uint index)
  {
    BLI_assert(index < m_vector_array->m_starts.size());
    return MutableSpan<T>((T *)m_vector_array->m_starts[index], m_vector_array->m_lengths[index]);
  }

  uint size() const
  {
    return m_vector_array->size();
  }

  bool is_empty() const
  {
    return m_vector_array->is_empty();
  }
};

}  // namespace fn
}  // namespace blender

#endif /* __FN_GENERIC_VECTOR_ARRAY_HH__ */