HKLGenerator.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2015 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 "MantidGeometry/Crystal/UnitCell.h"
#include "MantidGeometry/DllConfig.h"
#include "MantidKernel/V3D.h"
 
#include <boost/iterator/iterator_facade.hpp>
 
namespace Mantid {
namespace Geometry {
 
class MANTID_GEOMETRY_DLL HKLGenerator {
public:
  class MANTID_GEOMETRY_DLL const_iterator
      : public boost::iterator_facade<const_iterator, const Kernel::V3D &, boost::forward_traversal_tag> {
  public:
    const_iterator();
 
    explicit const_iterator(const Kernel::V3D &current);
 
    explicit const_iterator(const Kernel::V3D &hklMin, const Kernel::V3D &hklMax);
 
  private:
    // Required for boost::iterator_facade to work
    friend class boost::iterator_core_access;
 
    void increment();
 
    inline bool equal(const const_iterator &other) const {
      return this->m_h == other.m_h && this->m_k == other.m_k && this->m_l == other.m_l;
    }
 
    inline const Kernel::V3D &dereference() const { return m_hkl; }
 
    inline void advance(difference_type) {}
    inline void decrement() {}
 
    int m_h, m_k, m_l;
    Kernel::V3D m_hkl;
 
    int m_hMax;
    int m_kMin, m_kMax;
    int m_lMin, m_lMax;
  };
 
  HKLGenerator(const Kernel::V3D &hklMin, const Kernel::V3D &hklMax);
  HKLGenerator(const Kernel::V3D &hklMinMax);
  HKLGenerator(int hMinMax, int kMinMax, int lMinMax);
  HKLGenerator(const UnitCell &unitCell, double dMin);
 
  virtual ~HKLGenerator() = default;
 
  inline size_t size() const { return m_size; }
 
  inline const const_iterator &begin() const { return m_begin; }
 
  inline const const_iterator &end() const { return m_end; }
 
private:
  size_t getSize(const Kernel::V3D &min, const Kernel::V3D &max) const;
 
  const_iterator getBeginIterator() const;
  const_iterator getEndIterator() const;
  Kernel::V3D getEndHKL() const;
 
  Kernel::V3D m_hklMin;
  Kernel::V3D m_hklMax;
 
  size_t m_size;
 
  const_iterator m_begin;
  const_iterator m_end;
};
 
} // namespace Geometry
} // namespace Mantid