EigenVector.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"
#include "Eigen/Dense"
GNU_DIAG_ON("maybe-uninitialized")
 
#include "MantidCurveFitting/EigenVectorView.h"
 
#include <ostream>
#include <vector>
 
namespace Mantid {
namespace CurveFitting {
class MANTID_CURVEFITTING_DLL EigenVector {
public:
  EigenVector();
  explicit EigenVector(const size_t n);
  explicit EigenVector(std::vector<double> v);
  explicit EigenVector(const Eigen::VectorXd *v);
  EigenVector(std::initializer_list<double> ilist);
  EigenVector(const EigenVector &v);
  EigenVector(EigenVector &&v) noexcept;
  EigenVector &operator=(const EigenVector &v);
  EigenVector &operator=(const std::vector<double> &v);
  EigenVector &operator=(const Eigen::VectorXd v);
 
  inline vec_map_type &mutator() { return m_view.vector_mutator(); }
  const vec_map_type inspector() const { return m_view.vector_inspector(); }
  vec_map_type copy_view() const { return m_view.vector_copy(); }
 
  void resize(const size_t n);
  size_t size() const;
 
  void set(const size_t i, const double value);
  double get(const size_t i) const;
  const double &operator[](const size_t i) const { return m_data[i]; }
  double &operator[](const size_t i) { return m_data[i]; }
  // Set all elements to zero
  void zero();
  void normalize();
  double norm() const;
  double norm2() const;
  double dot(const EigenVector &v) const;
  size_t indexOfMinElement() const;
  size_t indexOfMaxElement() const;
  std::pair<size_t, size_t> indicesOfMinMaxElements() const;
  std::vector<size_t> sortIndices(bool ascending = true) const;
  void sort(const std::vector<size_t> &indices);
  const std::vector<double> &toStdVector() const;
  std::vector<double> &StdVectorRef();
 
  EigenVector &operator+=(const EigenVector &v);
  EigenVector &operator-=(const EigenVector &v);
  EigenVector &operator*=(const EigenVector &v);
  EigenVector &operator*=(const double d);
  EigenVector &operator+=(const double d);
 
private:
  std::vector<double> m_data;
  EigenVector_View m_view;
};
 
MANTID_CURVEFITTING_DLL std::ostream &operator<<(std::ostream &ostr, const EigenVector &v);
 
} // namespace CurveFitting
} // namespace Mantid