Cantera  2.0
Public Member Functions | Public Attributes | List of all members
timesConstant< T > Struct Template Reference

Unary operator to multiply the argument by a constant. More...

#include <utilities.h>

Inherits unary_function< T, double >.

Public Member Functions

 timesConstant (T c)
 Constructor.
 
double operator() (T x)
 Parenthesis operator returning a double.
 

Public Attributes

m_c
 Stored constant value of time T.
 

Detailed Description

template<class T>
struct timesConstant< T >

Unary operator to multiply the argument by a constant.

The form of this operator is designed for use by std::transform.

See Also
scale().

Definition at line 28 of file utilities.h.

Constructor & Destructor Documentation

timesConstant ( c)
inline

Constructor.

Parameters
cConstant of templated type T that will be stored internally within the object and used in the multiplication operation

Definition at line 35 of file utilities.h.

Member Function Documentation

double operator() ( x)
inline

Parenthesis operator returning a double.

Parameters
xVariable of templated type T that will be used in the multiplication operator
Returns
Returns a value of type double from the internal multiplication

Definition at line 45 of file utilities.h.

References timesConstant< T >::m_c.

Member Data Documentation

T m_c

Stored constant value of time T.

Definition at line 50 of file utilities.h.

Referenced by timesConstant< T >::operator()().


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