ElementTable.h

Go to the documentation of this file.

/*                                              -*- mode:C++ -*-
  ElementTable.h Registry of elements
  Copyright (C) 2014 The Regents of the University of New Mexico.  All rights reserved.

  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Lesser General Public
  License as published by the Free Software Foundation; either
  version 2.1 of the License, or (at your option) any later version.

  This library 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
  Lesser General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with this library; if not, write to the Free Software
  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301
  USA
*/

#ifndef ELEMENTTABLE_H
#define ELEMENTTABLE_H

#include "BitVector.h"
#include "EventWindow.h"
#include "Dirs.h"
#include "itype.h"
#include "Element.h"
#include "Element_Empty.h"
#include "UsageTimer.h"

namespace MFM
{

  template <class CC> class Element; // FORWARD
  template <class CC> class EventWindow; // FORWARD

  template <class CC>
  class ElementTable
  {
    // Extract short type names
    typedef typename CC::ATOM_TYPE T;
    typedef typename CC::PARAM_CONFIG P;
    enum { B = P::ELEMENT_TABLE_BITS};
    enum { R = P::EVENT_WINDOW_RADIUS};
    enum { ELEMENT_DATA_SLOTS = P::ELEMENT_DATA_SLOTS};

  public:
    // -3 to avoid 2**k and 2**k-1 sizes; they seem to beat against type assignments
    static const u32 SIZE = (1u<<B) - 3;

    void Reinit() ;

    void Insert(const Element<CC> & theElement) ;

    u32 GetSize() const
    {
      return SIZE;
    }

    s32 GetIndex(u32 elementType) const ;

    ElementTable();

    ~ElementTable() { }

    const Element<CC> * Lookup(u32 elementType) const;

    void Execute(EventWindow<CC>& window) ;

    bool RegisterElement(const Element<CC>& e) ;

    bool AllocateElementDataSlots(const Element<CC>& e, u32 slots) ;

    bool AllocateElementDataSlotsFromType(const u32 elementType, u32 slots) ;

    u64 * GetElementDataSlots(const Element<CC>& e, const u32 slots) ;

    u64 * GetElementDataSlotsFromType(const u32 elementType, const u32 slots) ;

    u64 * GetDataAndRegister(const u32 elementType, u32 slots) ;

    u64 * GetDataIfRegistered(const u32 elementType, u32 slots) ;

  private:

    u32 SlotFor(u32 elementType) const ;

    struct ElementEntry {
      void Clear() {
        m_element = 0;
        m_elementDataStart = 0;
        m_elementDataLength = 0;
      }
      const Element<CC>* m_element;
      u16 m_elementDataStart;
      u16 m_elementDataLength;
    } m_hash[SIZE];
    u32 m_hashSlotsInUse;

    u64 m_elementData[ELEMENT_DATA_SLOTS];
    u32 m_nextFreeElementDataIndex;

  };

} /* namespace MFM */

#include "ElementTable.tcc"

#endif /*ELEMENTTABLE_H*/