Allocated Array. More...
#include <AllocatedArray.hpp>
Public Types | |
using | size_type = std::size_t |
Size type. More... | |
using | value_type = T |
Value type. More... | |
using | const_value_type = const value_type |
Constant value type. More... | |
using | reference = value_type & |
Reference type. More... | |
using | const_reference = const value_type & |
Constant reference type. More... | |
using | pointer = value_type * |
Pointer type. More... | |
using | const_pointer = const value_type * |
Constant pointer type. More... | |
using | difference_type = std::ptrdiff_t |
Difference type. More... | |
using | deleter_type = Deleter |
Deleter type. More... | |
using | iterator = pointer |
Iterator alias. More... | |
using | const_iterator = const_pointer |
Constant iterator alias. More... | |
Public Member Functions | |
PLAYRHO_CONSTEXPR | AllocatedArray (size_type max_size, pointer data, deleter_type deleter=noop_deleter) |
Initializing constructor. More... | |
~AllocatedArray () noexcept | |
Destructor. More... | |
AllocatedArray ()=delete | |
AllocatedArray (const AllocatedArray ©)=delete | |
AllocatedArray (AllocatedArray &&other) noexcept | |
Move constructor. More... | |
size_type | size () const noexcept |
Gets the current size of this array. More... | |
size_type | max_size () const noexcept |
Gets the maximum size this array can possibly get to. More... | |
bool | empty () const noexcept |
Determines whether this array is empty. More... | |
pointer | data () const noexcept |
Gets a direct pointer to this array's memory. More... | |
reference | operator[] (size_type i) |
Indexed operator. More... | |
const_reference | operator[] (size_type i) const |
Indexed operator. More... | |
iterator | begin () |
Gets the "begin" iterator value for this array. More... | |
iterator | end () |
Gets the "end" iterator value for this array. More... | |
const_iterator | begin () const |
Gets the "begin" iterator value for this array. More... | |
const_iterator | end () const |
Gets the "end" iterator value for this array. More... | |
const_iterator | cbegin () const |
Gets the "begin" iterator value for this array. More... | |
const_iterator | cend () const |
Gets the "end" iterator value for this array. More... | |
reference | back () noexcept |
Gets a reference to the "back" element of this array. More... | |
const_reference | back () const noexcept |
Gets a reference to the "back" element of this array. More... | |
void | clear () noexcept |
Clears this array. More... | |
void | push_back (const_reference value) |
Push "back" the given value. More... | |
void | pop_back () noexcept |
Pop "back". More... | |
Detailed Description
template<typename T, typename Deleter = std::function<void (void *)>>
class playrho::AllocatedArray< T, Deleter >
Allocated Array.
Definition at line 32 of file AllocatedArray.hpp.
Member Typedef Documentation
◆ size_type
using playrho::AllocatedArray< T, Deleter >::size_type = std::size_t |
Size type.
Definition at line 37 of file AllocatedArray.hpp.
◆ value_type
using playrho::AllocatedArray< T, Deleter >::value_type = T |
Value type.
Definition at line 40 of file AllocatedArray.hpp.
◆ const_value_type
using playrho::AllocatedArray< T, Deleter >::const_value_type = const value_type |
Constant value type.
Definition at line 43 of file AllocatedArray.hpp.
◆ reference
using playrho::AllocatedArray< T, Deleter >::reference = value_type& |
Reference type.
Definition at line 46 of file AllocatedArray.hpp.
◆ const_reference
using playrho::AllocatedArray< T, Deleter >::const_reference = const value_type& |
Constant reference type.
Definition at line 49 of file AllocatedArray.hpp.
◆ pointer
using playrho::AllocatedArray< T, Deleter >::pointer = value_type* |
Pointer type.
Definition at line 52 of file AllocatedArray.hpp.
◆ const_pointer
using playrho::AllocatedArray< T, Deleter >::const_pointer = const value_type* |
Constant pointer type.
Definition at line 55 of file AllocatedArray.hpp.
◆ difference_type
using playrho::AllocatedArray< T, Deleter >::difference_type = std::ptrdiff_t |
Difference type.
Definition at line 58 of file AllocatedArray.hpp.
◆ deleter_type
using playrho::AllocatedArray< T, Deleter >::deleter_type = Deleter |
Deleter type.
Definition at line 61 of file AllocatedArray.hpp.
◆ iterator
using playrho::AllocatedArray< T, Deleter >::iterator = pointer |
Iterator alias.
Definition at line 64 of file AllocatedArray.hpp.
◆ const_iterator
using playrho::AllocatedArray< T, Deleter >::const_iterator = const_pointer |
Constant iterator alias.
Definition at line 67 of file AllocatedArray.hpp.
Constructor & Destructor Documentation
◆ AllocatedArray() [1/4]
|
inline |
Initializing constructor.
Definition at line 70 of file AllocatedArray.hpp.
◆ ~AllocatedArray()
|
inlinenoexcept |
Destructor.
Definition at line 77 of file AllocatedArray.hpp.
◆ AllocatedArray() [2/4]
|
delete |
◆ AllocatedArray() [3/4]
|
delete |
◆ AllocatedArray() [4/4]
|
inlinenoexcept |
Move constructor.
Definition at line 87 of file AllocatedArray.hpp.
Member Function Documentation
◆ size()
|
inlinenoexcept |
Gets the current size of this array.
Definition at line 95 of file AllocatedArray.hpp.
◆ max_size()
|
inlinenoexcept |
Gets the maximum size this array can possibly get to.
Definition at line 98 of file AllocatedArray.hpp.
◆ empty()
|
inlinenoexcept |
Determines whether this array is empty.
Definition at line 101 of file AllocatedArray.hpp.
◆ data()
|
inlinenoexcept |
Gets a direct pointer to this array's memory.
Definition at line 104 of file AllocatedArray.hpp.
◆ operator[]() [1/2]
|
inline |
Indexed operator.
Definition at line 107 of file AllocatedArray.hpp.
◆ operator[]() [2/2]
|
inline |
Indexed operator.
Definition at line 114 of file AllocatedArray.hpp.
◆ begin() [1/2]
|
inline |
Gets the "begin" iterator value for this array.
Definition at line 121 of file AllocatedArray.hpp.
◆ end() [1/2]
|
inline |
Gets the "end" iterator value for this array.
Definition at line 124 of file AllocatedArray.hpp.
◆ begin() [2/2]
|
inline |
Gets the "begin" iterator value for this array.
Definition at line 127 of file AllocatedArray.hpp.
◆ end() [2/2]
|
inline |
Gets the "end" iterator value for this array.
Definition at line 130 of file AllocatedArray.hpp.
◆ cbegin()
|
inline |
Gets the "begin" iterator value for this array.
Definition at line 133 of file AllocatedArray.hpp.
◆ cend()
|
inline |
Gets the "end" iterator value for this array.
Definition at line 136 of file AllocatedArray.hpp.
◆ back() [1/2]
|
inlinenoexcept |
Gets a reference to the "back" element of this array.
- Warning
- Behavior is undefined if the size of this array is less than 1.
Definition at line 140 of file AllocatedArray.hpp.
◆ back() [2/2]
|
inlinenoexcept |
Gets a reference to the "back" element of this array.
- Warning
- Behavior is undefined if the size of this array is less than 1.
Definition at line 148 of file AllocatedArray.hpp.
◆ clear()
|
inlinenoexcept |
Clears this array.
Definition at line 155 of file AllocatedArray.hpp.
◆ push_back()
|
inline |
Push "back" the given value.
Definition at line 161 of file AllocatedArray.hpp.
◆ pop_back()
|
inlinenoexcept |
Pop "back".
Definition at line 169 of file AllocatedArray.hpp.
The documentation for this class was generated from the following file:
- Common/AllocatedArray.hpp