Miind
RateAlgorithm.hpp
Go to the documentation of this file.
1 // Copyright (c) 2005 - 2012 Marc de Kamps
2 // 2012 David-Matthias Sichau
3 // All rights reserved.
4 //
5 // Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
6 //
7 // * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
8 // * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation
9 // and/or other materials provided with the distribution.
10 // * Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software
11 // without specific prior written permission.
12 //
13 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
14 // WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY
15 // DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
16 // USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
17 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
18 //
19 
20 #ifndef MPILIB_ALGORITHMS_RATEALGORITHM_HPP_
21 #define MPILIB_ALGORITHMS_RATEALGORITHM_HPP_
22 
23 
26 
27 
28 namespace MPILib {
32 template<class Weight>
33 class RateAlgorithm: public AlgorithmInterface<Weight> {
34 public:
35 
40  RateAlgorithm(Rate rate);
41 
42  virtual ~RateAlgorithm();
43 
48  virtual RateAlgorithm* clone() const;
49 
54  virtual void configure(const SimulationRunParameter&);
55 
62  virtual void evolveNodeState(const std::vector<Rate>& nodeVector,
63  const std::vector<Weight>& weightVector, Time time);
64 
69  virtual Time getCurrentTime() const;
70 
75  virtual Rate getCurrentRate() const;
76 
77  virtual AlgorithmGrid getGrid(NodeId, bool b_state = true) const;
78 
79 private:
80 
83 
84 };
85 
86 } /* namespace MPILib */
87 #endif /* MPILIB_ALGORITHMS_RATEALGORITHM_HPP_ */
virtual Time getCurrentTime() const
virtual Rate getCurrentRate() const
virtual void configure(const SimulationRunParameter &)
virtual AlgorithmGrid getGrid(NodeId, bool b_state=true) const
double Time
The interface for all algorithm classes.
An Algorithm with constant rate.
virtual RateAlgorithm * clone() const
virtual void evolveNodeState(const std::vector< Rate > &nodeVector, const std::vector< Weight > &weightVector, Time time)
unsigned int NodeId
Parameter determining how a simulation is run. Specifiying begin and end time, log file names...
double Rate