EigenComplexMatrix.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 "MantidCurveFitting/EigenComplexVector.h"
#include "MantidCurveFitting/EigenMatrix.h"
#include "MantidCurveFitting/EigenVector.h"
 
#include <Eigen/Dense>
 
#include <complex>
#include <iomanip>
#include <stdexcept>
#include <vector>
 
typedef Eigen::Map<const Eigen::MatrixXcd, 0, Mantid::CurveFitting::dynamic_stride> complex_matrix_map_type;
typedef Eigen::Map<const Eigen::VectorXcd, 0, Mantid::CurveFitting::dynamic_stride> complex_vector_map_type;
 
namespace Mantid {
namespace CurveFitting {
class ComplexMatrix;
 
class MANTID_CURVEFITTING_DLL ComplexMatrix {
public:
  ComplexMatrix();
  ComplexMatrix(const size_t nx, const size_t ny);
  ComplexMatrix(const ComplexMatrix &M);
  ComplexMatrix(const ComplexMatrix &M, const size_t row, const size_t col, const size_t nRows, const size_t nCols);
  explicit ComplexMatrix(ComplexMatrix &&m) noexcept;
  explicit ComplexMatrix(Eigen::MatrixXcd &&m) noexcept;
 
  ComplexMatrix &operator=(const ComplexMatrix &M);
  ComplexMatrix &operator=(ComplexMatrix &&M);
  ComplexMatrix &operator=(const Eigen::MatrixXcd M);
 
  inline Eigen::MatrixXcd &eigen() { return m_matrix; }
  inline const Eigen::MatrixXcd eigen() const { return m_matrix; }
 
  bool isEmpty() const;
  void resize(const size_t nx, const size_t ny);
  size_t size1() const;
  size_t size2() const;
  void set(const size_t i, const size_t j, const ComplexType value);
  ComplexType get(const size_t i, const size_t j) const;
  ComplexType operator()(const size_t i, const size_t j) const;
  ComplexType &operator()(const size_t i, const size_t j);
 
  void identity();
  void zero();
  void diag(const ComplexVector &d);
  ComplexMatrix &operator+=(const ComplexMatrix &M);
  ComplexMatrix &operator+=(const ComplexType &d);
  ComplexMatrix &operator-=(const ComplexMatrix &M);
  ComplexMatrix &operator*=(const ComplexType &d);
  ComplexMatrix operator*(const EigenMatrix &m) const;
  ComplexMatrix operator*(const ComplexMatrix &m) const;
 
  ComplexVector copyRow(const size_t i) const;
  ComplexVector copyColumn(const size_t i) const;
  void sortColumns(const std::vector<size_t> &indices);
 
  void solve(const ComplexVector &rhs, ComplexVector &x);
  void invert();
  ComplexType det();
  void eigenSystemHermitian(EigenVector &eigenValues, ComplexMatrix &eigenVectors);
 
  ComplexMatrix tr() const;
  ComplexMatrix ctr() const;
  std::vector<double> packToStdVector() const;
  void unpackFromStdVector(const std::vector<double> &v);
 
private:
  Eigen::MatrixXcd m_matrix;
};
 
inline std::ostream &operator<<(std::ostream &ostr, const ComplexMatrix &m) {
  std::ios::fmtflags fflags(ostr.flags());
  ostr << std::scientific << std::setprecision(6);
  for (size_t i = 0; i < m.size1(); ++i) {
    for (size_t j = 0; j < m.size2(); ++j) {
      auto value = m.get(i, j);
      ostr << std::setw(28) << std::setprecision(13) << value.real() << "+" << value.imag() << "j ";
    }
    ostr << '\n';
  }
  ostr.flags(fflags);
  return ostr;
}
 
} // namespace CurveFitting
} // namespace Mantid