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/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 "MatrixLookup.h" |
---|
30 | #include "yat/utility/Container2DIterator.h" |
---|
31 | #include "yat/utility/iterator_traits.h" |
---|
32 | #include "yat/utility/StrideIterator.h" |
---|
33 | |
---|
34 | #include <iostream> |
---|
35 | #include <vector> |
---|
36 | |
---|
37 | namespace theplu { |
---|
38 | namespace yat { |
---|
39 | namespace utility { |
---|
40 | class VectorBase; |
---|
41 | } |
---|
42 | namespace classifier { |
---|
43 | |
---|
44 | /// |
---|
45 | /// @brief Class for general vector view. |
---|
46 | /// |
---|
47 | class DataLookup1D |
---|
48 | { |
---|
49 | public: |
---|
50 | /// 'Read Only' iterator |
---|
51 | typedef utility::StrideIterator< |
---|
52 | utility::Container2DIterator<const MatrixLookup, const double, void, |
---|
53 | const double> > |
---|
54 | const_iterator; |
---|
55 | |
---|
56 | /// |
---|
57 | /// Constructor. |
---|
58 | /// |
---|
59 | /// \param m MatrixLookup to look into |
---|
60 | /// @param row_vector if true DataLookup1D is looking into a |
---|
61 | /// row of MatrixLookup, otherwise looking into a |
---|
62 | /// column. @param index which row/column to look into. |
---|
63 | /// |
---|
64 | DataLookup1D(const MatrixLookup& m, const size_t index, |
---|
65 | const bool row_vector); |
---|
66 | |
---|
67 | /// |
---|
68 | /// Copy constructor |
---|
69 | /// |
---|
70 | DataLookup1D(const DataLookup1D&); |
---|
71 | |
---|
72 | /// |
---|
73 | /// Construct DataLookup1D that owns its underlying matrix. Object |
---|
74 | /// has size @ size and all its element is equal to @a value. |
---|
75 | /// |
---|
76 | DataLookup1D(const size_t size, const double value=0); |
---|
77 | |
---|
78 | /** |
---|
79 | @brief Create general view from utility::VectorBase |
---|
80 | |
---|
81 | Constructor creates a proper MatrixLookup that object can view |
---|
82 | into. Object is owner of this underlying MatrixLookup. Object fulfills |
---|
83 | \f$ x(i) = vec(index(i)) \f$ |
---|
84 | */ |
---|
85 | DataLookup1D(const utility::VectorBase& vec, |
---|
86 | const std::vector<size_t>& index); |
---|
87 | |
---|
88 | /** |
---|
89 | @brief Create general view from utility::VectorBase |
---|
90 | |
---|
91 | Constructor creates a proper MatrixLookup that object can view |
---|
92 | into. Object is owner of this underlying MatrixLookup. Object fulfills |
---|
93 | \f$ x(i) = vec(i) \f$ |
---|
94 | */ |
---|
95 | DataLookup1D(const utility::VectorBase& vec); |
---|
96 | |
---|
97 | /// |
---|
98 | /// @brief Destructor deletes underlying MatrixLookup if object is owner |
---|
99 | /// |
---|
100 | virtual ~DataLookup1D(); |
---|
101 | |
---|
102 | /** |
---|
103 | \return 'Read Only' iterator to first element. |
---|
104 | */ |
---|
105 | const_iterator begin() const; |
---|
106 | |
---|
107 | /** |
---|
108 | \return 'Read Only' iterator to end of DataLookup1D. |
---|
109 | */ |
---|
110 | const_iterator end() const; |
---|
111 | |
---|
112 | /// |
---|
113 | /// @return number of elements |
---|
114 | /// |
---|
115 | size_t size(void) 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 MatrixLookup* 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 |
---|