Reference documentation for deal.II version 9.6.2
 
\(\newcommand{\dealvcentcolon}{\mathrel{\mathop{:}}}\) \(\newcommand{\dealcoloneq}{\dealvcentcolon\mathrel{\mkern-1.2mu}=}\) \(\newcommand{\jump}[1]{\left[\!\left[ #1 \right]\!\right]}\) \(\newcommand{\average}[1]{\left\{\!\left\{ #1 \right\}\!\right\}}\)
Loading...
Searching...
No Matches
Threads::internal::return_value< RT & > Struct Template Reference

#include <deal.II/base/thread_management.h>

Inheritance diagram for Threads::internal::return_value< RT & >:

Public Types

using reference_type = RT &
 
using reference_type
 

Public Member Functions

 return_value ()
 
reference_type get () const
 
void set (RT &v)
 
void set_from (std::future< RT & > &v)
 
 return_value ()
 
reference_type get ()
 
void set (RT &&v)
 
void set_from (std::future< RT > &v)
 

Private Attributes

RT * value
 
bool value_is_initialized
 
RT value
 
bool value_is_initialized
 

Detailed Description

template<typename RT>
struct Threads::internal::return_value< RT & >

Definition at line 291 of file thread_management.h.

Member Typedef Documentation

◆ reference_type [1/2]

template<typename RT>
using Threads::internal::return_value< RT & >::reference_type = RT &

Definition at line 298 of file thread_management.h.

◆ reference_type [2/2]

using Threads::internal::return_value< RT >::reference_type

Definition at line 228 of file thread_management.h.

Constructor & Destructor Documentation

◆ return_value() [1/2]

template<typename RT>
Threads::internal::return_value< RT & >::return_value ( )
inline

Definition at line 300 of file thread_management.h.

◆ return_value() [2/2]

Threads::internal::return_value< RT >::return_value ( )
inline

Definition at line 230 of file thread_management.h.

Member Function Documentation

◆ get() [1/2]

template<typename RT>
reference_type Threads::internal::return_value< RT & >::get ( ) const
inline

Definition at line 306 of file thread_management.h.

◆ set() [1/2]

template<typename RT>
void Threads::internal::return_value< RT & >::set ( RT & v)
inline

Definition at line 318 of file thread_management.h.

◆ set_from() [1/2]

template<typename RT>
void Threads::internal::return_value< RT & >::set_from ( std::future< RT & > & v)
inline

Set the value from the given std::future object. If the future object holds an exception, the set will not happen and this function instead throws the exception stored in the future object.

Definition at line 329 of file thread_management.h.

◆ get() [2/2]

Definition at line 236 of file thread_management.h.

◆ set() [2/2]

void Threads::internal::return_value< RT >::set ( RT && v)
inline

Definition at line 248 of file thread_management.h.

◆ set_from() [2/2]

void Threads::internal::return_value< RT >::set_from ( std::future< RT > & v)
inline

Set the value from the given std::future object. If the future object holds an exception, the set will not happen and this function instead throws the exception stored in the future object.

Definition at line 259 of file thread_management.h.

Member Data Documentation

◆ value [1/2]

template<typename RT>
RT* Threads::internal::return_value< RT & >::value
private

Definition at line 294 of file thread_management.h.

◆ value_is_initialized [1/2]

template<typename RT>
bool Threads::internal::return_value< RT & >::value_is_initialized
private

Definition at line 295 of file thread_management.h.

◆ value [2/2]

RT Threads::internal::return_value< RT >::value
private

Definition at line 224 of file thread_management.h.

◆ value_is_initialized [2/2]

bool Threads::internal::return_value< RT >::value_is_initialized
private

Definition at line 225 of file thread_management.h.


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