source: branches/0.11-stable/yat/regression/KernelBox.h @ 3161

Last change on this file since 3161 was 3161, checked in by Peter, 9 years ago

fix docs so doxygen can parse correctly

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 1.4 KB
Line 
1#ifndef _theplu_yat_regression_kernelbox_
2#define _theplu_yat_regression_kernelbox_
3
4// $Id: KernelBox.h 3161 2014-01-14 01:46:41Z peter $
5
6/*
7  Copyright (C) 2004 Peter Johansson
8  Copyright (C) 2005 Jari Häkkinen, Peter Johansson
9  Copyright (C) 2006 Jari Häkkinen
10  Copyright (C) 2007, 2008 Jari Häkkinen, Peter Johansson
11
12  This file is part of the yat library, http://dev.thep.lu.se/yat
13
14  The yat library is free software; you can redistribute it and/or
15  modify it under the terms of the GNU General Public License as
16  published by the Free Software Foundation; either version 3 of the
17  License, or (at your option) any later version.
18
19  The yat library is distributed in the hope that it will be useful,
20  but WITHOUT ANY WARRANTY; without even the implied warranty of
21  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
22  General Public License for more details.
23
24  You should have received a copy of the GNU General Public License
25  along with yat. If not, see <http://www.gnu.org/licenses/>.
26*/
27
28#include "Kernel.h"
29
30namespace theplu {
31namespace yat {
32namespace regression {
33
34  ///
35  /// @brief Class for KernelBox a.k.a. rectangular window.
36  ///
37  class KernelBox : public Kernel
38  {
39  public:
40    ///
41    /// Constructor
42    ///
43    KernelBox(void);
44
45    /**
46       Function calculating kernel value as \f$ w(x)=1\f$ if \f$|x|\le 1
47       \f$, \f$ w(x)=0 \f$ otherwise.
48    */
49    double operator()(const double) const;
50
51  private:
52  };
53
54}}} // of namespaces regression, yat, and theplu
55
56#endif
Note: See TracBrowser for help on using the repository browser.