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

Last change on this file since 815 was 815, checked in by Peter, 15 years ago

added constructor for DataLookup1D from a utility::vector

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date ID
File size: 3.3 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#include <vector>
29
30namespace theplu {
31namespace yat {
32namespace utility {
33  class vector;
34}
35namespace classifier { 
36
37  class DataLookup2D;
38
39  ///
40  /// @brief Class for general vector view.
41  ///
42
43  class DataLookup1D
44  {
45 
46  public:
47
48    ///
49    /// Constructor.
50    ///
51    /// @param row_vector if true DataLookup1D is looking into a
52    /// row of DataLookup2D, otherwise looking into a
53    /// column. @param index which row/column to look into.
54    ///
55    DataLookup1D(const DataLookup2D&, const size_t index, 
56                 const bool row_vector);
57
58    ///
59    /// Copy constructor
60    ///
61    DataLookup1D(const DataLookup1D&);
62
63    ///
64    /// Construct DataLookup1D that owns its underlying matrix. Object
65    /// has size @ size and all its element is equal to @a value.
66    ///
67    DataLookup1D(const size_t size, const double value=0); 
68
69    /**
70       @brief Create general view from utility::vector
71   
72       Constructor creates a proper MatrixLookup that object can view
73       into. Object is owner of this underlying MatrixLookup. Object fulfills
74       \f$ x(i) = vec(index(i)) \f$
75    */
76    DataLookup1D(const utility::vector& vec, const std::vector<size_t>& index); 
77
78    /**
79       @brief Create general view from utility::vector
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(i) \f$
84    */
85    DataLookup1D(const utility::vector& vec); 
86
87    ///
88    /// @brief Destructor deletes underlying DataLookup2D if object is owner
89    ///
90    virtual ~DataLookup1D();
91
92    ///
93    /// @return number of elements
94    ///
95    size_t size(void) const;
96
97    ///
98    /// @brief access operator
99    ///
100    double operator()(const size_t i) const;
101
102    ///
103    /// @brief access operator
104    ///
105    double operator[](const size_t i) const;
106
107    ///
108    /// scalar product
109    ///
110    double operator*(const DataLookup1D&) const;
111
112  private:
113    const DataLookup1D& operator=(const DataLookup1D&);
114
115    const bool column_vector_;
116    const size_t index_;
117    const DataLookup2D* matrix_;
118    const bool owner_;
119   
120  };
121
122  ///
123  /// @brief The output operator for DataLookup1D.
124  ///
125  /**
126   * Elements are separated by the character from the omanip fill.
127   * The following example will write the elements separated by tab.
128   *
129   @verbatim
130   char prev=s.fill('\t');
131   s << v;
132   s.fill(prev);
133   @endverbatim
134  */
135  std::ostream& operator<<(std::ostream& s, const DataLookup1D& v);
136 
137}}} // of namespace classifier, yat, and theplu
138
139#endif
Note: See TracBrowser for help on using the repository browser.