GNodeArray.hpp
5.12 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
/***************************************************************************
* GNodeArray.hpp - Array of nodes class *
* ----------------------------------------------------------------------- *
* copyright (C) 2008-2012 by Juergen Knoedlseder *
* ----------------------------------------------------------------------- *
* *
* This program is free software: you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation, either version 3 of the License, or *
* (at your option) any later version. *
* *
* This program is distributed in the hope that it will be useful, *
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
* GNU General Public License for more details. *
* *
* You should have received a copy of the GNU General Public License *
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
* *
***************************************************************************/
/**
* @file GNodeArray.hpp
* @brief Node array class interface definition
* @author J. Knoedlseder
*/
#ifndef GNODEARRAY_HPP
#define GNODEARRAY_HPP
/* __ Includes ___________________________________________________________ */
#include <vector>
#include <string>
#include <iostream>
#include "GLog.hpp"
#include "GVector.hpp"
/***********************************************************************//**
* @class GNodeArray
*
* @brief Interface for the node array class
*
* The node array class collects nodes \f$x_i\f$ that may be used to describe
* a functional relation \f$y_i=f(x_i)\f$. This class may be used to perform
* a linear interpolation between the nodes to determine any value of
* \f$y=f(x)\f$.
* Nodes are allocated either from a double precision array, a GVector object
* or a std::vector using the nodes() method. Alternatively, the node array
* may be built on the fly using the append() method.
* Interpolation can be either performed using the interpolate() method
* or using the set_value(). In the latter case, the node indices and
* weighting factors can be recovered using inx_left(), inx_right(),
* wgt_left() and wgt_right().
* If the nodes are equally spaced, interpolation is more rapid.
***************************************************************************/
class GNodeArray {
// I/O friends
friend std::ostream& operator<<(std::ostream& os, const GNodeArray& array);
friend GLog& operator<<(GLog& log, const GNodeArray& array);
public:
// Constructors and destructors
GNodeArray(void);
GNodeArray(const GNodeArray& array);
GNodeArray(const int& num, const double* array);
GNodeArray(const GVector& vector);
GNodeArray(const std::vector<double>& vector);
virtual ~GNodeArray(void);
// Operators
GNodeArray& operator= (const GNodeArray & array);
double& operator[](const int& index);
const double& operator[](const int& index) const;
// Methods
void clear(void);
GNodeArray* clone(void) const;
int size(void) const { return m_node.size(); }
void nodes(const int& num, const double* array);
void nodes(const GVector& vector);
void nodes(const std::vector<double>& vector);
void append(const double& node);
double interpolate(const double& value,
const std::vector<double>& vector) const;
void set_value(const double& value);
const int& inx_left(void) const { return m_inx_left; }
const int& inx_right(void) const { return m_inx_right; }
const double& wgt_left(void) const { return m_wgt_left; }
const double& wgt_right(void) const { return m_wgt_right; }
std::string print(void) const;
private:
// Methods
void init_members(void);
void copy_members(const GNodeArray& array);
void free_members(void);
void setup(void);
// Data
std::vector<double> m_node; //!< Array of nodes
std::vector<double> m_step; //!< Distance to next node
bool m_is_linear; //!< Nodes form a linear array
double m_linear_slope; //!< Slope for linear array
double m_linear_offset; //!< Offset for linear array
int m_inx_left; //!< Index of left node for linear interpolation
int m_inx_right; //!< Index of right node for linear interpolation
double m_wgt_left; //!< Weight for left node for linear interpolation
double m_wgt_right; //!< Weight for right node for linear interpolation
};
#endif /* GNODEARRAY_HPP */