OpenMS  3.0.0
QuadraticRegression.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, Chris Bielow $
33 // --------------------------------------------------------------------------
34 
35 #pragma once
36 
37 #include <OpenMS/CONCEPT/Types.h>
39 
40 #include <iterator>
41 #include <vector>
42 
43 namespace OpenMS
44 {
45  namespace Math
46  {
47  /*
48  @brief Estimates model parameters for a quadratic equation
49 
50  The quadratic equation is of the form
51  y = a + b*x + c*x^2
52 
53  Weighted inputs are supported.
54 
55  */
56  class OPENMS_DLLAPI QuadraticRegression
57  {
58 public:
60 
62  void computeRegression(
63  std::vector<double>::const_iterator x_begin,
64  std::vector<double>::const_iterator x_end,
65  std::vector<double>::const_iterator y_begin);
66 
68  void computeRegressionWeighted(
69  std::vector<double>::const_iterator x_begin,
70  std::vector<double>::const_iterator x_end,
71  std::vector<double>::const_iterator y_begin,
72  std::vector<double>::const_iterator w_begin);
73 
75  double eval(double x) const;
76 
78  static double eval(double A, double B, double C, double x);
79 
80  double getA() const;
81  double getB() const;
82  double getC() const;
83  double getChiSquared() const;
84 
85 protected:
86  double a_;
87  double b_;
88  double c_;
89  double chi_squared_;
90  }; //class
91 
92  } //namespace
93 } //namespace
94 
Types.h
OpenMS::Math::QuadraticRegression::c_
double c_
Definition: QuadraticRegression.h:88
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
OpenMS::Math::QuadraticRegression
Definition: QuadraticRegression.h:56
Exception.h
OpenMS::Math::QuadraticRegression::b_
double b_
Definition: QuadraticRegression.h:87
OpenMS::Math::QuadraticRegression::chi_squared_
double chi_squared_
Definition: QuadraticRegression.h:89
OpenMS::Math::QuadraticRegression::a_
double a_
Definition: QuadraticRegression.h:86