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

Last change on this file since 882 was 882, checked in by Peter, 14 years ago

fixing includes - sorry about that

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