MatrixVectorPair.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/DllConfig.h"
#include "MantidKernel/Matrix.h"
 
namespace Mantid {
namespace Geometry {
 
template <typename MatrixNumericType, typename VectorType> class MatrixVectorPair {
public:
  MatrixVectorPair() : m_matrix(3, 3, true), m_vector() {}
 
  MatrixVectorPair(const Kernel::Matrix<MatrixNumericType> &matrix, const VectorType &vector)
      : m_matrix(matrix), m_vector(vector) {}
 
  virtual ~MatrixVectorPair() = default;
 
  const Kernel::Matrix<MatrixNumericType> &getMatrix() const { return m_matrix; }
 
  const VectorType &getVector() const { return m_vector; }
 
  template <typename T> T operator*(const T &operand) const { return (m_matrix * operand) + m_vector; }
 
  MatrixVectorPair<MatrixNumericType, VectorType>
  operator*(const MatrixVectorPair<MatrixNumericType, VectorType> &other) const {
    return MatrixVectorPair<MatrixNumericType, VectorType>(m_matrix * other.m_matrix,
                                                           (m_matrix * other.m_vector) + m_vector);
  }
 
  MatrixVectorPair<MatrixNumericType, VectorType> getInverse() const {
    Kernel::Matrix<MatrixNumericType> matrix(m_matrix);
    matrix.Invert();
 
    return MatrixVectorPair<MatrixNumericType, VectorType>(matrix, -(matrix * m_vector));
  }
 
  bool operator==(const MatrixVectorPair<MatrixNumericType, VectorType> &other) const {
    return m_matrix == other.m_matrix && m_vector == other.m_vector;
  }
 
  bool operator!=(const MatrixVectorPair<MatrixNumericType, VectorType> &other) const { return !operator==(other); }
 
private:
  Kernel::Matrix<MatrixNumericType> m_matrix;
  VectorType m_vector;
};
 
} // namespace Geometry
} // namespace Mantid