Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
GumbelDistributionFitter.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-2013.
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: David Wojnar $
32 // $Authors: $
33 // --------------------------------------------------------------------------
34 //
35 #ifndef OPENMS_MATH_STATISTICS_GUMBELDISTRIBUTIONFITTER_H
36 #define OPENMS_MATH_STATISTICS_GUMBELDISTRIBUTIONFITTER_H
37 
40 
41 #include <vector>
42 
43 // gsl includes
44 #include <gsl/gsl_rng.h>
45 #include <gsl/gsl_vector.h>
46 #include <gsl/gsl_multifit_nlin.h>
47 
48 
49 namespace OpenMS
50 {
51  namespace Math
52  {
67  class OPENMS_DLLAPI GumbelDistributionFitter
68  {
69 public:
70 
73  {
74 public:
75 
77  a(1.0),
78  b(2.0)
79  {
80  }
81 
83  a(rhs.a),
84  b(rhs.b)
85  {
86  }
87 
89  {
90  if (this != &rhs)
91  {
92  a = rhs.a;
93  b = rhs.b;
94  }
95  return *this;
96  }
97 
99  double a;
100 
102  double b;
103  };
104 
108  virtual ~GumbelDistributionFitter();
109 
111  void setInitialParameters(const GumbelDistributionFitResult & result);
112 
120  GumbelDistributionFitResult fit(std::vector<DPosition<2> > & points);
121 
123  const String & getGnuplotFormula() const;
124 
125 protected:
126 
127  static int gumbelDistributionFitterf_(const gsl_vector * x, void * params, gsl_vector * f);
128 
129  static int gumbelDistributionFitterdf_(const gsl_vector * x, void * params, gsl_matrix * J);
130 
131  static int gumbelDistributionFitterfdf_(const gsl_vector * x, void * params, gsl_vector * f, gsl_matrix * J);
132 
133  void printState_(size_t iter, gsl_multifit_fdfsolver * s);
134 
136 
138 
139 private:
143  GumbelDistributionFitter & operator=(const GumbelDistributionFitter & rhs);
144  };
145  }
146 }
147 
148 #endif
double a
location parameter a
Definition: GumbelDistributionFitter.h:99
A more convenient string class.
Definition: String.h:56
double b
scale parameter b
Definition: GumbelDistributionFitter.h:102
GumbelDistributionFitResult & operator=(const GumbelDistributionFitResult &rhs)
Definition: GumbelDistributionFitter.h:88
struct to represent the parameters of a gumbel distribution
Definition: GumbelDistributionFitter.h:72
GumbelDistributionFitResult()
Definition: GumbelDistributionFitter.h:76
String gnuplot_formula_
Definition: GumbelDistributionFitter.h:137
Implements a fitter for the Gumbel distribution.
Definition: GumbelDistributionFitter.h:67
GumbelDistributionFitResult init_param_
Definition: GumbelDistributionFitter.h:135
GumbelDistributionFitResult(const GumbelDistributionFitResult &rhs)
Definition: GumbelDistributionFitter.h:82

OpenMS / TOPP release 1.11.1 Documentation generated on Thu Nov 14 2013 11:19:14 using doxygen 1.8.5