Stokhos Package Browser (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Protected Attributes | List of all members
Stokhos::LinearGrowthRule< value_type > Class Template Reference

A linear growth rule. More...

#include <Stokhos_GrowthRules.hpp>

Inheritance diagram for Stokhos::LinearGrowthRule< value_type >:
Inheritance graph
[legend]

Public Member Functions

 LinearGrowthRule (const value_type &a_=value_type(1), const value_type &b_=value_type(0))
 Constructor. More...
 
virtual ~LinearGrowthRule ()
 Destructor. More...
 
virtual value_type operator() (const value_type &x) const
 Evaluate growth rule. More...
 
- Public Member Functions inherited from Stokhos::GrowthRule< value_type >
 GrowthRule ()
 Constructor. More...
 
virtual ~GrowthRule ()
 Destructor. More...
 

Protected Attributes

value_type a
 Slope. More...
 
value_type b
 Offset. More...
 

Detailed Description

template<typename value_type>
class Stokhos::LinearGrowthRule< value_type >

A linear growth rule.

Definition at line 78 of file Stokhos_GrowthRules.hpp.

Constructor & Destructor Documentation

template<typename value_type >
Stokhos::LinearGrowthRule< value_type >::LinearGrowthRule ( const value_type &  a_ = value_type(1),
const value_type &  b_ = value_type(0) 
)
inline

Constructor.

Definition at line 81 of file Stokhos_GrowthRules.hpp.

template<typename value_type >
virtual Stokhos::LinearGrowthRule< value_type >::~LinearGrowthRule ( )
inlinevirtual

Destructor.

Definition at line 86 of file Stokhos_GrowthRules.hpp.

Member Function Documentation

template<typename value_type >
virtual value_type Stokhos::LinearGrowthRule< value_type >::operator() ( const value_type &  x) const
inlinevirtual

Evaluate growth rule.

Implements Stokhos::GrowthRule< value_type >.

Definition at line 89 of file Stokhos_GrowthRules.hpp.

Member Data Documentation

template<typename value_type >
value_type Stokhos::LinearGrowthRule< value_type >::a
protected

Slope.

Definition at line 94 of file Stokhos_GrowthRules.hpp.

template<typename value_type >
value_type Stokhos::LinearGrowthRule< value_type >::b
protected

Offset.

Definition at line 97 of file Stokhos_GrowthRules.hpp.


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