5 * Copyright (c) 2020 Samsung Electronics Co., Ltd.
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
24 #include <cstdint> // uint32_t
27 #include <dali/public-api/common/dali-common.h>
28 #include <dali/public-api/common/type-traits.h>
29 #include <dali/public-api/math/math-utils.h>
32 * @brief For DALi internal use, asserts are enabled in debug builds.
34 * For Application use, asserts can be enabled manually.
37 #if defined(DEBUG_ENABLED)
38 #define ENABLE_VECTOR_ASSERTS
41 #if defined(ENABLE_VECTOR_ASSERTS)
42 #define DALI_ASSERT_VECTOR(cond) DALI_ASSERT_ALWAYS(cond)
44 #define DALI_ASSERT_VECTOR(cond)
50 * @addtogroup dali_core_common
55 * @brief Base class to handle the memory of simple vector.
57 * Memory layout is such that it has two std::size_t to hold the count
58 * and capacity of the vector. VectorBase::mData is adjusted so that it points to the
59 * beginning of the first real item so that iterating the items is quick.
62 class DALI_CORE_API VectorBase
65 using SizeType = std::size_t;
67 protected: // Construction
69 * @brief Default constructor. Does not allocate space.
77 * Does not release the space. Derived class needs to call Release.
78 * Not virtual as this should not be called directly and we do not want
79 * a vtable for this class as it would unnecessarily increase size.
86 * @brief This method is inlined as it's needed frequently for Vector::End() iterator.
89 * @return The count of elements in this vector
91 SizeType Count() const
96 SizeType* metadata = reinterpret_cast<SizeType*>(mData);
97 items = *(metadata - 1u);
103 * @brief Gets the count of elements in this vector.
105 * @return The count of elements in this vector
107 SizeType Size() const
113 * @brief @ return if the vector is empty.
115 * @return True if the count of elements is empty
119 return Count() == 0u;
123 * @brief Gets the capacity of this vector.
125 * @return The capacity of this vector
127 SizeType Capacity() const;
130 * @brief Releases the data.
132 * Does not call destructors on objects held.
137 protected: // for Derived classes
139 * @brief Helper to set the count.
142 * @param[in] count Number of elements in the vector
144 void SetCount(SizeType count);
147 * @brief Reserves space in the vector.
150 * @param[in] count Count of elements to reserve
151 * @param[in] elementSize Size of a single element
153 void Reserve(SizeType count, SizeType elementSize);
156 * @brief Copy a vector.
159 * @param[in] vector Vector to copy from
160 * @param[in] elementSize Size of a single element
162 void Copy(const VectorBase& vector, SizeType elementSize);
165 * @brief Swaps the contents of two vectors.
168 * @param[in] vector Vector to swap with
170 void Swap(VectorBase& vector);
173 * @brief Erases an element.
175 * Does not change capacity.
177 * @param[in] address Address to erase from
178 * @param[in] elementSize Size to erase
179 * @pre Last element cannot be erased as there is nothing to move.
181 void Erase(char* address, SizeType elementSize);
184 * @brief Erases a range of elements.
186 * Does not change capacity.
188 * @param[in] first Address to the first element to be erased
189 * @param[in] last Address to the last element to be erased
190 * @param[in] elementSize Size of one of the elements to be erased
191 * @return Address pointing to the next element of the last one
193 char* Erase(char* first, char* last, SizeType elementSize);
196 * @brief Copies a number of bytes from \e source to \e destination.
198 * \e source and \e destination must not overlap.
201 * @param[in] destination Pointer to the destination address
202 * @param[in] source Pointer to the source address
203 * @param[in] numberOfBytes The number of bytes to be copied
205 void CopyMemory(char* destination, const char* source, size_t numberOfBytes);
208 // not copyable as it does not know the size of elements
209 VectorBase(const VectorBase&) = delete; ///< Deleted copy constructor. @SINCE_1_0.0
210 VectorBase& operator=(const VectorBase&) = delete; ///< Deleted copy assignment operator. @SINCE_1_0.0
212 // not movable as this is handled by deriving classes
213 VectorBase(VectorBase&&) = delete; ///< Deleted move constructor. @SINCE_1_9.25
214 VectorBase& operator=(VectorBase&&) = delete; ///< Deleted copy assignment operator. @SINCE_1_9.25
217 void* mData; ///< Pointer to the data.
222 * @brief Vector algorithm variant for trivial types.
224 * Trivial types do not need destructor or copy constructor called.
227 template<bool IsTrivial>
228 class VectorAlgorithms : public VectorBase
230 protected: // API for deriving classes
231 using SizeType = VectorBase::SizeType;
234 * @brief Empty constructor.
237 VectorAlgorithms() = default;
240 * @brief Empty destructor.
243 ~VectorAlgorithms() = default;
246 * @brief Copy vector contents.
249 * @param[in] rhs VectorBase object to copy from
250 * @param[in] elementSize Size of the content
252 void Copy(const VectorBase& rhs, SizeType elementSize)
254 if(rhs.Capacity() > 0u)
256 VectorBase::Copy(rhs, elementSize);
260 VectorBase::Release();
265 * @brief Reserves space in the vector.
268 * @param[in] count Count of elements to reserve
269 * @param[in] elementSize Size of a single element
271 void Reserve(SizeType count, SizeType elementSize)
273 VectorBase::Reserve(count, elementSize);
277 * @brief Resizes the vector. Does not change capacity.
280 * @param[in] count Count to resize to
281 * @param[in] elementSize Size of a single element
283 void Resize(SizeType count, SizeType elementSize)
285 // reserve will copy old elements as well
286 Reserve(count, elementSize);
290 * @brief Clears the contents.
292 * For simple types, nothing to do.
299 VectorBase::SetCount(0u);
304 * @brief Releases the vector.
309 VectorBase::Release();
313 * @brief Erases an element. Does not change capacity.
316 * @param[in] address Address to erase from
317 * @param[in] elementSize Size to erase
319 void Erase(uint8_t* address, SizeType elementSize)
321 VectorBase::Erase(reinterpret_cast<char*>(address), elementSize);
325 * @brief Erases a range of elements. Does not change capacity.
328 * @param[in] first Address to the first element to be erased
329 * @param[in] last Address to the last element to be erased
330 * @param[in] elementSize Size of one of the elements to be erased
331 * @return Address pointing to the next element of the last one
333 uint8_t* Erase(uint8_t* first, uint8_t* last, SizeType elementSize)
335 return reinterpret_cast<uint8_t*>(VectorBase::Erase(reinterpret_cast<char*>(first), reinterpret_cast<char*>(last), elementSize));
339 * @brief Inserts the given elements into the vector.
342 * @param[in] at Address where to insert the elements into the vector
343 * @param[in] from Address to the first element to be inserted
344 * @param[in] to Address to the last element to be inserted
345 * @param[in] elementSize Size of one of the elements to be inserted
347 void Insert(uint8_t* at, uint8_t* from, uint8_t* to, SizeType elementSize)
349 const SizeType size = to - from;
350 const SizeType count = Count();
351 const SizeType newCount = count + size / elementSize;
353 if(newCount > Capacity())
355 // Calculate the at offset as the pointer is invalid after the Reserve() call.
356 std::size_t offset = at - reinterpret_cast<uint8_t*>(mData);
359 Reserve(NextPowerOfTwo(static_cast<uint32_t>(newCount)), elementSize); // reserve enough space to store at least the next power of two elements of the new required size.
361 // Set the new at pointer.
362 at = reinterpret_cast<uint8_t*>(mData) + offset;
364 // set new count first as otherwise the debug assert will hit us
367 // Move current items to a new position inside the vector.
368 CopyMemory(reinterpret_cast<char*>(at + size),
369 reinterpret_cast<const char*>(at),
370 (reinterpret_cast<uint8_t*>(mData) + count * elementSize) - at);
372 // Copy the given items.
373 CopyMemory(reinterpret_cast<char*>(at), reinterpret_cast<const char*>(from), size);
380 * @brief Vector algorithm variant for complex types.
382 * Not yet supported so will lead to compile error
383 * as constructor and destructor are private.
384 * TODO add support for this variant.
388 class VectorAlgorithms<false> : public VectorBase
391 VectorAlgorithms() = default;
392 ~VectorAlgorithms() = default;
397 * @brief Vector class with minimum space allocation when it's empty.
400 * @param type The type of the data that the vector holds
402 template<class T, bool IsTrivialType = TypeTraits<T>::IS_TRIVIAL_TYPE == true>
403 class Vector : public VectorAlgorithms<IsTrivialType>
407 * @brief Type definitions.
410 using SizeType = VectorBase::SizeType; ///< Size type @SINCE_1_0.0
411 using Iterator = T*; ///< Most simple Iterator is a pointer @SINCE_1_0.0
412 using ConstIterator = const T*; ///< Const iterator @SINCE_1_0.0
413 using ItemType = T; ///< Item type @SINCE_1_0.0
416 * @brief Enumeration for BaseType.
421 BaseType = IsTrivialType ///< @SINCE_1_0.0
425 * @brief Default constructor. Does not allocate any space.
431 * @brief Destructor. Releases the allocated space.
440 * @brief Copy constructor.
443 * @param[in] vector Vector to copy from
445 Vector(const Vector& vector)
447 // reuse copy assignment
452 * @brief Default move constructor.
455 * @param[in] vector Vector to move
457 Vector(Vector&& vector)
459 // reuse move assignment
460 operator=(std::move(vector));
464 * @brief Assignment operator.
467 * @param[in] vector Vector to assign from
468 * @return Reference to self for chaining
470 Vector& operator=(const Vector& vector)
474 VectorAlgorithms<BaseType>::Copy(vector, sizeof(ItemType));
480 * @brief Default move assignment operator.
483 * @param[in] vector Vector to move
485 Vector& operator=(Vector&& vector)
489 if(VectorBase::mData)
493 VectorBase::mData = vector.mData;
494 vector.mData = nullptr;
500 * @brief Iterator to the beginning of the data.
502 * @return Iterator to the beginning of the data
504 Iterator Begin() const
506 ItemType* address = reinterpret_cast<ItemType*>(VectorBase::mData);
511 * @brief Iterator to the end of the data (one past last element).
513 * @return Iterator to the end of the data (one past last element)
517 ItemType* address = reinterpret_cast<ItemType*>(VectorBase::mData);
518 address += VectorBase::Count();
523 * Support for C++11 Range-based for loop: for( item : container ).
525 * @return The start iterator
527 Iterator begin() const
533 * Support for C++11 Range-based for loop: for( item : container ).
535 * @return The end iterator
543 * @brief Subscript operator.
545 * @param[in] index Index of the element
546 * @return Reference to the element for given index
547 * @pre Index must be in the vector's range.
549 ItemType& operator[](SizeType index)
551 // reuse the const version
552 return const_cast<ItemType&>(const_cast<const Vector<ItemType>&>(*this)[index]);
556 * @brief Subscript operator.
558 * @param[in] index Index of the element
559 * @return Reference to the element for given index
560 * @pre Index must be in the vector's range.
562 const ItemType& operator[](SizeType index) const
564 DALI_ASSERT_VECTOR(VectorBase::mData && "Vector is empty");
565 DALI_ASSERT_VECTOR(index < VectorBase::Count() && "Index out of bounds");
566 ItemType* address = reinterpret_cast<ItemType*>(VectorBase::mData);
572 * @brief Pushes back an element to the vector.
574 * The underlying storage may be reallocated to provide space.
575 * If this occurs, all pre-existing pointers into the vector will
579 * @param[in] element Element to be added
581 void PushBack(const ItemType& element)
583 const SizeType count = VectorBase::Count();
584 const SizeType newCount = count + 1u;
585 const SizeType capacity = VectorBase::Capacity();
586 if(newCount > capacity)
589 Reserve(newCount << 1u); // reserve double the current count
591 // set new count first as otherwise the debug assert will hit us
592 VectorBase::SetCount(newCount);
593 operator[](count) = element;
597 * @brief Inserts an element to the vector.
599 * Elements after \e at are moved one position to the right.
601 * The underlying storage may be reallocated to provide space.
602 * If this occurs, all pre-existing pointers into the vector will
606 * @param[in] at Iterator where to insert the elements into the vector
607 * @param[in] element An element to be added
608 * @pre Iterator at must be in the vector's range ( Vector::Begin(), Vector::End() ).
610 void Insert(Iterator at, const ItemType& element)
612 DALI_ASSERT_VECTOR((at <= End()) && (at >= Begin()) && "Iterator not inside vector");
613 const SizeType size = sizeof(ItemType);
614 uint8_t* address = const_cast<uint8_t*>(reinterpret_cast<const uint8_t*>(&element));
615 VectorAlgorithms<BaseType>::Insert(reinterpret_cast<uint8_t*>(at),
622 * @brief Inserts the given elements into the vector.
624 * Elements after \e at are moved the number of given elements positions to the right.
626 * The underlying storage may be reallocated to provide space.
627 * If this occurs, all pre-existing pointers into the vector will
631 * @param[in] at Iterator where to insert the elements into the vector
632 * @param[in] from Iterator to the first element to be inserted
633 * @param[in] to Iterator to the last element to be inserted
634 * @pre Iterator \e at must be in the vector's range ( Vector::Begin(), Vector::End() ).
635 * @pre Iterators \e from and \e to must be valid iterators.
636 * @pre Iterator \e from must not be grater than Iterator \e to.
639 void Insert(Iterator at, Iterator from, Iterator to)
641 DALI_ASSERT_VECTOR((at <= End()) && (at >= Begin()) && "Iterator not inside vector");
642 DALI_ASSERT_VECTOR((from <= to) && "from address can't be greater than to");
650 VectorAlgorithms<BaseType>::Insert(reinterpret_cast<uint8_t*>(at),
651 reinterpret_cast<uint8_t*>(from),
652 reinterpret_cast<uint8_t*>(to),
657 * @brief Reserves space in the vector.
659 * Reserving less than current Capacity is a no-op.
661 * @param[in] count Count of elements to reserve
663 void Reserve(SizeType count)
665 VectorAlgorithms<BaseType>::Reserve(count, sizeof(ItemType));
669 * @brief Resizes the vector. Does not change capacity.
672 * @param[in] count Count to resize to
674 void Resize(SizeType count)
676 ItemType item = ItemType();
681 * @brief Resizes the vector without initializing the data.
683 * Can be used as a data container for reading whole file content.
685 * @param[in] count Count to resize to
687 void ResizeUninitialized(SizeType count)
690 VectorBase::SetCount(count);
694 * @brief Resizes the vector. Does not change capacity.
697 * @param[in] count Count to resize to
698 * @param[in] item An item to insert to the new indices
700 void Resize(SizeType count, const ItemType& item)
702 const SizeType oldCount = VectorBase::Count();
703 if(count <= oldCount)
705 // getting smaller so just set count
706 VectorBase::SetCount(count);
710 // remember how many new items get added
711 SizeType newItems = count - oldCount;
713 for(; newItems > 0u; --newItems)
721 * @brief Erases an element.
723 * Does not change capacity. Other elements get moved.
726 * @param[in] iterator Iterator pointing to the item to remove
727 * @return Iterator pointing to next element
728 * @pre Iterator \e iterator must be within the vector's range ( Vector::Begin(), Vector::End() - 1 ).
731 Iterator Erase(Iterator iterator)
733 DALI_ASSERT_VECTOR((iterator < End()) && (iterator >= Begin()) && "Iterator not inside vector");
734 if(iterator < (End() - 1u))
736 VectorAlgorithms<BaseType>::Erase(reinterpret_cast<uint8_t*>(iterator), sizeof(ItemType));
740 // just remove the element
747 * @brief Erases a range of elements.
749 * Does not change capacity. Other elements get moved.
752 * @param[in] first Iterator to the first element to be erased
753 * @param[in] last Iterator to the last element to be erased
755 * @return Iterator pointing to the next element of the last one
756 * @pre Iterator \e first must be in the vector's range ( Vector::Begin(), Vector::End() ).
757 * @pre Iterator \e last must be in the vector's range ( Vector::Begin(), Vector::End() ).
758 * @pre Iterator \e first must not be grater than Iterator \e last.
761 Iterator Erase(Iterator first, Iterator last)
763 DALI_ASSERT_VECTOR((first <= End()) && (first >= Begin()) && "Iterator not inside vector");
764 DALI_ASSERT_VECTOR((last <= End()) && (last >= Begin()) && "Iterator not inside vector");
765 DALI_ASSERT_VECTOR((first <= last) && "first iterator greater than last");
767 Iterator nextElement;
771 // Erase up to the end.
772 VectorBase::SetCount(VectorBase::Count() - (last - first));
777 nextElement = reinterpret_cast<Iterator>(VectorAlgorithms<BaseType>::Erase(reinterpret_cast<uint8_t*>(first),
778 reinterpret_cast<uint8_t*>(last),
786 * @brief Removes an element.
788 * Does not maintain order. Swaps the element with end and
789 * decreases size by one. This is much faster than Erase so use
790 * this in case order does not matter. Does not change capacity.
793 * @param[in] iterator Iterator pointing to the item to remove
794 * @pre Iterator \e iterator must be in the vector's range ( Vector::Begin(), Vector::End() - 1 ).
797 void Remove(Iterator iterator)
799 DALI_ASSERT_VECTOR((iterator < End()) && (iterator >= Begin()) && "Iterator not inside vector");
801 Iterator last = End() - 1u;
804 std::swap(*iterator, *last);
806 VectorBase::SetCount(VectorBase::Count() - 1u);
810 * @brief Swaps the contents of two vectors.
813 * @param[in] vector Vector to swap with
815 void Swap(Vector& vector)
817 VectorBase::Swap(vector);
821 * @brief Clears the contents of the vector. Keeps its capacity.
826 VectorAlgorithms<BaseType>::Clear();
830 * @brief Releases the memory that the vector holds.
835 VectorAlgorithms<BaseType>::Release();
840 * @brief Erases all elements that compare equal to value from the vector.
843 * @param[in] vector The vector
844 * @param[in] value The value to be removed.
846 template <class T, class U>
847 inline void Erase(Dali::Vector<T>& vector, const U& value)
849 auto begin = vector.Begin();
850 auto end = vector.End();
852 vector.Erase(std::remove(begin, end, value), end);
856 * @brief Erases all elements that satisfy the predicate from the vector.
859 * @param[in] vector The vector
860 * @param[in] predicate The predicate
862 template <class T, class Predicate>
863 inline void EraseIf(Dali::Vector<T>& vector, Predicate predicate)
865 auto begin = vector.Begin();
866 auto end = vector.End();
868 vector.Erase(std::remove_if(begin, end, predicate), end);
876 #endif // DALI_VECTOR_H