626 lines
17 KiB
C++
626 lines
17 KiB
C++
/*
|
|
* 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 __BLI_SPAN_HH__
|
|
#define __BLI_SPAN_HH__
|
|
|
|
/** \file
|
|
* \ingroup bli
|
|
*
|
|
* An `blender::Span<T>` references an array that is owned by someone else. It is just a
|
|
* pointer and a size. Since the memory is not owned, Span should not be used to transfer
|
|
* ownership. The array cannot be modified through the Span. However, if T is a non-const
|
|
* pointer, the pointed-to elements can be modified.
|
|
*
|
|
* There is also `blender::MutableSpan<T>`. It is mostly the same as Span, but allows the
|
|
* array to be modified.
|
|
*
|
|
* A (Mutable)Span can refer to data owned by many different data structures including
|
|
* blender::Vector, blender::Array, blender::VectorSet, std::vector, std::array, std::string,
|
|
* std::initializer_list and c-style array.
|
|
*
|
|
* `blender::Span` is very similar to `std::span` (C++20). However, there are a few differences:
|
|
* - `blender::Span` is const by default. This is to avoid making things mutable when they don't
|
|
* have to be. To get a non-const span, you need to use `blender::MutableSpan`. Below is a list
|
|
* of const-behavior-equivalent pairs of data structures:
|
|
* - std::span<int> <==> blender::MutableSpan<int>
|
|
* - std::span<const int> <==> blender::Span<int>
|
|
* - std::span<int *> <==> blender::MutableSpan<int *>
|
|
* - std::span<const int *> <==> blender::MutableSpan<const int *>
|
|
* - std::span<int * const> <==> blender::Span<int *>
|
|
* - std::span<const int * const> <==> blender::Span<const int *>
|
|
* - `blender::Span` always has a dynamic extent, while `std::span` can have a size that is
|
|
* determined at compile time. I did not have a use case for that yet. If we need it, we can
|
|
* decide to add this functionality to `blender::Span` or introduce a new type like
|
|
* `blender::FixedSpan<T, N>`.
|
|
*
|
|
* `blender::Span<T>` should be your default choice when you have to pass a read-only array
|
|
* into a function. It is better than passing a `const Vector &`, because then the function only
|
|
* works for vectors and not for e.g. arrays. Using Span as function parameter makes it usable
|
|
* in more contexts, better expresses the intent and does not sacrifice performance. It is also
|
|
* better than passing a raw pointer and size separately, because it is more convenient and safe.
|
|
*
|
|
* `blender::MutableSpan<T>` can be used when a function is supposed to return an array, the
|
|
* size of which is known before the function is called. One advantage of this approach is that the
|
|
* caller is responsible for allocation and deallocation. Furthermore, the function can focus on
|
|
* its task, without having to worry about memory allocation. Alternatively, a function could
|
|
* return an Array or Vector.
|
|
*
|
|
* Note: When a function has a MutableSpan<T> output parameter and T is not a trivial type,
|
|
* then the function has to specify whether the referenced array is expected to be initialized or
|
|
* not.
|
|
*
|
|
* Since the arrays are only referenced, it is generally unsafe to store an Span. When you
|
|
* store one, you should know who owns the memory.
|
|
*
|
|
* Instances of Span and MutableSpan are small and should be passed by value.
|
|
*/
|
|
|
|
#include <algorithm>
|
|
#include <array>
|
|
#include <iostream>
|
|
#include <string>
|
|
#include <vector>
|
|
|
|
#include "BLI_index_range.hh"
|
|
#include "BLI_memory_utils.hh"
|
|
#include "BLI_utildefines.h"
|
|
|
|
namespace blender {
|
|
|
|
/**
|
|
* References an array of type T that is owned by someone else. The data in the array cannot be
|
|
* modified.
|
|
*/
|
|
template<typename T> class Span {
|
|
private:
|
|
const T *start_ = nullptr;
|
|
uint size_ = 0;
|
|
|
|
public:
|
|
/**
|
|
* Create a reference to an empty array.
|
|
*/
|
|
Span() = default;
|
|
|
|
Span(const T *start, uint size) : start_(start), size_(size)
|
|
{
|
|
}
|
|
|
|
template<typename U, typename std::enable_if_t<is_convertible_pointer_v<U, T>> * = nullptr>
|
|
Span(const U *start, uint size) : start_((const T *)start), size_(size)
|
|
{
|
|
}
|
|
|
|
/**
|
|
* Reference an initializer_list. Note that the data in the initializer_list is only valid until
|
|
* the expression containing it is fully computed.
|
|
*
|
|
* Do:
|
|
* call_function_with_array({1, 2, 3, 4});
|
|
*
|
|
* Don't:
|
|
* Span<int> span = {1, 2, 3, 4};
|
|
* call_function_with_array(span);
|
|
*/
|
|
Span(const std::initializer_list<T> &list) : Span(list.begin(), (uint)list.size())
|
|
{
|
|
}
|
|
|
|
Span(const std::vector<T> &vector) : Span(vector.data(), (uint)vector.size())
|
|
{
|
|
}
|
|
|
|
template<std::size_t N> Span(const std::array<T, N> &array) : Span(array.data(), N)
|
|
{
|
|
}
|
|
|
|
/**
|
|
* Support implicit conversions like the ones below:
|
|
* Span<T *> -> Span<const T *>
|
|
* Span<Derived *> -> Span<Base *>
|
|
*/
|
|
template<typename U, typename std::enable_if_t<is_convertible_pointer_v<U, T>> * = nullptr>
|
|
Span(Span<U> array) : start_((T *)array.data()), size_(array.size())
|
|
{
|
|
}
|
|
|
|
/**
|
|
* Returns a contiguous part of the array. This invokes undefined behavior when the slice does
|
|
* not stay within the bounds of the array.
|
|
*/
|
|
Span slice(uint start, uint size) const
|
|
{
|
|
BLI_assert(start + size <= this->size() || size == 0);
|
|
return Span(start_ + start, size);
|
|
}
|
|
|
|
Span slice(IndexRange range) const
|
|
{
|
|
return this->slice(range.start(), range.size());
|
|
}
|
|
|
|
/**
|
|
* Returns a new Span with n elements removed from the beginning. This invokes undefined
|
|
* behavior when the array is too small.
|
|
*/
|
|
Span drop_front(uint n) const
|
|
{
|
|
BLI_assert(n <= this->size());
|
|
return this->slice(n, this->size() - n);
|
|
}
|
|
|
|
/**
|
|
* Returns a new Span with n elements removed from the beginning. This invokes undefined
|
|
* behavior when the array is too small.
|
|
*/
|
|
Span drop_back(uint n) const
|
|
{
|
|
BLI_assert(n <= this->size());
|
|
return this->slice(0, this->size() - n);
|
|
}
|
|
|
|
/**
|
|
* Returns a new Span that only contains the first n elements. This invokes undefined
|
|
* behavior when the array is too small.
|
|
*/
|
|
Span take_front(uint n) const
|
|
{
|
|
BLI_assert(n <= this->size());
|
|
return this->slice(0, n);
|
|
}
|
|
|
|
/**
|
|
* Returns a new Span that only contains the last n elements. This invokes undefined
|
|
* behavior when the array is too small.
|
|
*/
|
|
Span take_back(uint n) const
|
|
{
|
|
BLI_assert(n <= this->size());
|
|
return this->slice(this->size() - n, n);
|
|
}
|
|
|
|
/**
|
|
* Returns the pointer to the beginning of the referenced array. This may be nullptr when the
|
|
* size is zero.
|
|
*/
|
|
const T *data() const
|
|
{
|
|
return start_;
|
|
}
|
|
|
|
const T *begin() const
|
|
{
|
|
return start_;
|
|
}
|
|
|
|
const T *end() const
|
|
{
|
|
return start_ + size_;
|
|
}
|
|
|
|
/**
|
|
* Access an element in the array. This invokes undefined behavior when the index is out of
|
|
* bounds.
|
|
*/
|
|
const T &operator[](uint index) const
|
|
{
|
|
BLI_assert(index < size_);
|
|
return start_[index];
|
|
}
|
|
|
|
/**
|
|
* Returns the number of elements in the referenced array.
|
|
*/
|
|
uint size() const
|
|
{
|
|
return size_;
|
|
}
|
|
|
|
/**
|
|
* Returns true if the size is zero.
|
|
*/
|
|
bool is_empty() const
|
|
{
|
|
return size_ == 0;
|
|
}
|
|
|
|
/**
|
|
* Returns the number of bytes referenced by this Span.
|
|
*/
|
|
uint size_in_bytes() const
|
|
{
|
|
return sizeof(T) * size_;
|
|
}
|
|
|
|
/**
|
|
* Does a linear search to see of the value is in the array.
|
|
* Returns true if it is, otherwise false.
|
|
*/
|
|
bool contains(const T &value) const
|
|
{
|
|
for (const T &element : *this) {
|
|
if (element == value) {
|
|
return true;
|
|
}
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Does a constant time check to see if the pointer points to a value in the referenced array.
|
|
* Return true if it is, otherwise false.
|
|
*/
|
|
bool contains_ptr(const T *ptr) const
|
|
{
|
|
return (this->begin() <= ptr) && (ptr < this->end());
|
|
}
|
|
|
|
/**
|
|
* Does a linear search to count how often the value is in the array.
|
|
* Returns the number of occurrences.
|
|
*/
|
|
uint count(const T &value) const
|
|
{
|
|
uint counter = 0;
|
|
for (const T &element : *this) {
|
|
if (element == value) {
|
|
counter++;
|
|
}
|
|
}
|
|
return counter;
|
|
}
|
|
|
|
/**
|
|
* Return a reference to the first element in the array. This invokes undefined behavior when the
|
|
* array is empty.
|
|
*/
|
|
const T &first() const
|
|
{
|
|
BLI_assert(size_ > 0);
|
|
return start_[0];
|
|
}
|
|
|
|
/**
|
|
* Returns a reference to the last element in the array. This invokes undefined behavior when the
|
|
* array is empty.
|
|
*/
|
|
const T &last() const
|
|
{
|
|
BLI_assert(size_ > 0);
|
|
return start_[size_ - 1];
|
|
}
|
|
|
|
/**
|
|
* Returns the element at the given index. If the index is out of range, return the fallback
|
|
* value.
|
|
*/
|
|
T get(uint index, const T &fallback) const
|
|
{
|
|
if (index < size_) {
|
|
return start_[index];
|
|
}
|
|
return fallback;
|
|
}
|
|
|
|
/**
|
|
* Check if the array contains duplicates. Does a linear search for every element. So the total
|
|
* running time is O(n^2). Only use this for small arrays.
|
|
*/
|
|
bool has_duplicates__linear_search() const
|
|
{
|
|
/* The size should really be smaller than that. If it is not, the calling code should be
|
|
* changed. */
|
|
BLI_assert(size_ < 1000);
|
|
|
|
for (uint i = 0; i < size_; i++) {
|
|
const T &value = start_[i];
|
|
for (uint j = i + 1; j < size_; j++) {
|
|
if (value == start_[j]) {
|
|
return true;
|
|
}
|
|
}
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Returns true when this and the other array have an element in common. This should only be
|
|
* called on small arrays, because it has a running time of O(n*m) where n and m are the sizes of
|
|
* the arrays.
|
|
*/
|
|
bool intersects__linear_search(Span other) const
|
|
{
|
|
/* The size should really be smaller than that. If it is not, the calling code should be
|
|
* changed. */
|
|
BLI_assert(size_ < 1000);
|
|
|
|
for (uint i = 0; i < size_; i++) {
|
|
const T &value = start_[i];
|
|
if (other.contains(value)) {
|
|
return true;
|
|
}
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Returns the index of the first occurrence of the given value. This invokes undefined behavior
|
|
* when the value is not in the array.
|
|
*/
|
|
uint first_index(const T &search_value) const
|
|
{
|
|
const int index = this->first_index_try(search_value);
|
|
BLI_assert(index >= 0);
|
|
return (uint)index;
|
|
}
|
|
|
|
/**
|
|
* Returns the index of the first occurrence of the given value or -1 if it does not exist.
|
|
*/
|
|
int first_index_try(const T &search_value) const
|
|
{
|
|
for (uint i = 0; i < size_; i++) {
|
|
if (start_[i] == search_value) {
|
|
return i;
|
|
}
|
|
}
|
|
return -1;
|
|
}
|
|
|
|
/**
|
|
* Utility to make it more convenient to iterate over all indices that can be used with this
|
|
* array.
|
|
*/
|
|
IndexRange index_range() const
|
|
{
|
|
return IndexRange(size_);
|
|
}
|
|
|
|
/**
|
|
* Returns a new Span to the same underlying memory buffer. No conversions are done.
|
|
*/
|
|
template<typename NewT> Span<NewT> cast() const
|
|
{
|
|
BLI_assert((size_ * sizeof(T)) % sizeof(NewT) == 0);
|
|
uint new_size = size_ * sizeof(T) / sizeof(NewT);
|
|
return Span<NewT>(reinterpret_cast<const NewT *>(start_), new_size);
|
|
}
|
|
|
|
/**
|
|
* A debug utility to print the content of the Span. Every element will be printed on a
|
|
* separate line using the given callback.
|
|
*/
|
|
template<typename PrintLineF> void print_as_lines(std::string name, PrintLineF print_line) const
|
|
{
|
|
std::cout << "Span: " << name << " \tSize:" << size_ << '\n';
|
|
for (const T &value : *this) {
|
|
std::cout << " ";
|
|
print_line(value);
|
|
std::cout << '\n';
|
|
}
|
|
}
|
|
|
|
/**
|
|
* A debug utility to print the content of the span. Every element be printed on a separate
|
|
* line.
|
|
*/
|
|
void print_as_lines(std::string name) const
|
|
{
|
|
this->print_as_lines(name, [](const T &value) { std::cout << value; });
|
|
}
|
|
};
|
|
|
|
/**
|
|
* Mostly the same as Span, except that one can change the array elements through a
|
|
* MutableSpan.
|
|
*/
|
|
template<typename T> class MutableSpan {
|
|
private:
|
|
T *start_;
|
|
uint size_;
|
|
|
|
public:
|
|
MutableSpan() = default;
|
|
|
|
MutableSpan(T *start, const uint size) : start_(start), size_(size)
|
|
{
|
|
}
|
|
|
|
MutableSpan(std::vector<T> &vector) : MutableSpan(vector.data(), vector.size())
|
|
{
|
|
}
|
|
|
|
template<std::size_t N> MutableSpan(std::array<T, N> &array) : MutableSpan(array.data(), N)
|
|
{
|
|
}
|
|
|
|
operator Span<T>() const
|
|
{
|
|
return Span<T>(start_, size_);
|
|
}
|
|
|
|
/**
|
|
* Returns the number of elements in the array.
|
|
*/
|
|
uint size() const
|
|
{
|
|
return size_;
|
|
}
|
|
|
|
/**
|
|
* Replace all elements in the referenced array with the given value.
|
|
*/
|
|
void fill(const T &value)
|
|
{
|
|
initialized_fill_n(start_, size_, value);
|
|
}
|
|
|
|
/**
|
|
* Replace a subset of all elements with the given value. This invokes undefined behavior when
|
|
* one of the indices is out of bounds.
|
|
*/
|
|
void fill_indices(Span<uint> indices, const T &value)
|
|
{
|
|
for (uint i : indices) {
|
|
BLI_assert(i < size_);
|
|
start_[i] = value;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Returns a pointer to the beginning of the referenced array. This may be nullptr, when the size
|
|
* is zero.
|
|
*/
|
|
T *data() const
|
|
{
|
|
return start_;
|
|
}
|
|
|
|
T *begin() const
|
|
{
|
|
return start_;
|
|
}
|
|
|
|
T *end() const
|
|
{
|
|
return start_ + size_;
|
|
}
|
|
|
|
T &operator[](const uint index) const
|
|
{
|
|
BLI_assert(index < this->size());
|
|
return start_[index];
|
|
}
|
|
|
|
/**
|
|
* Returns a contiguous part of the array. This invokes undefined behavior when the slice would
|
|
* go out of bounds.
|
|
*/
|
|
MutableSpan slice(const uint start, const uint length) const
|
|
{
|
|
BLI_assert(start + length <= this->size());
|
|
return MutableSpan(start_ + start, length);
|
|
}
|
|
|
|
/**
|
|
* Returns a new MutableSpan with n elements removed from the beginning. This invokes
|
|
* undefined behavior when the array is too small.
|
|
*/
|
|
MutableSpan drop_front(const uint n) const
|
|
{
|
|
BLI_assert(n <= this->size());
|
|
return this->slice(n, this->size() - n);
|
|
}
|
|
|
|
/**
|
|
* Returns a new MutableSpan with n elements removed from the end. This invokes undefined
|
|
* behavior when the array is too small.
|
|
*/
|
|
MutableSpan drop_back(const uint n) const
|
|
{
|
|
BLI_assert(n <= this->size());
|
|
return this->slice(0, this->size() - n);
|
|
}
|
|
|
|
/**
|
|
* Returns a new MutableSpan that only contains the first n elements. This invokes undefined
|
|
* behavior when the array is too small.
|
|
*/
|
|
MutableSpan take_front(const uint n) const
|
|
{
|
|
BLI_assert(n <= this->size());
|
|
return this->slice(0, n);
|
|
}
|
|
|
|
/**
|
|
* Return a new MutableSpan that only contains the last n elements. This invokes undefined
|
|
* behavior when the array is too small.
|
|
*/
|
|
MutableSpan take_back(const uint n) const
|
|
{
|
|
BLI_assert(n <= this->size());
|
|
return this->slice(this->size() - n, n);
|
|
}
|
|
|
|
/**
|
|
* Returns an (immutable) Span that references the same array. This is usually not needed,
|
|
* due to implicit conversions. However, sometimes automatic type deduction needs some help.
|
|
*/
|
|
Span<T> as_span() const
|
|
{
|
|
return Span<T>(start_, size_);
|
|
}
|
|
|
|
/**
|
|
* Utility to make it more convenient to iterate over all indices that can be used with this
|
|
* array.
|
|
*/
|
|
IndexRange index_range() const
|
|
{
|
|
return IndexRange(size_);
|
|
}
|
|
|
|
/**
|
|
* Returns a reference to the last element. This invokes undefined behavior when the array is
|
|
* empty.
|
|
*/
|
|
T &last() const
|
|
{
|
|
BLI_assert(size_ > 0);
|
|
return start_[size_ - 1];
|
|
}
|
|
|
|
/**
|
|
* Returns a new span to the same underlying memory buffer. No conversions are done.
|
|
*/
|
|
template<typename NewT> MutableSpan<NewT> cast() const
|
|
{
|
|
BLI_assert((size_ * sizeof(T)) % sizeof(NewT) == 0);
|
|
uint new_size = size_ * sizeof(T) / sizeof(NewT);
|
|
return MutableSpan<NewT>(reinterpret_cast<NewT *>(start_), new_size);
|
|
}
|
|
};
|
|
|
|
/**
|
|
* Utilities to check that arrays have the same size in debug builds.
|
|
*/
|
|
template<typename T1, typename T2> void assert_same_size(const T1 &v1, const T2 &v2)
|
|
{
|
|
UNUSED_VARS_NDEBUG(v1, v2);
|
|
#ifdef DEBUG
|
|
uint size = v1.size();
|
|
BLI_assert(size == v1.size());
|
|
BLI_assert(size == v2.size());
|
|
#endif
|
|
}
|
|
|
|
template<typename T1, typename T2, typename T3>
|
|
void assert_same_size(const T1 &v1, const T2 &v2, const T3 &v3)
|
|
{
|
|
UNUSED_VARS_NDEBUG(v1, v2, v3);
|
|
#ifdef DEBUG
|
|
uint size = v1.size();
|
|
BLI_assert(size == v1.size());
|
|
BLI_assert(size == v2.size());
|
|
BLI_assert(size == v3.size());
|
|
#endif
|
|
}
|
|
|
|
} /* namespace blender */
|
|
|
|
#endif /* __BLI_SPAN_HH__ */
|