toolbox::hdr::PercentileIterator Class Reference

PercentileIterator is a percentile iterator. More...

#include <toolbox/hdr/Iterator.hpp>

Inheritance diagram for toolbox::hdr::PercentileIterator:

Collaboration diagram for toolbox::hdr::PercentileIterator:

Public Member Functions
	PercentileIterator (const Histogram &h, std::int32_t ticks_per_half_distance) noexcept
	~PercentileIterator () override=default
	PercentileIterator (const PercentileIterator &)=delete
PercentileIterator &	operator= (const PercentileIterator &)=delete
	PercentileIterator (PercentileIterator &&) noexcept=default
PercentileIterator &	operator= (PercentileIterator &&)=delete
double	percentile () 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
bool	do_next () noexcept 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

Additional Inherited Members
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

PercentileIterator is a percentile iterator.

Definition at line 87 of file Iterator.hpp.

Constructor & Destructor Documentation

PercentileIterator() [1/3]

toolbox::hdr::PercentileIterator::PercentileIterator ( const Histogram &  h, std::int32_t  ticks_per_half_distance  )

noexcept

~PercentileIterator()

toolbox::hdr::PercentileIterator::~PercentileIterator ( )

overridedefault

PercentileIterator() [2/3]

toolbox::hdr::PercentileIterator::PercentileIterator ( const PercentileIterator &  )

delete

PercentileIterator() [3/3]

toolbox::hdr::PercentileIterator::PercentileIterator ( PercentileIterator &&  )

defaultnoexcept

Member Function Documentation

operator=() [1/2]

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

delete

operator=() [2/2]

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

delete

percentile()

double toolbox::hdr::PercentileIterator::percentile ( ) const

inlinenoexcept

Definition at line 100 of file Iterator.hpp.

do_next()

bool toolbox::hdr::PercentileIterator::do_next ( )

overrideprotectedvirtualnoexcept

Reimplemented from toolbox::hdr::Iterator.

Definition at line 116 of file Iterator.cpp.

---

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

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