EventWorkspaceMRU.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2011 ISIS Rutherford Appleton Laboratory UKRI,
//   NScD Oak Ridge National Laboratory, European Spallation Source,
//   Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
// SPDX - License - Identifier: GPL - 3.0 +
#pragma once
 
#include "MantidDataObjects/DllConfig.h"
#include "MantidHistogramData/HistogramE.h"
#include "MantidHistogramData/HistogramY.h"
#include "MantidKernel/Exception.h"
#include "MantidKernel/MRUList.h"
#include "MantidKernel/cow_ptr.h"
 
#include "Poco/RWLock.h"
 
#include <cstdint>
#include <vector>
 
namespace Mantid {
namespace DataObjects {
 
class EventList;
 
//============================================================================
//============================================================================
template <class T> class TypeWithMarker {
public:
  TypeWithMarker(const uintptr_t the_index) : m_index(the_index) {}
  TypeWithMarker(const TypeWithMarker &other) = delete;
  TypeWithMarker &operator=(const TypeWithMarker &other) = delete;
 
public:
  uintptr_t m_index;
 
  T m_data;
 
  uintptr_t hashIndexFunction() const { return m_index; }
 
  void setIndex(const uintptr_t the_index) { m_index = the_index; }
};
 
//============================================================================
//============================================================================
class MANTID_DATAOBJECTS_DLL EventWorkspaceMRU {
public:
  using YType = Kernel::cow_ptr<HistogramData::HistogramY>;
  using EType = Kernel::cow_ptr<HistogramData::HistogramE>;
  using YWithMarker = TypeWithMarker<YType>;
  using EWithMarker = TypeWithMarker<EType>;
  // Typedef for a Most-Recently-Used list of Data objects.
  using mru_listY = Kernel::MRUList<YWithMarker>;
  using mru_listE = Kernel::MRUList<EWithMarker>;
 
  ~EventWorkspaceMRU();
 
  void ensureEnoughBuffersY(size_t thread_num) const;
  void ensureEnoughBuffersE(size_t thread_num) const;
 
  void clear();
 
  YType findY(size_t thread_num, const EventList *index);
  EType findE(size_t thread_num, const EventList *index);
  void insertY(size_t thread_num, YType data, const EventList *index);
  void insertE(size_t thread_num, EType data, const EventList *index);
 
  void deleteIndex(const EventList *index);
 
  size_t MRUSize() const;
 
protected:
  mutable std::vector<std::unique_ptr<mru_listY>> m_bufferedDataY;
 
  mutable std::vector<std::unique_ptr<mru_listE>> m_bufferedDataE;
 
  mutable Poco::RWLock m_changeMruListsMutexE;
  mutable Poco::RWLock m_changeMruListsMutexY;
};
 
} // namespace DataObjects
} // namespace Mantid