Teuchos Package Browser (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Protected Attributes | List of all members
Teuchos::CompObject Class Reference

Functionality and data that is common to all computational classes. More...

#include <Teuchos_CompObject.hpp>

Inheritance diagram for Teuchos::CompObject:
Inheritance graph
[legend]

Protected Attributes

FlopsflopCounter_
 

Constructors/Destructor.

 CompObject ()
 Default constructor. More...
 
 CompObject (const CompObject &source)
 Copy Constructor. More...
 
virtual ~CompObject ()
 Destructor. More...
 

Set/Get counter method.

void setFlopCounter (const Flops &FlopCounter)
 Set the internal Teuchos::Flops() pointer. More...
 
void setFlopCounter (const CompObject &compObject)
 Set the internal Teuchos::Flops() pointer to the flop counter of another Teuchos::CompObject. More...
 
void unsetFlopCounter ()
 Set the internal Teuchos::Flops() pointer to 0 (no flops counted). More...
 
FlopsgetFlopCounter () const
 Get the pointer to the Teuchos::Flops() object associated with this object, returns 0 if none. More...
 

Set flop count methods.

void resetFlops () const
 Resets the number of floating point operations to zero for this multi-std::vector. More...
 
double getFlops () const
 Returns the number of floating point operations with this multi-std::vector. More...
 

Update flop count methods.

void updateFlops (int addflops) const
 Increment Flop count for this object. More...
 
void updateFlops (long int addflops) const
 Increment Flop count for this object. More...
 
void updateFlops (double addflops) const
 Increment Flop count for this object. More...
 
void updateFlops (float addflops) const
 Increment Flop count for this object. More...
 

Detailed Description

Functionality and data that is common to all computational classes.

The Teuchos::CompObject is a base class for all Teuchos computational objects. It provides the basic mechanisms and interface specifications for floating point operations using Teuchos::Flops objects.

Definition at line 33 of file Teuchos_CompObject.hpp.

Constructor & Destructor Documentation

Teuchos::CompObject::CompObject ( )

Default constructor.

Definition at line 20 of file Teuchos_CompObject.cpp.

Teuchos::CompObject::CompObject ( const CompObject source)

Copy Constructor.

Definition at line 26 of file Teuchos_CompObject.cpp.

Teuchos::CompObject::~CompObject ( )
virtual

Destructor.

Definition at line 32 of file Teuchos_CompObject.cpp.

Member Function Documentation

void Teuchos::CompObject::setFlopCounter ( const Flops FlopCounter)
inline

Set the internal Teuchos::Flops() pointer.

Definition at line 54 of file Teuchos_CompObject.hpp.

void Teuchos::CompObject::setFlopCounter ( const CompObject compObject)
inline

Set the internal Teuchos::Flops() pointer to the flop counter of another Teuchos::CompObject.

Definition at line 57 of file Teuchos_CompObject.hpp.

void Teuchos::CompObject::unsetFlopCounter ( )
inline

Set the internal Teuchos::Flops() pointer to 0 (no flops counted).

Definition at line 60 of file Teuchos_CompObject.hpp.

Flops* Teuchos::CompObject::getFlopCounter ( ) const
inline

Get the pointer to the Teuchos::Flops() object associated with this object, returns 0 if none.

Definition at line 63 of file Teuchos_CompObject.hpp.

void Teuchos::CompObject::resetFlops ( ) const
inline

Resets the number of floating point operations to zero for this multi-std::vector.

Definition at line 69 of file Teuchos_CompObject.hpp.

double Teuchos::CompObject::getFlops ( ) const
inline

Returns the number of floating point operations with this multi-std::vector.

Definition at line 72 of file Teuchos_CompObject.hpp.

void Teuchos::CompObject::updateFlops ( int  addflops) const
inline

Increment Flop count for this object.

Definition at line 78 of file Teuchos_CompObject.hpp.

void Teuchos::CompObject::updateFlops ( long int  addflops) const
inline

Increment Flop count for this object.

Definition at line 81 of file Teuchos_CompObject.hpp.

void Teuchos::CompObject::updateFlops ( double  addflops) const
inline

Increment Flop count for this object.

Definition at line 84 of file Teuchos_CompObject.hpp.

void Teuchos::CompObject::updateFlops ( float  addflops) const
inline

Increment Flop count for this object.

Definition at line 87 of file Teuchos_CompObject.hpp.

Member Data Documentation

Flops* Teuchos::CompObject::flopCounter_
protected

Definition at line 92 of file Teuchos_CompObject.hpp.


The documentation for this class was generated from the following files: