Dune Core Modules (2.3.1)

Dune::ForEachValuePair< TupleType1, TupleType2 > Class Template Reference

Extension of ForEachValue to two tuples... More...

#include <dune/common/tupleutility.hh>

Public Member Functions

 ForEachValuePair (TupleType1 &t1, TupleType2 &t2)
 
template<class Functor >
void apply (Functor &f)
 

Detailed Description

template<class TupleType1, class TupleType2>
class Dune::ForEachValuePair< TupleType1, TupleType2 >

Extension of ForEachValue to two tuples...

This class provides the framework to process two tuples at once. It works the same as ForEachValue, just that the corresponding function object takes one argument from the first tuple and one argument from the second.

Note
You have to ensure that the two tuples you provide are compatible in the sense that they have the same length and that the objects passed to the function objects are related in meaningful way. The best way to enforce it is to build the second tuple from the existing first tuple using ForEachType.

Constructor & Destructor Documentation

◆ ForEachValuePair()

template<class TupleType1 , class TupleType2 >
Dune::ForEachValuePair< TupleType1, TupleType2 >::ForEachValuePair ( TupleType1 &  t1,
TupleType2 &  t2 
)
inline

Constructor

Parameters
t1First tuple.
t2Second tuple.

Member Function Documentation

◆ apply()

template<class TupleType1 , class TupleType2 >
template<class Functor >
void Dune::ForEachValuePair< TupleType1, TupleType2 >::apply ( Functor &  f)
inline

Applies the function object f to the pair of tuples.

Parameters
fThe function object to apply on the pair of tuples.

The documentation for this class was generated from the following file:
Creative Commons License   |  Legal Statements / Impressum  |  Hosted by TU Dresden  |  generated with Hugo v0.111.3 (Nov 13, 23:29, 2024)