Concurrency::_Range< _Index_type > Class Template Reference

#include <ppl.h>

Public Member Functions
	_Range (_Index_type _Current_iteration, _Index_type _Last_iteration)
void	_Send_range (_Range< _Index_type > *_Helper_range)
void	_Steal_range (_Range< _Index_type > *_Helper_range)
_Index_type	_Number_of_iterations () const
_Index_type	_Get_current_iteration () const
void	_Set_current_iteration (const _Index_type _I)
	__declspec (property(get=_Get_current_iteration, put=_Set_current_iteration)) _Index_type _M_current_iteration
_Index_type	_Get_last_iteration () const
void	_Set_last_iteration (const _Index_type _I)
	__declspec (property(get=_Get_last_iteration, put=_Set_last_iteration)) _Index_type _M_last_iteration

Private Attributes
volatile _Index_type	_M_current
volatile _Index_type	_M_last

Constructor & Destructor Documentation

template<typename _Index_type>

Concurrency::_Range< _Index_type >::_Range ( _Index_type  _Current_iteration, _Index_type  _Last_iteration  )

inline

                                                                        :
      _M_current(_Current_iteration), _M_last(_Last_iteration)
    {
        // On creation, the range shall have at least 1 iteration.
        _CONCRT_ASSERT(_Number_of_iterations() > 0);
    }

Member Function Documentation

template<typename _Index_type>

Concurrency::_Range< _Index_type >::__declspec

(

property(get=_Get_current_iteration, put=_Set_current_iteration)

)

template<typename _Index_type>

Concurrency::_Range< _Index_type >::__declspec

(

property(get=_Get_last_iteration, put=_Set_last_iteration)

)

template<typename _Index_type>

_Index_type Concurrency::_Range< _Index_type >::_Get_current_iteration ( ) const

inline

    {
        return _M_current;
    }

template<typename _Index_type>

_Index_type Concurrency::_Range< _Index_type >::_Get_last_iteration ( ) const

inline

    {
        return _M_last;
    }

template<typename _Index_type>

_Index_type Concurrency::_Range< _Index_type >::_Number_of_iterations ( ) const

inline

    {
        return (_M_last_iteration - _M_current_iteration);
    }

template<typename _Index_type>

void Concurrency::_Range< _Index_type >::_Send_range ( _Range< _Index_type > *  _Helper_range )

inline

    {
        // If there are no iterations other than the current one left until finish, there is no help
        // needed. Set the pointer to a special value that helper will understand and continue
        // doing the work.
        _Index_type _Remaining_iterations = _Number_of_iterations();
        if (_Remaining_iterations > 1)
        {
            // Compute the two pieces of the work range: one for the worker and one for helper class.
            _M_last_iteration = _M_current_iteration + _Remaining_iterations / 2;

            // There needs to be at least 1 iteration left because the current iteration cannot be sent.
            _CONCRT_ASSERT(_Number_of_iterations() > 0);
        }

        // This is also a signal for the helper that a range has been sent to it.
        _Helper_range->_M_current_iteration = _M_last_iteration;
    }

template<typename _Index_type>

void Concurrency::_Range< _Index_type >::_Set_current_iteration ( const _Index_type  _I )

inline

    {
        _M_current = _I;
    }

template<typename _Index_type>

void Concurrency::_Range< _Index_type >::_Set_last_iteration ( const _Index_type  _I )

inline

    {
        _M_last = _I;
    }

template<typename _Index_type>

void Concurrency::_Range< _Index_type >::_Steal_range ( _Range< _Index_type > *  _Helper_range )

inline

    {
        // We allow stealing only from a range that has at least 1 iteration
        _CONCRT_ASSERT(_Number_of_iterations() > 0);

        _Index_type _Current_iter = _M_current_iteration;

        _Helper_range->_M_current_iteration = _Current_iter + 1;
        _Helper_range->_M_last_iteration = _M_last_iteration;

        _M_last_iteration = _Current_iter + 1;
    }

Member Data Documentation

template<typename _Index_type>

volatile _Index_type Concurrency::_Range< _Index_type >::_M_current

private

template<typename _Index_type>

volatile _Index_type Concurrency::_Range< _Index_type >::_M_last

private

---

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

• VS2017/inc/ppl.h