workingmemdeque.h

Go to the documentation of this file.

/*
* Copyright 2016 Autodesk, Inc. All rights reserved.
* Use of this software is subject to the terms of the Autodesk license agreement and any attachments or Appendices thereto provided at the time of installation or download,
* or which otherwise accompanies this software in either electronic or hard copy form, or which is signed by you and accepted by Autodesk.
*/


#pragma once

#include "gwnavruntime/querysystem/workingmemcontainers/workingmemcontainerbase.h"

namespace Kaim
{

template <class T>
class WorkingMemDeque
{
public:
    WorkingMemDeque() : m_headIdx(0), m_tailIdx(0), m_lastIdx(0) {}
    WorkingMemDeque(WorkingMemory*workingMemory) { Init(workingMemory); }

    void Init(WorkingMemory* workingMemory);

    T*   GetBuffer()     const { return (T*)m_buffer.GetBuffer(); }
    bool IsInitialized() const { return m_buffer.IsInitialized(); }
    bool IsEmpty()       const { return m_tailIdx == m_headIdx; }

    void MakeEmpty() { m_headIdx = 0; m_tailIdx = 0; }

    KyResult PushFront(const T& x);
    KyResult PushBack(const T& x);

    void PopFront();
    void PopBack();

    void Front(T& item) const;
    void Back(T& item)  const;

    // The following functions are not used, but could be interesting so we keep the code commented
    // If we need them at some point, we must unit-test them though
    // The usage would be for(idx = GetHeadIdx(); idx != GetTailEndIdx(); idx = GetNextItemIdx()) {...}
    //KyUInt32 GetHeadIdx()    const { return m_headIdx; }
    //KyUInt32 GetTailEndIdx() const { return m_tailIdx; }
    //KyUInt32 GetNextItemIdx(KyUInt32 idx) const;
    //KyUInt32 GetPrevItemIdx(KyUInt32 idx) const;

    T& GetItem(KyUInt32 idx);

    KyResult TryToResize(); // return KY_ERROR

    void ReleaseWorkingMemoryBuffer() { m_buffer.ReleaseBuffer(); }

    KyResult GrowIfNeeded();

public:
    WorkingMemContainerBase m_buffer;
    KyUInt32 m_headIdx;
    KyUInt32 m_tailIdx;
    KyUInt32 m_lastIdx; // capacity - 1
};

}

#include "gwnavruntime/querysystem/workingmemcontainers/workingmemdeque.inl"