Index.h

Go to the documentation of this file.

/*
 * Copyright (C) 2015 Niek Linnenbank
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef __LIB_LIBSTD_INDEX_H
#define __LIB_LIBSTD_INDEX_H
 
#include "Assert.h"
#include "Types.h"
#include "Macros.h"
 
template <class T, const Size N> class Index
{
  public:
 
    Index()
        : m_count(0)
    {
        for (Size i = 0; i < N; i++)
        {
            m_array[i] = ZERO;
        }
    }
 
    virtual bool insert(Size & position, T *item)
    {
        // Check if we are full
        if (m_count == N)
        {
            return false;
        }
        // The item must point to an object
        else if (item == ZERO)
        {
            return false;
        }
 
        // There is space, add the item.
        for (Size i = 0; i < N; i++)
        {
            if (m_array[i] == ZERO)
            {
                m_array[i] = item;
                m_count++;
                position = i;
                return true;
            }
        }
 
        // Should not be reached
        assert(false);
        return false;
    }
 
    virtual bool insert(T *item)
    {
        Size ignored = 0;
        return insert(ignored, item);
    }
 
    virtual bool insertAt(const Size position, T *item)
    {
        // Position must be in range of the array
        if (position >= N)
        {
            return false;
        }
        // The item must point to an object
        else if (item == ZERO)
        {
            return false;
        }
 
        // Increment counter only when needed
        if (m_array[position] == ZERO)
        {
            m_count++;
        }
 
        m_array[position] = item;
        return true;
    }
 
    virtual bool remove(const Size position)
    {
        // Position must be in range of the array
        if (position >= N)
        {
            return false;
        }
 
        // See if the item exists
        if (!m_array[position])
        {
            return false;
        }
 
        m_array[position] = ZERO;
        assert(m_count >= 1);
        m_count--;
        return true;
    }
 
    void deleteAll()
    {
        for (Size i = 0; i < N; i++)
        {
            if (m_array[i] != ZERO)
            {
                delete m_array[i];
                m_array[i] = ZERO;
            }
        }
 
        m_count = 0;
    }
 
    virtual T * get(const Size position) const
    {
        // Position must be in range of the array
        if (position >= N)
        {
            return ZERO;
        }
 
        return m_array[position];
    }
 
    virtual bool contains(const T *item) const
    {
        for (Size i = 0; i < N; i++)
        {
            if (m_array[i] == item)
            {
                return true;
            }
        }
 
        return false;
    }
 
    virtual Size size() const
    {
        return N;
    }
 
    virtual Size count() const
    {
        return m_count;
    }
 
    T * operator [] (const Size i)
    {
        return get(i);
    }
 
  private:
 
    T* m_array[N];
 
    Size m_count;
};
 
#endif /* __LIB_LIBSTD_INDEX_H */