AVRCpp::Collection::DynamicArray< DataType, SizeType, array_capacity, reserve_size, block_size > Class Template Reference

#include <DynamicArray.h>

Inherits AVRCpp::Collection::BaseArray< DataType, SizeType, DataType * >.

List of all members.

Public Member Functions
	DynamicArray ()
	Constructor.
	~DynamicArray ()
	Destructor.
bool	Resize (const SizeType size, const DataType &values=DataType())
	Resize array to certain length.
bool	Add (const DataType &value)
	Add item to the end of array.
bool	Insert (const DataType &value, const SizeType pos)
	Insert item to the pos.
bool	Remove (const SizeType pos)
	Remove item at pos.
bool	Clear ()
	Clear array.
SizeType	GetCapacity (void)
	Return array capacity.
bool	IsFull (void)
	Return whether the array is in full capacity or not.
SizeType	GetSize (void)
	Return array size.
bool	IsEmpty (void)
	Return whether the array is empty or not.
DataType &	At (SizeTypepos)
	Return reference of item at specified position NB! For speed purposes does not check constraints!
Protected Member Functions
bool	Realloc (SizeType size)
	Try resize the array.
Protected Attributes
SizeType	allocated_size
DataType *	data
SizeType	current_size

---

Detailed Description

template<typename DataType, typename SizeType, SizeType array_capacity = (1 << (sizeof(SizeType) << 3)) - 1, SizeType reserve_size = 8, SizeType block_size = 8>
class AVRCpp::Collection::DynamicArray< DataType, SizeType, array_capacity, reserve_size, block_size >

Definition at line 63 of file DynamicArray.h.

---

Constructor & Destructor Documentation

template<typename DataType, typename SizeType, SizeType array_capacity = (1 << (sizeof(SizeType) << 3)) - 1, SizeType reserve_size = 8, SizeType block_size = 8>

AVRCpp::Collection::DynamicArray< DataType, SizeType, array_capacity, reserve_size, block_size >::DynamicArray

(

)

[inline]

Constructor.

Definition at line 96 of file DynamicArray.h.

                {
                        BaseArray<DataType, SizeType, DataType*>();

                        this->data                              = (DataType *) malloc(reserve_size);
                        this->allocated_size    = 0;
                }

template<typename DataType, typename SizeType, SizeType array_capacity = (1 << (sizeof(SizeType) << 3)) - 1, SizeType reserve_size = 8, SizeType block_size = 8>

AVRCpp::Collection::DynamicArray< DataType, SizeType, array_capacity, reserve_size, block_size >::~DynamicArray

(

)

[inline]

Destructor.

Definition at line 107 of file DynamicArray.h.

                {
                        free(this->data);
                }

---

Member Function Documentation

template<typename DataType, typename SizeType, SizeType array_capacity = (1 << (sizeof(SizeType) << 3)) - 1, SizeType reserve_size = 8, SizeType block_size = 8>

bool AVRCpp::Collection::DynamicArray< DataType, SizeType, array_capacity, reserve_size, block_size >::Realloc

(

SizeType

size

)

[inline, protected]

Try resize the array.

Definition at line 71 of file DynamicArray.h.

                {
                        // Don't allow smaller allocation than reserve size
                        if (size < reserve_size) size = reserve_size;

                        // If current allocation equals new size then skip
                        if (this->allocated_size == size) return true;

                        // Try reallocate
                        DataType *newData = (DataType *) realloc(this->data, sizeof(DataType) * size);
                        if (newData)
                        {
                                this->data = newData;
                                this->allocated_size = size;
                                return true;
                        }
                        
                        return false;
                }

template<typename DataType, typename SizeType, SizeType array_capacity = (1 << (sizeof(SizeType) << 3)) - 1, SizeType reserve_size = 8, SizeType block_size = 8>

bool AVRCpp::Collection::DynamicArray< DataType, SizeType, array_capacity, reserve_size, block_size >::Resize	(	const SizeType	size,
		const DataType &	values = DataType()
	)			[inline]

Resize array to certain length.

Reimplemented from AVRCpp::Collection::BaseArray< DataType, SizeType, DataType * >.

Definition at line 115 of file DynamicArray.h.

                {
                        // If new size is larger than maximum capacity then abort
                        if (size >= array_capacity) return false;

                        if (!this->Realloc(size)) return false;

                        return BaseArray<DataType, SizeType, DataType*>::Resize(size, values);
                }

template<typename DataType, typename SizeType, SizeType array_capacity = (1 << (sizeof(SizeType) << 3)) - 1, SizeType reserve_size = 8, SizeType block_size = 8>

bool AVRCpp::Collection::DynamicArray< DataType, SizeType, array_capacity, reserve_size, block_size >::Add

(

const DataType &

value

)

[inline]

Add item to the end of array.

Reimplemented from AVRCpp::Collection::BaseArray< DataType, SizeType, DataType * >.

Definition at line 128 of file DynamicArray.h.

                {
                        // If new size is larger than maximum capacity then abort
                        if (this->current_size >= array_capacity) return false;

                        // If new size is larger than allocated size then increase memory size by one block
                        if (this->current_size >= this->allocated_size)
                        {
                                if (!this->Realloc(this->current_size + block_size)) return false;
                        }

                        return BaseArray<DataType, SizeType, DataType*>::Add(value);
                }

template<typename DataType, typename SizeType, SizeType array_capacity = (1 << (sizeof(SizeType) << 3)) - 1, SizeType reserve_size = 8, SizeType block_size = 8>

bool AVRCpp::Collection::DynamicArray< DataType, SizeType, array_capacity, reserve_size, block_size >::Insert	(	const DataType &	value,
		const SizeType	pos
	)			[inline]

Insert item to the pos.

Reimplemented from AVRCpp::Collection::BaseArray< DataType, SizeType, DataType * >.

Definition at line 145 of file DynamicArray.h.

                {
                        // If new size is larger than maximum then abort
                        if (this->current_size >= array_capacity) return false;

                        // Check constraints
                        if (pos > this->current_size) return false;

                        // If new size is larger than allocated size then increase memory size by one block
                        if (this->current_size >= this->allocated_size)
                        {
                                if (!this->Realloc(this->current_size + block_size)) return false;
                        }

                        return BaseArray<DataType, SizeType, DataType*>::Insert(value, pos);
                }

template<typename DataType, typename SizeType, SizeType array_capacity = (1 << (sizeof(SizeType) << 3)) - 1, SizeType reserve_size = 8, SizeType block_size = 8>

bool AVRCpp::Collection::DynamicArray< DataType, SizeType, array_capacity, reserve_size, block_size >::Remove

(

const SizeType

pos

)

[inline]

Remove item at pos.

Reimplemented from AVRCpp::Collection::BaseArray< DataType, SizeType, DataType * >.

Definition at line 165 of file DynamicArray.h.

                {
                        if (!BaseArray<DataType, SizeType, DataType*>::Remove(pos)) return false;
                        
                        // If current size is one block size smaller than allocated size then decrease memory size
                        if (this->current_size <= this->allocated_size - block_size)
                        {
                                // No matter the realloc succeeds or not, fictios size will still be smaller
                                this->Realloc(this->allocated_size - block_size);
                        }

                        return true;
                }

template<typename DataType, typename SizeType, SizeType array_capacity = (1 << (sizeof(SizeType) << 3)) - 1, SizeType reserve_size = 8, SizeType block_size = 8>

bool AVRCpp::Collection::DynamicArray< DataType, SizeType, array_capacity, reserve_size, block_size >::Clear

(

)

[inline]

Clear array.

Reimplemented from AVRCpp::Collection::BaseArray< DataType, SizeType, DataType * >.

Definition at line 182 of file DynamicArray.h.

                {
                        if (!BaseArray<DataType, SizeType, DataType*>::Clear()) return false;
                        
                        // No matter the realloc succeeds or not, fictios size will still be 0
                        this->Realloc(0);

                        return true;
                }

template<typename DataType, typename SizeType, SizeType array_capacity = (1 << (sizeof(SizeType) << 3)) - 1, SizeType reserve_size = 8, SizeType block_size = 8>

SizeType AVRCpp::Collection::DynamicArray< DataType, SizeType, array_capacity, reserve_size, block_size >::GetCapacity

(

void

)

[inline]

Return array capacity.

Definition at line 195 of file DynamicArray.h.

                {
                        return array_capacity;
                }

template<typename DataType, typename SizeType, SizeType array_capacity = (1 << (sizeof(SizeType) << 3)) - 1, SizeType reserve_size = 8, SizeType block_size = 8>

bool AVRCpp::Collection::DynamicArray< DataType, SizeType, array_capacity, reserve_size, block_size >::IsFull

(

void

)

[inline]

Return whether the array is in full capacity or not.

Definition at line 203 of file DynamicArray.h.

                {
                        return (this->current_size == array_capacity);
                }

SizeType AVRCpp::Collection::BaseArray< DataType , SizeType , DataType * >::GetSize

(

void

)

[inline, inherited]

Return array size.

Definition at line 145 of file BaseArray.h.

                {
                        return this->current_size;
                }

bool AVRCpp::Collection::BaseArray< DataType , SizeType , DataType * >::IsEmpty

(

void

)

[inline, inherited]

Return whether the array is empty or not.

Definition at line 153 of file BaseArray.h.

                {
                        return (this->current_size == 0);
                }

DataType & AVRCpp::Collection::BaseArray< DataType , SizeType , DataType * >::At

(

SizeType

pos

)

[inline, inherited]

Return reference of item at specified position NB! For speed purposes does not check constraints!

Definition at line 172 of file BaseArray.h.

                {
                        return this->data[pos];
                }

---

Member Data Documentation

template<typename DataType, typename SizeType, SizeType array_capacity = (1 << (sizeof(SizeType) << 3)) - 1, SizeType reserve_size = 8, SizeType block_size = 8>

SizeType AVRCpp::Collection::DynamicArray< DataType, SizeType, array_capacity, reserve_size, block_size >::allocated_size [protected]

Definition at line 66 of file DynamicArray.h.

DataType * AVRCpp::Collection::BaseArray< DataType , SizeType , DataType * >::data [protected, inherited]

Definition at line 55 of file BaseArray.h.

SizeType AVRCpp::Collection::BaseArray< DataType , SizeType , DataType * >::current_size [protected, inherited]

Definition at line 56 of file BaseArray.h.

---

The documentation for this class was generated from the following file:

• avr/cpp/collection/DynamicArray.h

---

MTÜ TTÜ Robotiklubi