source: trunk/yat/classifier/DataLookup1D.h @ 757

Last change on this file since 757 was 757, checked in by Jari Häkkinen, 15 years ago

Fixed #include statemenst and forward declarations. asserts in headers removed.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date ID
File size: 2.6 KB
Line 
1#ifndef _theplu_yat_classifier_dataLookup1D_
2#define _theplu_yat_classifier_dataLookup1D_
3
4// $Id$
5
6/*
7  Copyright (C) The authors contributing to this file.
8
9  This file is part of the yat library, http://lev.thep.lu.se/trac/yat
10
11  The yat library is free software; you can redistribute it and/or
12  modify it under the terms of the GNU General Public License as
13  published by the Free Software Foundation; either version 2 of the
14  License, or (at your option) any later version.
15
16  The yat library is distributed in the hope that it will be useful,
17  but WITHOUT ANY WARRANTY; without even the implied warranty of
18  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19  General Public License for more details.
20
21  You should have received a copy of the GNU General Public License
22  along with this program; if not, write to the Free Software
23  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
24  02111-1307, USA.
25*/
26
27#include <iostream>
28
29namespace theplu {
30namespace yat {
31namespace classifier { 
32
33  class DataLookup2D;
34
35  ///
36  /// Class for general vector view
37  ///
38
39  class DataLookup1D
40  {
41 
42  public:
43
44    ///
45    /// Constructor.
46    ///
47    /// @param row_vector if true DataLookup1D is looking into a
48    /// row of DataLookup2D, otherwise looking into a
49    /// column. @param index which row/column to look into.
50    ///
51    DataLookup1D(const DataLookup2D&, const size_t index, 
52                 const bool row_vector);
53
54    ///
55    /// Copy constructor
56    ///
57    DataLookup1D(const DataLookup1D&);
58
59    ///
60    /// Construct DataLookup1D that owns its underlying matrix. Object
61    /// has size @ size and all its element is equal to @a value.
62    ///
63    DataLookup1D(const size_t size, const double value=0); 
64
65    ///
66    ///
67    ///
68    virtual ~DataLookup1D();
69
70    ///
71    /// @return number of elements
72    ///
73    size_t size(void) const;
74
75    ///
76    /// @brief access operator
77    ///
78    double operator()(const size_t i) const;
79
80    ///
81    /// @brief access operator
82    ///
83    double operator[](const size_t i) const;
84
85    ///
86    /// scalar product
87    ///
88    double operator*(const DataLookup1D&) const;
89
90  private:
91    const DataLookup1D& operator=(const DataLookup1D&);
92
93    const bool column_vector_;
94    const size_t index_;
95    const DataLookup2D* matrix_;
96    const bool owner_;
97   
98  };
99
100  ///
101  /// @brief The output operator for DataLookup1D.
102  ///
103  /**
104   * Elements are separated by the character from the omanip fill.
105   * The following example will write the elements separated by tab.
106   *
107   @verbatim
108   char prev=s.fill('\t');
109   s << v;
110   s.fill(prev);
111   @endverbatim
112  */
113  std::ostream& operator<<(std::ostream& s, const DataLookup1D& v);
114 
115}}} // of namespace classifier, yat, and theplu
116
117#endif
Note: See TracBrowser for help on using the repository browser.