EigenMatrix.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 "EigenVector.h"
#include "MantidCurveFitting/DllConfig.h"
 
#include "EigenMatrixView.h"
#include "MantidKernel/Matrix.h"
 
#include "Eigen/Core"
#include "Eigen/Dense"
 
#include <iomanip>
#include <stdexcept>
#include <vector>
 
namespace Mantid {
namespace CurveFitting {
 
class EigenMatrix;
 
class MANTID_CURVEFITTING_DLL EigenMatrix {
public:
  EigenMatrix() = default;
  EigenMatrix(const size_t nx, const size_t ny);
  EigenMatrix(std::initializer_list<std::initializer_list<double>> ilist);
  EigenMatrix(const EigenMatrix &M);
  EigenMatrix(EigenMatrix &M, size_t row, size_t col, size_t nRows, size_t nCols);
  EigenMatrix(const Kernel::Matrix<double> &M);
  EigenMatrix(const Kernel::Matrix<double> &M, size_t row, size_t col, size_t nRows, size_t nCols);
 
  EigenMatrix &operator=(const EigenMatrix &M);
  EigenMatrix &operator=(const Eigen::MatrixXd v);
 
  inline map_type &mutator() { return m_view.matrix_mutator(); }
  inline const map_type inspector() const { return m_view.matrix_inspector(); }
  inline map_type copy_view() const { return m_view.matrix_copy(); }
 
  bool isEmpty() const;
  void resize(const size_t nx, const size_t ny);
  size_t size1() const;
  size_t size2() const;
 
  void set(size_t i, size_t j, double value);
  double get(size_t i, size_t j) const;
  double operator()(size_t i, size_t j) const;
  double &operator()(size_t i, size_t j);
 
  void identity();
  void zero();
  void diag(const EigenVector &d);
  EigenMatrix &operator+=(const EigenMatrix &M);
  EigenMatrix &operator+=(const double &d);
  EigenMatrix &operator-=(const EigenMatrix &M);
  EigenMatrix &operator-=(const double &d);
  EigenMatrix &operator*=(const double &d);
  EigenVector operator*(const EigenVector &v) const;
  EigenMatrix operator*(const EigenMatrix &m) const;
 
  EigenVector copyRow(size_t i) const;
  EigenVector copyColumn(size_t i) const;
 
  void solve(const EigenVector &rhs, EigenVector &x);
  void invert();
  double det() const;
  void eigenSystem(EigenVector &eigenValues, EigenMatrix &eigenVectors);
  EigenMatrix tr() const;
 
protected:
  EigenMatrix move();
 
private:
  EigenMatrix(std::vector<double> &&data, size_t nx, size_t ny);
  std::vector<double> m_data;
  EigenMatrix_View m_view;
  EigenVector multiplyByVector(const EigenVector &v) const;
};
 
inline std::ostream &operator<<(std::ostream &ostr, const EigenMatrix &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) {
      ostr << std::setw(13) << m.get(i, j) << ' ';
    }
    ostr << '\n';
  }
  ostr.flags(fflags);
  return ostr;
}
 
inline double EigenMatrix::operator()(size_t i, size_t j) const { return const_cast<EigenMatrix &>(*this)(i, j); }
 
inline double &EigenMatrix::operator()(size_t i, size_t j) { return m_data[j * m_view.rows() + i]; }
 
} // namespace CurveFitting
} // namespace Mantid