EigenComplexVector.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2010 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 "MantidCurveFitting/DllConfig.h"
 
#include "MantidKernel/WarningSuppressions.h"
 
// Eigen's code generate maybe-uninitialized warning under GCC
GNU_DIAG_OFF("maybe-uninitialized")
#include <Eigen/Core>
GNU_DIAG_ON("maybe-uninitialized")
 
#include <complex>
#include <ostream>
#include <vector>
 
namespace Mantid {
namespace CurveFitting {
 
using ComplexType = std::complex<double>;
class ComplexVector;
 
typedef Eigen::Stride<Eigen::Dynamic, Eigen::Dynamic> dynamic_stride;
typedef Eigen::Map<Eigen::VectorXcd, 0, dynamic_stride> complex_vec_map_type;
 
class MANTID_CURVEFITTING_DLL ComplexVector {
public:
  ComplexVector();
  explicit ComplexVector(const size_t n);
  explicit ComplexVector(const Eigen::VectorXcd v);
  ComplexVector(const ComplexVector &v);
  ComplexVector(ComplexVector &&v);
  ComplexVector &operator=(const ComplexVector &v);
  ComplexVector &operator=(const Eigen::VectorXcd &v);
  ComplexVector &operator=(ComplexVector &&v) noexcept;
 
  Eigen::VectorXcd &eigen();
  const Eigen::VectorXcd eigen() const;
 
  void resize(const size_t n);
  size_t size() const;
 
  void set(const size_t i, const ComplexType &value);
  ComplexType get(const size_t i) const;
  // Set all elements to zero
  void zero();
  const ComplexType operator[](const size_t i) const { return eigen()(i); }
  ComplexType &operator[](size_t i) { return eigen()(i); }
 
  ComplexVector &operator+=(const ComplexVector &v);
  ComplexVector &operator-=(const ComplexVector &v);
  ComplexVector &operator*=(const ComplexType d);
  ComplexVector &operator+=(const ComplexType &d);
  void sort(const std::vector<size_t> &indices);
 
protected:
  ComplexVector move();
 
private:
  ComplexVector(Eigen::VectorXcd &&gslVector);
  Eigen::VectorXcd m_vector;
};
 
MANTID_CURVEFITTING_DLL std::ostream &operator<<(std::ostream &ostr, const ComplexVector &v);
 
} // namespace CurveFitting
} // namespace Mantid