tpie::pipelining::bits::proxy_progress_indicator Class Reference

Inherits tpie::progress_indicator_base.

Public Member Functions
	proxy_progress_indicator (node &s)
void	refresh ()
	Display the indicator. More...
void	step (stream_size_type step=1)
	Record an increment to the indicator and advance the indicator. More...
void	raw_step (stream_size_type step)
virtual void	init (stream_size_type range=0)
	Initialize progress indicator. More...
virtual void	done ()
	Advance the indicator to the end. More...
virtual void	set_range (stream_size_type range)
	Set the upper bound of the counting range. More...
stream_size_type	get_current ()
	Get the current value of the step counter. More...
stream_size_type	get_range ()
	Get the maximum value of the current range. More...
execution_time_predictor *	get_time_predictor ()
void	set_time_predictor (execution_time_predictor *p)
std::string	estimated_remaining_time ()
virtual void	push_breadcrumb (const char *, description_importance)
virtual void	pop_breadcrumb ()

Protected Attributes
stream_size_type	m_range
	The upper bound of the counting range. More...
stream_size_type	m_current
	The current progress count [m_minRange...m_maxRange]. More...

Detailed Description

Definition at line 37 of file node.h.

Member Function Documentation

virtual void tpie::progress_indicator_base::done ( )

inlinevirtualinherited

Advance the indicator to the end.

Reimplemented in tpie::progress_indicator_terminal, tpie::fractional_subindicator, tpie::progress_indicator_null, and tpie::progress_indicator_subindicator.

Definition at line 140 of file progress_indicator_base.h.

Referenced by tpie::merge_sorter< T, UseProgress, pred_t >::calc(), tpie::pipelining::passive_reverser< T >::source_t< dest_t >::go(), tpie::pipelining::serialization_bits::sort_calc_t< Traits >::go(), and tpie::parallel_sort().

{}

stream_size_type tpie::progress_indicator_base::get_current ( )

inlineinherited

Get the current value of the step counter.

Definition at line 162 of file progress_indicator_base.h.

References tpie::progress_indicator_base::m_current.

Referenced by refresh().

{ return m_current; }

stream_size_type tpie::progress_indicator_base::get_range ( )

inlineinherited

Get the maximum value of the current range.

Definition at line 167 of file progress_indicator_base.h.

References tpie::progress_indicator_base::m_range.

Referenced by refresh().

{ return m_range; }

virtual void tpie::progress_indicator_base::init ( stream_size_type  range = 0 )

inlinevirtualinherited

Initialize progress indicator.

Parameters

range

The number of times step() is going to be called.

Reimplemented in tpie::fractional_subindicator, tpie::progress_indicator_null, and tpie::progress_indicator_subindicator.

Definition at line 124 of file progress_indicator_base.h.

References tpie::progress_indicator_base::m_current, tpie::progress_indicator_base::refresh(), and tpie::progress_indicator_base::set_range().

Referenced by tpie::merge_sorter< T, UseProgress, pred_t >::calc(), tpie::pipelining::passive_reverser< T >::source_t< dest_t >::go(), tpie::pipelining::serialization_bits::sort_calc_t< Traits >::go(), and tpie::parallel_sort().

                                                {
        if (range != 0) set_range(range);
        m_current = 0;
        refresh();
        
        m_start = getticks();
        m_next = 1;

#ifndef TPIE_NDEBUG
        m_lastCalled = getticks();
#endif
    }

void tpie::pipelining::bits::proxy_progress_indicator::refresh ( )

inlinevirtual

Display the indicator.

Implements tpie::progress_indicator_base.

Definition at line 657 of file node.h.

References tpie::progress_indicator_base::get_current(), tpie::progress_indicator_base::get_range(), and tpie::pipelining::node::step().

                                       {
    double proxyMax = static_cast<double>(get_range());
    double proxyCur = static_cast<double>(get_current());
    double parentMax = static_cast<double>(m_node.m_stepsTotal);
    double parentCur = static_cast<double>(m_node.m_stepsTotal-m_node.m_stepsLeft);
    double missing = parentMax*proxyCur/proxyMax - parentCur;
    if (missing < 1.0) return;
    stream_size_type times = static_cast<stream_size_type>(1.0+missing);
    times = std::min(m_node.m_stepsLeft, times);
    m_node.step(times);
}

virtual void tpie::progress_indicator_base::set_range ( stream_size_type  range )

inlinevirtualinherited

Set the upper bound of the counting range.

This method also implies a reset of the counter. In order to be able to set the uper bound independent of setting the lower bound, no range checking is done.

Parameters

range

The new upper bound.

Reimplemented in tpie::progress_indicator_null.

Definition at line 150 of file progress_indicator_base.h.

References tpie::progress_indicator_base::m_range.

Referenced by tpie::progress_indicator_base::init().

                                                   {
        m_range = range;
    }

void tpie::progress_indicator_base::step ( stream_size_type  step = 1 )

inlineinherited

Record an increment to the indicator and advance the indicator.

Definition at line 89 of file progress_indicator_base.h.

References tpie::log_debug(), tpie::progress_indicator_base::m_current, and tpie::progress_indicator_base::refresh().

Referenced by tpie::merge_sorter< T, UseProgress, pred_t >::calc(), tpie::pipelining::passive_reverser< T >::source_t< dest_t >::go(), tpie::pipelining::serialization_bits::sort_calc_t< Traits >::go(), tpie::ami::Internal_Sorter_Obj< T, Compare >::sort(), and tpie::pipelining::node::step().

                                       {
        m_current += step;
        
#ifndef TPIE_NDEBUG
        {
            ticks currentTicks = getticks();
            if (elapsed(currentTicks,m_lastCalled) > m_frequency * m_threshold * 5)
                tpie::log_debug() << "Step was not called for an estimated " 
                                  << (elapsed(currentTicks,m_lastCalled) / (m_frequency * m_threshold))
                                  << " seconds" << std::endl;;
            m_lastCalled = currentTicks;
        }
#endif  
        if (m_current > m_next) {
            ticks currentTicks = getticks();
            m_next = static_cast<stream_size_type>(
                static_cast<double>(m_current) * (elapsed(currentTicks, m_start) + m_threshold)/
                elapsed(currentTicks, m_start));
            if (m_next > m_current *2) m_next=m_current*2; //For bad guestimation in the beginning
            refresh();
        }
    }

Member Data Documentation

stream_size_type tpie::progress_indicator_base::m_current

protectedinherited

The current progress count [m_minRange...m_maxRange].

Definition at line 184 of file progress_indicator_base.h.

Referenced by tpie::progress_indicator_terminal::display_percentage(), tpie::progress_indicator_terminal::done(), tpie::progress_indicator_base::get_current(), tpie::progress_indicator_base::init(), tpie::progress_indicator_arrow::refresh(), tpie::progress_indicator_spin::refresh(), tpie::progress_indicator_arrow::reset(), and tpie::progress_indicator_base::step().

stream_size_type tpie::progress_indicator_base::m_range

protectedinherited

The upper bound of the counting range.

Definition at line 181 of file progress_indicator_base.h.

Referenced by tpie::progress_indicator_terminal::display_percentage(), tpie::progress_indicator_terminal::done(), tpie::progress_indicator_base::get_range(), tpie::progress_indicator_arrow::refresh(), and tpie::progress_indicator_base::set_range().

---

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

• pipelining/node.h