1 #ifndef __DALI_VECTOR_H__
2 #define __DALI_VECTOR_H__
5 * Copyright (c) 2015 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.
26 #include <dali/public-api/common/dali-common.h>
27 #include <dali/public-api/common/type-traits.h>
28 #include <dali/public-api/math/math-utils.h>
31 * @brief For DALi internal use asserts are enabled in debug builds.
33 * For Application use asserts can be enabled manually.
36 #if defined( DEBUG_ENABLED )
37 #define ENABLE_VECTOR_ASSERTS
40 #if defined( ENABLE_VECTOR_ASSERTS )
41 #define DALI_ASSERT_VECTOR(cond) DALI_ASSERT_ALWAYS(cond)
43 #define DALI_ASSERT_VECTOR(cond)
49 * @addtogroup dali_core_common
54 * @brief Base class to handle the memory of simple vector.
56 * Memory layout is such that it has two std::size_t to hold the count
57 * and capacity of the vector. VectorBase::mData is adjusted so that it points to the
58 * beginning of the first real item so that iterating the items is quick.
61 class DALI_IMPORT_API VectorBase
65 typedef std::size_t SizeType;
67 protected: // Construction
70 * @brief Default constructor. Does not allocate space.
78 * Does not release the space. Derived class needs to call Release.
79 * Not virtual as should not be called directly and we do not want
80 * a vtable for this class as it would unnecessarily increase size.
88 * @brief This method is inlined as its needed frequently for Vector::End() iterator.
91 * @return The count of elements in this vector.
93 SizeType Count() const
98 SizeType* metadata = reinterpret_cast< SizeType* >( mData );
99 items = *(metadata - 1u);
105 * @brief Gets the count of elements in this vector.
107 * @return The count of elements in this vector.
109 SizeType Size() const
115 * @brief @ return If the vector is empty
120 return Count() == 0u;
124 * @brief Gets the capacity of this vector.
126 * @return The capacity of this vector.
128 SizeType Capacity() const;
131 * @brief Release the data.
133 * Does not call destructors on objects held.
138 protected: // for Derived classes
141 * @brief Helper to set the count.
144 * @param[in] count Number of elements in the vector.
146 void SetCount( SizeType count );
149 * @brief Reserve space in the vector.
152 * @param[in] count Count of elements to reserve.
153 * @param[in] elementSize Size of a single element.
155 void Reserve( SizeType count, SizeType elementSize );
158 * @brief Copy a vector.
161 * @param[in] vector Vector to copy from.
162 * @param[in] elementSize Size of a single element.
164 void Copy( const VectorBase& vector, SizeType elementSize );
167 * @brief Swap the contents of two vectors.
170 * @param[in] vector Vector to swap with.
172 void Swap( VectorBase& vector );
175 * @brief Erase an element.
177 * Does not change capacity.
179 * @param[in] address Adress to erase from.
180 * @param[in] elementSize Size to erase.
181 * @pre Last element cannot be erased as there is nothing to move.
183 void Erase( char* address, SizeType elementSize );
186 * @brief Erase a range of elements.
188 * Does not change capacity.
190 * @param[in] first Address to the first element to be erased.
191 * @param[in] last Address to the last element to be erased.
192 * @param[in] elementSize Size of one of the elements to be erased.
193 * @return Address pointing to the next element of the last one.
195 char* Erase( char* first, char* last, SizeType elementSize );
198 * @brief Copies a number of bytes from \e source to \e destination.
200 * \e source and \e destination must not overlap.
203 * @param[in] destination Pointer to the destination address.
204 * @param[in] source Pointer to the source address.
205 * @param[in] numberOfBytes The number of bytes to be copied.
207 void CopyMemory( char* destination, const char* source, size_t numberOfBytes );
211 // not copiable as it does not know the size of elements
212 VectorBase( const VectorBase& ); ///< Undefined @SINCE_1_0.0
213 VectorBase& operator=( const VectorBase& ); ///< Undefined @SINCE_1_0.0
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
232 typedef VectorBase::SizeType SizeType;
235 * @brief Empty constructor.
242 * @brief Empty destructor.
249 * @brief Copy vector contents.
252 * @param[in] rhs VectorBase object to copy from.
253 * @param[in] elementSize Size of the content.
255 void Copy( const VectorBase& rhs, SizeType elementSize )
257 if( rhs.Capacity() > 0u )
259 VectorBase::Copy( rhs, elementSize );
263 VectorBase::Release();
268 * @brief Reserve space in the vector.
271 * @param[in] count Count of elements to reserve.
272 * @param[in] elementSize Size of a single element.
274 void Reserve( SizeType count, SizeType elementSize )
276 VectorBase::Reserve( count, elementSize );
280 * @brief Resize the vector. Does not change capacity.
283 * @param[in] count Count to resize to.
284 * @param[in] elementSize Size of a single element.
286 void Resize( SizeType count, SizeType elementSize )
288 // reserve will copy old elements as well
289 Reserve( count, elementSize );
293 * @brief Clear the contents.
295 * For simple types nothing to do.
302 VectorBase::SetCount( 0u );
307 * @brief Release the vector.
312 VectorBase::Release();
316 * @brief Erase an element. Does not change capacity.
319 * @param[in] address Address to erase from.
320 * @param[in] elementSize Size to erase.
322 void Erase( char* address, SizeType elementSize )
324 VectorBase::Erase( address, elementSize );
328 * @brief Erase a range of elements. Does not change capacity.
331 * @param[in] first Address to the first element to be erased.
332 * @param[in] last Address to the last element to be erased.
333 * @param[in] elementSize Size of one of the elements to be erased.
334 * @return Address pointing to the next element of the last one.
336 char* Erase( char* first, char* last, SizeType elementSize )
338 return VectorBase::Erase( first, last, elementSize );
342 * @brief Inserts the given elements into the vector.
345 * @param[in] at Address where to insert the elements into the vector.
346 * @param[in] from Address to the first element to be inserted.
347 * @param[in] to Address to the last element to be inserted.
348 * @param[in] elementSize Size of one of the elements to be inserted.
350 void Insert( char* at, char* from, char* to, SizeType elementSize )
352 const SizeType size = to - from;
353 const SizeType count = Count();
354 const SizeType newCount = count + size / elementSize;
356 if( newCount > Capacity() )
358 // Calculate the at offset as the pointer is invalid after the Reserve() call.
359 std::size_t offset = at - reinterpret_cast<char*>( mData );
362 Reserve( NextPowerOfTwo( newCount ), elementSize ); // reserve enough space to store at least the next power of two elements of the new required size.
364 // Set the new at pointer.
365 at = reinterpret_cast<char*>( mData ) + offset;
367 // set new count first as otherwise the debug assert will hit us
368 SetCount( newCount );
370 // Move current items to a new position inside the vector.
371 CopyMemory( at + size,
373 ( reinterpret_cast<char*>( mData ) + count * elementSize ) - at );
375 // Copy the given items.
376 CopyMemory( at, from, size );
381 * @brief Vector algorithm variant for complex types.
383 * Not yet supported so will lead to compile error
384 * as constructor and destructor are private.
385 * TODO add support for this variant.
389 class VectorAlgorithms< false > : public VectorBase
399 * @brief Vector class with minimum space allocation when its empty.
402 * @param type of the data that the vector holds.
404 template< class T, bool IsTrivialType = TypeTraits<T>::IS_TRIVIAL_TYPE == true >
405 class Vector : public VectorAlgorithms< IsTrivialType >
410 * @brief Type definitions.
413 typedef VectorBase::SizeType SizeType; ///< Size type @SINCE_1_0.0
414 typedef T* Iterator; ///< Most simple Iterator is a pointer @SINCE_1_0.0
415 typedef const T* ConstIterator; ///< Const iterator @SINCE_1_0.0
416 typedef T ItemType; ///< Item type @SINCE_1_0.0
420 BaseType = IsTrivialType
424 * @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 )
452 * @brief Assignment operator.
455 * @param[in] vector Vector to assign from.
456 * @return Reference to self for chaining.
458 Vector& operator=( const Vector& vector )
460 if( this != &vector )
462 VectorAlgorithms<BaseType>::Copy( vector, sizeof( ItemType ) );
468 * @brief Iterator to the beginning of the data.
470 * @return Iterator to the beginning of the data.
472 Iterator Begin() const
474 ItemType* address = reinterpret_cast<ItemType*>( VectorBase::mData );
479 * @brief Iterator to the end of the data (one past last element).
481 * @return Iterator to the end of the data (one past last element).
485 ItemType* address = reinterpret_cast<ItemType*>( VectorBase::mData );
486 address += VectorBase::Count();
491 * @brief Subscript operator.
493 * @param[in] index Index of the element.
494 * @return Reference to the element for given index.
495 * @pre Index must be in the vector's range.
497 ItemType& operator[]( SizeType index )
499 // reuse the const version
500 return const_cast< ItemType& >( const_cast< const Vector< ItemType >& >( *this )[ index ] );
504 * @brief Subscript operator.
506 * @param[in] index of the element.
507 * @return reference to the element for given index.
508 * @pre index must be in the vector's range.
510 const ItemType& operator[]( SizeType index ) const
512 DALI_ASSERT_VECTOR( VectorBase::mData && "Vector is empty" );
513 DALI_ASSERT_VECTOR( index < VectorBase::Count() && "Index out of bounds" );
514 ItemType* address = reinterpret_cast<ItemType*>( VectorBase::mData );
520 * @brief Push back an element to the vector.
522 * The underlying storage may be reallocated to provide space.
523 * If this occurs, all pre-existing pointers into the vector will
527 * @param[in] element Element to be added.
529 void PushBack( const ItemType& element )
531 const SizeType count = VectorBase::Count();
532 const SizeType newCount = count + 1u;
533 const SizeType capacity = VectorBase::Capacity();
534 if( newCount > capacity )
537 Reserve( newCount << 1u ); // reserve double the current count
539 // set new count first as otherwise the debug assert will hit us
540 VectorBase::SetCount( newCount );
541 operator[]( count ) = element;
545 *@brief Insert an element to the vector.
547 * Elements after \e at are moved one position to the right.
549 * The underlying storage may be reallocated to provide space.
550 * If this occurs, all pre-existing pointers into the vector will
553 * @pre Iterator at must be in the vector's range ( Vector::Begin(), Vector::End() ).
555 * @param[in] at Iterator where to insert the elements into the vector.
556 * @param[in] element An element to be added.
559 void Insert( Iterator at, const ItemType& element )
561 DALI_ASSERT_VECTOR( ( at <= End() ) && ( at >= Begin() ) && "Iterator not inside vector" );
562 const SizeType size = sizeof( ItemType );
563 char* address = const_cast<char*>( reinterpret_cast<const char*>( &element ) );
564 VectorAlgorithms<BaseType>::Insert( reinterpret_cast< char* >( at ),
571 * @brief Inserts the given elements into the vector.
573 * Elements after \e at are moved the number of given elements positions to the right.
575 * The underlying storage may be reallocated to provide space.
576 * If this occurs, all pre-existing pointers into the vector will
580 * @param[in] at Iterator where to insert the elements into the vector.
581 * @param[in] from Iterator to the first element to be inserted.
582 * @param[in] to Iterator to the last element to be inserted.
583 * @pre Iterator \e at must be in the vector's range ( Vector::Begin(), Vector::End() ).
584 * @pre Iterators \e from and \e to must be valid iterators.
585 * @pre Iterator \e from must not be grater than Iterator \e to.
588 void Insert( Iterator at, Iterator from, Iterator to )
590 DALI_ASSERT_VECTOR( ( at <= End() ) && ( at >= Begin() ) && "Iterator not inside vector" );
591 DALI_ASSERT_VECTOR( ( from <= to ) && "from address can't be greater than to" );
599 VectorAlgorithms<BaseType>::Insert( reinterpret_cast< char* >( at ),
600 reinterpret_cast< char* >( from ),
601 reinterpret_cast< char* >( to ),
602 sizeof( ItemType ) );
606 * @brief Reserve space in the vector.
608 * Reserving less than current Capacity is a no-op.
610 * @param[in] count Count of elements to reserve.
612 void Reserve( SizeType count )
614 VectorAlgorithms<BaseType>::Reserve( count, sizeof( ItemType ) );
618 * @brief Resize the vector. Does not change capacity.
621 * @param[in] count Count to resize to.
623 void Resize( SizeType count )
625 ItemType item = ItemType();
630 * @brief Resize the vector. Does not change capacity.
633 * @param[in] count Count to resize to.
634 * @param[in] item An item to insert to the new indices.
636 void Resize( SizeType count, const ItemType& item )
638 const SizeType oldCount = VectorBase::Count();
639 if( count <= oldCount )
641 // getting smaller so just set count
642 VectorBase::SetCount( count );
646 // remember how many new items get added
647 SizeType newItems = count - oldCount;
649 for( ; newItems > 0u; --newItems )
657 * @brief Erase an element.
659 * Does not change capacity. Other elements get moved.
662 * @param[in] iterator Iterator pointing to item to remove.
663 * @return Iterator pointing to next element.
664 * @pre Iterator \e iterator must be within the vector's range ( Vector::Begin(), Vector::End() - 1 ).
667 Iterator Erase( Iterator iterator )
669 DALI_ASSERT_VECTOR( (iterator < End()) && (iterator >= Begin()) && "Iterator not inside vector" );
670 if( iterator < ( End() - 1u ) )
672 VectorAlgorithms<BaseType>::Erase( reinterpret_cast< char* >( iterator ), sizeof( ItemType ) );
676 // just remove the element
683 * @brief Erase a range of elements.
685 * Does not change capacity. Other elements get moved.
688 * @param[in] first Iterator to the first element to be erased.
689 * @param[in] last Iterator to the last element to be erased.
691 * @return Iterator pointing to the next element of the last one.
692 * @pre Iterator \e first must be in the vector's range ( Vector::Begin(), Vector::End() ).
693 * @pre Iterator \e last must be in the vector's range ( Vector::Begin(), Vector::End() ).
694 * @pre Iterator \e first must not be grater than Iterator \e last.
697 Iterator Erase( Iterator first, Iterator last )
699 DALI_ASSERT_VECTOR( ( first <= End() ) && ( first >= Begin() ) && "Iterator not inside vector" );
700 DALI_ASSERT_VECTOR( ( last <= End() ) && ( last >= Begin() ) && "Iterator not inside vector" );
701 DALI_ASSERT_VECTOR( ( first <= last ) && "first iterator greater than last" );
703 Iterator nextElement;
707 // Erase up to the end.
708 VectorBase::SetCount( VectorBase::Count() - ( last - first ) );
713 nextElement = reinterpret_cast<Iterator>( VectorAlgorithms<BaseType>::Erase( reinterpret_cast< char* >( first ),
714 reinterpret_cast< char* >( last ),
715 sizeof( ItemType ) ) );
722 * @brief Removes an element.
724 * Does not maintain order. Swaps the element with end and
725 * decreases size by one. This is much faster than Erase so use
726 * this in case order does not matter. Does not change capacity.
729 * @param[in] iterator Iterator pointing to item to remove.
730 * @pre Iterator \e iterator must be in the vector's range ( Vector::Begin(), Vector::End() - 1 ).
733 void Remove( Iterator iterator )
735 DALI_ASSERT_VECTOR( (iterator < End()) && (iterator >= Begin()) && "Iterator not inside vector" );
737 Iterator last = End() - 1u;
738 if( last > iterator )
740 std::swap( *iterator, *last );
742 VectorBase::SetCount( VectorBase::Count() - 1u );
746 * @brief Swap the contents of two vectors.
749 * @param[in] vector Vector to swap with.
751 void Swap( Vector& vector )
753 VectorBase::Swap( vector );
757 * @brief Clear the contents of the vector. Keeps its capacity.
762 VectorAlgorithms<BaseType>::Clear();
766 * @brief Release the memory that the vector holds.
771 VectorAlgorithms<BaseType>::Release();
780 #endif /* __DALI_VECTOR_H__ */