OpenMS  3.0.0
MatrixUtils.h
Go to the documentation of this file.
1 // --------------------------------------------------------------------------
2 // OpenMS -- Open-Source Mass Spectrometry
3 // --------------------------------------------------------------------------
4 // Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,
5 // ETH Zurich, and Freie Universitaet Berlin 2002-2022.
6 //
7 // This software is released under a three-clause BSD license:
8 // * Redistributions of source code must retain the above copyright
9 // notice, this list of conditions and the following disclaimer.
10 // * Redistributions in binary form must reproduce the above copyright
11 // notice, this list of conditions and the following disclaimer in the
12 // documentation and/or other materials provided with the distribution.
13 // * Neither the name of any author or any participating institution
14 // may be used to endorse or promote products derived from this software
15 // without specific prior written permission.
16 // For a full list of authors, refer to the file AUTHORS.
17 // --------------------------------------------------------------------------
18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 // ARE DISCLAIMED. IN NO EVENT SHALL ANY OF THE AUTHORS OR THE CONTRIBUTING
22 // INSTITUTIONS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
23 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
24 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
25 // OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
26 // WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
27 // OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
28 // ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 //
30 // --------------------------------------------------------------------------
31 // $Maintainer: Timo Sachsenberg $
32 // $Authors: Christian Ehrlich $
33 // --------------------------------------------------------------------------
34 
35 #pragma once
36 
38 
39 #include <Eigen/Core>
40 
41 #include <boost/shared_ptr.hpp>
42 
43 namespace OpenMS
44 {
49  typedef boost::shared_ptr< const Eigen::MatrixXd > EigenMatrixXdPtr;
50  typedef boost::shared_ptr< Eigen::MatrixXd > MutableEigenMatrixXdPtr;
51 
52  inline EigenMatrixXdPtr
54  {
55  MutableEigenMatrixXdPtr em ( new Eigen::MatrixXd(m.rows(), m.cols()) );
56  for (unsigned i=0; i<m.rows(); ++i)
57  {
58  for (unsigned j=0; j<m.cols(); ++j)
59  {
60  (*em)(i,j) = m(i,j);
61  }
62  }
63  return em;
64  }
65 
66  inline bool
67  matrixIsIdentityMatrix(const Matrix<double>& channel_frequency)
68  {
69  for (Matrix<double>::SizeType i = 0; i < channel_frequency.rows(); ++i)
70  {
71  for (Matrix<double>::SizeType j = 0; j < channel_frequency.rows(); ++j)
72  {
73  // check if the entries are those of a identity matrix;
74  // i==j -> m(i,j) == 1.0 && i!=j -> m(i,j) == 0.0
75  if ((i == j && channel_frequency(i, j) != 1.0) || channel_frequency(i, j) != 0.0)
76  {
77  return false;
78  }
79  }
80  }
81  return true;
82  }
83 }//namespace
84 
OpenMS::MutableEigenMatrixXdPtr
boost::shared_ptr< Eigen::MatrixXd > MutableEigenMatrixXdPtr
Definition: MatrixUtils.h:50
Matrix.h
Eigen::Matrix
Definition: IsobaricIsotopeCorrector.h:43
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
OpenMS::Matrix::cols
SizeType cols() const
Number of columns.
Definition: Matrix.h:264
OpenMS::Matrix< double >
OpenMS::EigenMatrixXdPtr
boost::shared_ptr< const Eigen::MatrixXd > EigenMatrixXdPtr
Definition: MatrixUtils.h:49
OpenMS::Matrix::rows
SizeType rows() const
Number of rows.
Definition: Matrix.h:258
OpenMS::convertOpenMSMatrix2EigenMatrixXd
EigenMatrixXdPtr convertOpenMSMatrix2EigenMatrixXd(const Matrix< double > &m)
Definition: MatrixUtils.h:53
OpenMS::matrixIsIdentityMatrix
bool matrixIsIdentityMatrix(const Matrix< double > &channel_frequency)
Definition: MatrixUtils.h:67