Chemical Data Processing Library C++ API - Version 1.2.0
Public Member Functions | List of all members
CDPL::Util::PropertyValueProduct< ResType, PropertyValueType > Class Template Reference

A binary functor that calculates the product of two property values retrieved from a pair of Base::PropertyContainer instances passed as argument. More...

#include <PropertyValueProduct.hpp>

Public Member Functions

 PropertyValueProduct (const Base::LookupKey &key)
 Constructs a PropertyValueProduct instance for the property specified by key. More...
 
ResType operator() (const Base::PropertyContainer &cntnr1, const Base::PropertyContainer &cntnr2) const
 Calculates the product of the property values stored in the Base::PropertyContainer instances cntnr1 and cntnr2. More...
 

Detailed Description

template<typename ResType, typename PropertyValueType = ResType>
class CDPL::Util::PropertyValueProduct< ResType, PropertyValueType >

A binary functor that calculates the product of two property values retrieved from a pair of Base::PropertyContainer instances passed as argument.

Template Parameters
ResTypeThe result type.
PropertyValueTypeThe property value type.

Constructor & Destructor Documentation

◆ PropertyValueProduct()

template<typename ResType , typename PropertyValueType = ResType>
CDPL::Util::PropertyValueProduct< ResType, PropertyValueType >::PropertyValueProduct ( const Base::LookupKey key)
inline

Constructs a PropertyValueProduct instance for the property specified by key.

Parameters
keyThe key of the property.

Member Function Documentation

◆ operator()()

template<typename ResType , typename PropertyValueType = ResType>
ResType CDPL::Util::PropertyValueProduct< ResType, PropertyValueType >::operator() ( const Base::PropertyContainer cntnr1,
const Base::PropertyContainer cntnr2 
) const
inline

Calculates the product of the property values stored in the Base::PropertyContainer instances cntnr1 and cntnr2.

Parameters
cntnr1The Base::PropertyContainer instance storing the first property value.
cntnr2The Base::PropertyContainer instance storing the second property value.
Returns
The product of the property values.

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