Teuchos Package Browser (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Teuchos_Flops.hpp
Go to the documentation of this file.
1 // @HEADER
2 // ***********************************************************************
3 //
4 // Teuchos: Common Tools Package
5 // Copyright (2004) Sandia Corporation
6 //
7 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8 // license for use of this work by or on behalf of the U.S. Government.
9 //
10 // Redistribution and use in source and binary forms, with or without
11 // modification, are permitted provided that the following conditions are
12 // met:
13 //
14 // 1. Redistributions of source code must retain the above copyright
15 // notice, this list of conditions and the following disclaimer.
16 //
17 // 2. Redistributions in binary form must reproduce the above copyright
18 // notice, this list of conditions and the following disclaimer in the
19 // documentation and/or other materials provided with the distribution.
20 //
21 // 3. Neither the name of the Corporation nor the names of the
22 // contributors may be used to endorse or promote products derived from
23 // this software without specific prior written permission.
24 //
25 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 //
37 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
38 //
39 // ***********************************************************************
40 // @HEADER
41 
42 // Kris
43 // 07.08.03 -- Move into Teuchos package/namespace
44 
45 #ifndef TEUCHOS_FLOPS_HPP
46 #define TEUCHOS_FLOPS_HPP
47 
64 namespace Teuchos
65 {
66 class Flops
67 {
68  public:
69 
71 
72 
74 
78  Flops();
79 
81 
83  Flops(const Flops &flops);
84 
86 
88  virtual ~Flops();
89 
91 
93 
94 
96  double flops() const { return flops_; }
97 
99 
101 
102 
104  void resetFlops() {flops_ = 0.0;}
105 
107 
108  friend class CompObject;
109 
110  protected:
111 
112  mutable double flops_;
113 
115 
116  void updateFlops(int addflops) const {flops_ += (double) addflops; }
118 
120  void updateFlops(long int addflops) const {flops_ += (double) addflops; }
121 
123  void updateFlops(double addflops) const {flops_ += (double) addflops; }
124 
126  void updateFlops(float addflops) const {flops_ += (double) addflops; }
127 
129 
130  private:
131 
132 };
133 
134  // #include "Teuchos_Flops.cpp"
135 
136 } // namespace Teuchos
137 
138 #endif // end of TEUCHOS_FLOPS_HPP
Flops()
Default Constructor.
double flops() const
Returns the number of floating point operations with this object and resets the count.
virtual ~Flops()
Destructor.
void updateFlops(int addflops) const
Increment Flop count for this object from an int.
Functionality and data that is common to all computational classes.
void resetFlops()
Resets the number of floating point operations to zero for this multi-std::vector.
void updateFlops(double addflops) const
Increment Flop count for this object from a double.
void updateFlops(long int addflops) const
Increment Flop count for this object from a long int.
void updateFlops(float addflops) const
Increment Flop count for this object from a float.
The Teuchos Floating Point Operations Class.