AbstractFunction.h 5.61 KB
Newer Older
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
// ============================================================================
// ==                                                                        ==
// == AMDiS - Adaptive multidimensional simulations                          ==
// ==                                                                        ==
// ============================================================================
// ==                                                                        ==
// ==  crystal growth group                                                  ==
// ==                                                                        ==
// ==  Stiftung caesar                                                       ==
// ==  Ludwig-Erhard-Allee 2                                                 ==
// ==  53175 Bonn                                                            ==
// ==  germany                                                               ==
// ==                                                                        ==
// ============================================================================
// ==                                                                        ==
// ==  http://www.caesar.de/cg/AMDiS                                         ==
// ==                                                                        ==
// ============================================================================

/** \file AbstractFunction.h */

#ifndef AMDIS_ABSTRACTFUNCTION_H
#define AMDIS_ABSTRACTFUNCTION_H

#include "Global.h"
#include "MemoryManager.h"

namespace AMDiS {

  // ============================================================================
  // ===== class AbstractFunction ===============================================
  // ============================================================================

  /** 
   * \ingroup Common
   * 
   * \brief
   * An AbstractFunction object represents a function 
   * f : ArgumentType -> ReturnType. 
   *
   * AbstractFunction is a pure virtual class interface class.
   * To create your own function you have to derive AbstractFunction and
   * overload operator(). 
   */
  template<typename ReturnType, typename ArgumentType>
  class AbstractFunction
  {
  public:
    /** \brief
     * Constructor.
     */
    AbstractFunction(int degree = 0) : degree_(degree) {};

    virtual ~AbstractFunction() {};

    /** \brief
     * Returns \ref degree_.
     */
    inline int getDegree() const { return degree_; };

    /** \brief
     * Deligates the evaluation to overriden method f.
     */
    virtual const ReturnType& operator()(const ArgumentType& x) const = 0;

  protected:
    int degree_;
  };

  // ============================================================================
  // ===== class BinaryAbstractFunction =========================================
  // ============================================================================

  /**
   * \ingroup Common
   *
   * \brief
   * Interface for binary functions. 
   */
  template<typename ReturnType, 
	   typename ArgumentType1, 
	   typename ArgumentType2>
  class BinaryAbstractFunction
  {
  public:
    /** \brief
     * Constructor.
     */
    BinaryAbstractFunction(int degree = 0) : degree_(degree) {};

    virtual ~BinaryAbstractFunction() {};

    /** \brief
     * Returns \ref degree_.
     */
96
97
98
    inline int getDegree() const { 
      return degree_; 
    };
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136

    /** \brief
     * Deligates the evaluation to overriden method f.
     */
    virtual const ReturnType& operator()(const ArgumentType1& x,
					 const ArgumentType2& y) const = 0;

  protected:
    int degree_;
  };

  // ============================================================================
  // ===== class TertiaryAbstractFunction =======================================
  // ============================================================================

  /**
   * \ingroup Common
   *
   * \brief
   * Interface for tertiary functions. 
   */
  template<typename ReturnType, 
	   typename ArgumentType1, 
	   typename ArgumentType2,
	   typename ArgumentType3>
  class TertiaryAbstractFunction
  {
  public:
    /** \brief
     * Constructor.
     */
    TertiaryAbstractFunction(int degree = 0) : degree_(degree) {};

    virtual ~TertiaryAbstractFunction() {};

    /** \brief
     * Returns \ref degree_.
     */
137
138
139
    inline int getDegree() const { 
      return degree_; 
    };
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180

    /** \brief
     * function evaluation.
     */
    virtual const ReturnType& operator()(const ArgumentType1& x,
					 const ArgumentType2& y,
					 const ArgumentType3& z) const = 0;

  protected:
    int degree_;
  };


  // ============================================================================
  // ===== class QuartAbstractFunction =======================================
  // ============================================================================

  /**
   * \ingroup Common
   *
   * \brief
   * Interface for quart functions. 
   */
  template<typename ReturnType, 
	   typename ArgumentType1, 
	   typename ArgumentType2, 
	   typename ArgumentType3,
	   typename ArgumentType4>
  class QuartAbstractFunction
  {
  public:
    /** \brief
     * Constructor.
     */
    QuartAbstractFunction(int degree = 0) : degree_(degree) {};

    virtual ~QuartAbstractFunction() {};

    /** \brief
     * Returns \ref degree_.
     */
181
182
183
    inline int getDegree() const { 
      return degree_; 
    };
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202

    /** \brief
     * function evaluation.
     */
    virtual const ReturnType& operator()(const ArgumentType1& x,
					 const ArgumentType2& y,
					 const ArgumentType3& z,
					 const ArgumentType4& u) const = 0;

  protected:
    int degree_;
  };




}

#endif // AMDIS_ABSTRACTFUNCTION_H