MatrixEigen.h

Go to the documentation of this file.

// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Timo Sachsenberg $
// $Authors: Timo Sachsenberg $
// --------------------------------------------------------------------------
 
#pragma once
 
// NOTE: This is an INTERNAL header file and should NOT be included in public headers.
// It provides Eigen-based utilities for internal OpenMS algorithms.
// Users of the public API should use Matrix.h directly.
 
#include <OpenMS/DATASTRUCTURES/Matrix.h>
#include <Eigen/Core>
 
namespace OpenMS
{
  template <typename Value>
  using EigenMatrixType = Eigen::Matrix<Value, Eigen::Dynamic, Eigen::Dynamic>;
 
  template <typename Value>
  using EigenVectorType = Eigen::Matrix<Value, Eigen::Dynamic, 1>;
 
  template <typename Value>
  using EigenRowVectorType = Eigen::Matrix<Value, 1, Eigen::Dynamic>;
 
  template <typename Value>
  Eigen::Map<EigenMatrixType<Value>> eigenView(Matrix<Value>& mat)
  {
    return Eigen::Map<EigenMatrixType<Value>>(mat.data(), mat.rows(), mat.cols());
  }
 
  template <typename Value>
  Eigen::Map<const EigenMatrixType<Value>> eigenView(const Matrix<Value>& mat)
  {
    return Eigen::Map<const EigenMatrixType<Value>>(mat.data(), mat.rows(), mat.cols());
  }
 
  template <typename Value>
  Eigen::Map<EigenVectorType<Value>> eigenVectorView(std::vector<Value>& vec)
  {
    return Eigen::Map<EigenVectorType<Value>>(vec.data(), vec.size());
  }
 
  template <typename Value>
  Eigen::Map<const EigenVectorType<Value>> eigenVectorView(const std::vector<Value>& vec)
  {
    return Eigen::Map<const EigenVectorType<Value>>(vec.data(), vec.size());
  }
 
  template <typename Value>
  Eigen::Map<EigenVectorType<Value>> eigenVectorView(Value* data, size_t size)
  {
    return Eigen::Map<EigenVectorType<Value>>(data, size);
  }
 
  template <typename Value>
  Eigen::Map<const EigenVectorType<Value>> eigenVectorView(const Value* data, size_t size)
  {
    return Eigen::Map<const EigenVectorType<Value>>(data, size);
  }
 
  template <typename Value>
  Eigen::Map<EigenMatrixType<Value>> eigenMatrixView(Value* data, size_t rows, size_t cols)
  {
    return Eigen::Map<EigenMatrixType<Value>>(data, rows, cols);
  }
 
  template <typename Value>
  Eigen::Map<const EigenMatrixType<Value>> eigenMatrixView(const Value* data, size_t rows, size_t cols)
  {
    return Eigen::Map<const EigenMatrixType<Value>>(data, rows, cols);
  }
 
} // namespace OpenMS