FbxDynamicArray< Type, Allocator > Class Template Reference

#include <fbxdynamicarray.h>

Class Description

template<typename Type, typename Allocator = FbxBaseAllocator>
class FbxDynamicArray< Type, Allocator >

Template class for dynamic array holding objects.

See also

FbxStaticArray

Definition at line 26 of file fbxdynamicarray.h.

Public Member Functions
	FbxDynamicArray ()
	Default constructor. More...
	FbxDynamicArray (const size_t pInitialSize)
	Constructor. More...
	FbxDynamicArray (const FbxDynamicArray &pArray)
	Copy constructor. More...
	~FbxDynamicArray ()
	Destructor. More...
size_t	Capacity () const
	Gets the current capacity of the array. More...
size_t	Size () const
	Gets the size of the array. More...
void	Reserve (const size_t pCount)
	Assures that sufficient memory is allocated to hold n objects in the array, and increases the capacity if necessary. More...
void	PushBack (const Type &pItem, const size_t pNCopies=1)
	Appends n objects at the end of the array. More...
void	Insert (const size_t pIndex, const Type &pItem, const size_t pNCopies=1)
	Inserts n objects at the specified position. More...
void	PopBack (size_t pNElements=1)
	Removes n objects at the end. More...
void	Remove (const size_t pIndex, size_t pNElements=1)
	Removes n objects at the specified position. More...
Type &	operator[] (const size_t pIndex)
	Gets nth object in the array. More...
const Type &	operator[] (const size_t pIndex) const
	Gets nth object in the array. More...
Type &	First ()
	Retrieve the first item in the array. More...
const Type &	First () const
	Retrieve the first item in the array. More...
Type &	Last ()
	Retrieve the last item in the array. More...
const Type &	Last () const
	Retrieve the last item in the array. More...
size_t	Find (const Type &pItem, const size_t pStartIndex=0) const
	Find first matching element, from first to last. More...
FbxDynamicArray &	operator= (const FbxDynamicArray &pArray)
	Assignment operator. More...

Constructor & Destructor Documentation

FbxDynamicArray ( )

inline

Default constructor.

Definition at line 30 of file fbxdynamicarray.h.

                      :
        mArray(NULL),
        mCapacity(0),
        mSize(0),
        mAllocator(sizeof(Type))
    {
    }

FbxDynamicArray ( const size_t  pInitialSize )

inline

Constructor.

Parameters

pInitialSize

initial capacity of this array

Definition at line 40 of file fbxdynamicarray.h.

                                               :
        mArray(NULL),
        mCapacity(0),
        mSize(0),
        mAllocator(sizeof(Type))
    {
        Reserve(pInitialSize);
    }

FbxDynamicArray ( const FbxDynamicArray< Type, Allocator > &  pArray )

inline

Copy constructor.

Remarks

The copy constructor of Type will be invoked in order to copy the value of elements to the new array.

Definition at line 54 of file fbxdynamicarray.h.

                                                   :
        mArray(NULL),
        mCapacity(0),
        mSize(0),
        mAllocator(sizeof(Type))
    {
        Reserve(pArray.mCapacity);
        CopyArray(mArray, pArray.mArray, pArray.mSize);
        mSize = pArray.mSize;
    }

~FbxDynamicArray ( )

inline

Destructor.

Definition at line 66 of file fbxdynamicarray.h.

    {
        for( size_t i = 0; i < mSize; ++i )
        {
            mArray[i].~Type();
        }
        mAllocator.FreeMemory(mArray);
    }

Member Function Documentation

size_t Capacity ( ) const

inline

Gets the current capacity of the array.

Definition at line 76 of file fbxdynamicarray.h.

    {
        return mCapacity;
    }

size_t Size ( ) const

inline

Gets the size of the array.

Definition at line 82 of file fbxdynamicarray.h.

    {
        return mSize;
    }

void Reserve ( const size_t  pCount )

inline

Assures that sufficient memory is allocated to hold n objects in the array, and increases the capacity if necessary.

Parameters

pCount

Number of objects to reserve

Definition at line 89 of file fbxdynamicarray.h.

    {
        if( pCount > mCapacity )
        {
            //We don't use mAllocator.PreAllocate, because we want our array to be continuous in memory.
            Type* lNewArray = (Type*)mAllocator.AllocateRecords(pCount);
            MoveArray(lNewArray, mArray, mSize);
            mAllocator.FreeMemory(mArray);
            mArray = lNewArray;
            mCapacity = pCount;
        }
    }

void PushBack ( const Type &  pItem, const size_t  pNCopies = 1  )

inline

Appends n objects at the end of the array.

Parameters

pItem	object to append
pNCopies	number of copies to append

Definition at line 105 of file fbxdynamicarray.h.

    {
        if( mSize + pNCopies > mCapacity )
        {
            size_t lNewSize = mCapacity + mCapacity / 2;    //grow by 50%
            if( mSize + pNCopies > lNewSize )
            {
                lNewSize = mSize + pNCopies;
            }
            Reserve(lNewSize);
        }
        FBX_ASSERT(mSize + pNCopies <= mCapacity);
        Fill(mArray + mSize, pItem, pNCopies);
        mSize += pNCopies;
    }

void Insert ( const size_t  pIndex, const Type &  pItem, const size_t  pNCopies = 1  )

inline

Inserts n objects at the specified position.

Parameters

pIndex	position index
pItem	object to insert
pNCopies	number of copies to append

Definition at line 125 of file fbxdynamicarray.h.

    {
        FBX_ASSERT(pIndex >= 0);
        FBX_ASSERT(pIndex <= mSize);
        Type lValue = pItem; // in case pItem is in array
        if( pNCopies == 0 )
        {
        }
        else if( pIndex >= mSize )
        {
            PushBack(pItem, pNCopies);
        }
        else if( mSize + pNCopies > mCapacity )
        {
            size_t lNewSize = mCapacity + mCapacity / 2;    //not enough room, grow by 50%
            if( mSize + pNCopies > lNewSize )
            {
                lNewSize = mSize + pNCopies;
            }

            Type* lNewArray = (Type*)mAllocator.AllocateRecords(lNewSize);
            MoveArray(lNewArray, mArray, pIndex); // copy prefix
            Fill(lNewArray + pIndex, pItem, pNCopies); // copy values
            MoveArray(lNewArray + pIndex + pNCopies, mArray + pIndex, mSize - pIndex); // copy suffix
            mAllocator.FreeMemory(mArray);
            mArray = lNewArray;
            mSize += pNCopies;
            mCapacity = lNewSize;
        }
        else
        {
            // copy suffix backwards
            MoveArrayBackwards(mArray + pIndex + pNCopies, mArray + pIndex, mSize - pIndex);
            Fill(mArray + pIndex, pItem, pNCopies); // copy values
            mSize += pNCopies;
        }
    }

void PopBack ( size_t  pNElements = 1 )

inline

Removes n objects at the end.

Parameters

pNElements

number of objects to remove

Definition at line 165 of file fbxdynamicarray.h.

    {
        FBX_ASSERT(pNElements <= mSize);
        for( size_t i = mSize - pNElements; i < mSize; ++i )
        {
            mArray[i].~Type();
        }
        mSize -= pNElements;
    }

void Remove ( const size_t  pIndex, size_t  pNElements = 1  )

inline

Removes n objects at the specified position.

Parameters

pIndex	position index
pNElements	number of objects to remove

Definition at line 178 of file fbxdynamicarray.h.

    {
        FBX_ASSERT(pIndex >= 0);
        FBX_ASSERT(pIndex <= mSize);
        FBX_ASSERT(pIndex + pNElements <= mSize);
        if( pIndex + pNElements >= mSize )
        {
            PopBack(pNElements);
        }
        else
        {            
            for( size_t i = pIndex; i < pIndex + pNElements; ++i )
            {
                mArray[i].~Type();
            }
            MoveOverlappingArray(&mArray[pIndex], &mArray[pIndex + pNElements], mSize - pIndex - pNElements);
            mSize -= pNElements;
        }
    }

Type& operator[] ( const size_t  pIndex )

inline

Gets nth object in the array.

Parameters

pIndex

position index

Definition at line 200 of file fbxdynamicarray.h.

    {
        return mArray[pIndex];
    }

const Type& operator[] ( const size_t  pIndex ) const

inline

Gets nth object in the array.

Parameters

pIndex

position index

Definition at line 207 of file fbxdynamicarray.h.

    {
        return mArray[pIndex];
    }

Type& First ( )

inline

Retrieve the first item in the array.

Returns

The first item in the array.

Definition at line 214 of file fbxdynamicarray.h.

    {
        return operator[](0);
    }

const Type& First ( ) const

inline

Retrieve the first item in the array.

Returns

The first item in the array.

Definition at line 221 of file fbxdynamicarray.h.

    {
        return operator[](0);
    }

Type& Last ( )

inline

Retrieve the last item in the array.

Returns

The last item in the array.

Definition at line 228 of file fbxdynamicarray.h.

    {
        return operator[](mSize-1);
    }

const Type& Last ( ) const

inline

Retrieve the last item in the array.

Returns

The last item in the array.

Definition at line 235 of file fbxdynamicarray.h.

    {
        return operator[](mSize-1);
    }

size_t Find ( const Type &  pItem, const size_t  pStartIndex = 0  ) const

inline

Find first matching element, from first to last.

Parameters

pItem	The item to try to find in the array.
pStartIndex	The index to start searching from.

Returns

Index of the first matching item, otherwise returns -1 (equivalent of SIZE_MAX for size_t).

Definition at line 244 of file fbxdynamicarray.h.

    {
        for( size_t i = pStartIndex; i < mSize; ++i )
        {
            if( operator[](i) == pItem ) return i;
        }
        return -1;
    }

FbxDynamicArray& operator= ( const FbxDynamicArray< Type, Allocator > &  pArray )

inline

Assignment operator.

Remarks

The copy constructor of Type will be invoked in order to copy the value of elements to the new array.

Definition at line 255 of file fbxdynamicarray.h.

    {
        Reserve(pArray.mCapacity);
        CopyArray(mArray, pArray.mArray, pArray.mSize);
        mSize = pArray.mSize;
        return *this;
    }

---

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

• fbxsdk/core/base/fbxdynamicarray.h