toolbox::hdr::CountAddedIterator Class Reference

CountAddedIterator is a recorded value iterator. More...

#include <toolbox/hdr/Iterator.hpp>

Inheritance diagram for toolbox::hdr::CountAddedIterator:

Collaboration diagram for toolbox::hdr::CountAddedIterator:

Public Member Functions
	CountAddedIterator (const CountAddedIterator &)=delete
CountAddedIterator &	operator= (const CountAddedIterator &)=delete
	CountAddedIterator (CountAddedIterator &&) noexcept=default
CountAddedIterator &	operator= (CountAddedIterator &&)=delete
std::int64_t	count_added_in_this_iteration_step () const noexcept
Public Member Functions inherited from toolbox::hdr::Iterator
	Iterator (const Histogram &h) noexcept
virtual	~Iterator ()
	Iterator (const Iterator &)=delete
Iterator &	operator= (const Iterator &)=delete
	Iterator (Iterator &&) noexcept=default
Iterator &	operator= (Iterator &&)=delete
std::int64_t	count () const noexcept
	Value directly from array for the current counts_index.
std::int64_t	cumulative_count () const noexcept
	Sum of all of the counts up to and including the count at this index.
std::int64_t	value () const noexcept
	The current value based on counts_index.
std::int64_t	highest_equivalent_value () const noexcept
bool	next () noexcept

Protected Member Functions
	CountAddedIterator (const Histogram &h)
	~CountAddedIterator () override
Protected Member Functions inherited from toolbox::hdr::Iterator
bool	has_buckets () const noexcept
bool	has_next () const noexcept
std::int64_t	peek_next_value_from_index () const noexcept
bool	next_value_greater_than_reporting_level_upper_bound (std::int64_t reporting_level_upper_bound) const noexcept
bool	basic_next () noexcept
bool	move_next () noexcept
void	update_iterated_values (std::int64_t new_value_iterated_to) noexcept
virtual bool	do_next () noexcept

Protected Attributes
std::int64_t	count_added_in_this_iteration_step_ {0}
Protected Attributes inherited from toolbox::hdr::Iterator
const Histogram &	h_
std::int32_t	counts_index_
	Raw index into the counts array.
std::int64_t	total_count_
	Snapshot of the length at the time the iterator is created.
std::int64_t	count_
std::int64_t	cumulative_count_
std::int64_t	value_
std::int64_t	highest_equivalent_value_
std::int64_t	lowest_equivalent_value_
std::int64_t	median_equivalent_value_
std::int64_t	value_iterated_from_
std::int64_t	value_iterated_to_

Detailed Description

CountAddedIterator is a recorded value iterator.

Definition at line 113 of file Iterator.hpp.

Constructor & Destructor Documentation

CountAddedIterator() [1/3]

toolbox::hdr::CountAddedIterator::CountAddedIterator ( const CountAddedIterator &  )

delete

CountAddedIterator() [2/3]

toolbox::hdr::CountAddedIterator::CountAddedIterator ( CountAddedIterator &&  )

defaultnoexcept

CountAddedIterator() [3/3]

toolbox::hdr::CountAddedIterator::CountAddedIterator ( const Histogram &  h )

explicitprotected

Definition at line 148 of file Iterator.cpp.

~CountAddedIterator()

toolbox::hdr::CountAddedIterator::~CountAddedIterator ( )

overrideprotecteddefault

Member Function Documentation

operator=() [1/2]

CountAddedIterator & toolbox::hdr::CountAddedIterator::operator= ( const CountAddedIterator &  )

delete

operator=() [2/2]

CountAddedIterator & toolbox::hdr::CountAddedIterator::operator= ( CountAddedIterator &&  )

delete

count_added_in_this_iteration_step()

std::int64_t toolbox::hdr::CountAddedIterator::count_added_in_this_iteration_step ( ) const

inlinenoexcept

Definition at line 123 of file Iterator.hpp.

Referenced by BOOST_AUTO_TEST_CASE().

Member Data Documentation

count_added_in_this_iteration_step_

std::int64_t toolbox::hdr::CountAddedIterator::count_added_in_this_iteration_step_ {0}

protected

Definition at line 132 of file Iterator.hpp.

Referenced by toolbox::hdr::RecordedIterator::do_next(), toolbox::hdr::LinearIterator::do_next(), and toolbox::hdr::LogIterator::do_next().

---

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

• toolbox/hdr/Iterator.hpp
• toolbox/hdr/Iterator.cpp