toolbox::hdr::BucketConfig Struct Reference

Bucket configuration. More...

#include <toolbox/hdr/Histogram.hpp>

Public Member Functions
	BucketConfig (std::int64_t lowest_trackable_value, std::int64_t highest_trackable_value, int significant_figures)
	~BucketConfig () noexcept=default
	BucketConfig (const BucketConfig &) noexcept=default
BucketConfig &	operator= (const BucketConfig &) noexcept=default
	BucketConfig (BucketConfig &&) noexcept=default
BucketConfig &	operator= (BucketConfig &&) noexcept=default

Public Attributes
std::int64_t	lowest_trackable_value
std::int64_t	highest_trackable_value
std::int32_t	significant_figures
std::int32_t	unit_magnitude
std::int32_t	sub_bucket_half_count_magnitude
std::int32_t	sub_bucket_count
std::int32_t	sub_bucket_half_count
std::int64_t	sub_bucket_mask
std::int32_t	bucket_count
std::int32_t	counts_len

Detailed Description

Bucket configuration.

Definition at line 27 of file Histogram.hpp.

Constructor & Destructor Documentation

BucketConfig() [1/3]

toolbox::hdr::BucketConfig::BucketConfig	(	std::int64_t	lowest_trackable_value,
		std::int64_t	highest_trackable_value,
		int	significant_figures
	)

Construct BucketConfig.

Due to the size of the histogram being the result of some reasonably involved math on the input parameters.

Parameters

lowest_trackable_value	The smallest possible value to be put into the histogram.
highest_trackable_value	The largest possible value to be put into the histogram.
significant_figures	The level of precision for this histogram, i.e. the number of figures in a decimal number that will be maintained. E.g. a value of 3 will mean the results from the histogram will be accurate up to the first three digits. Must be a value between 1 and 5 (inclusive).

~BucketConfig()

toolbox::hdr::BucketConfig::~BucketConfig ( )

defaultnoexcept

BucketConfig() [2/3]

toolbox::hdr::BucketConfig::BucketConfig ( const BucketConfig &  )

defaultnoexcept

BucketConfig() [3/3]

toolbox::hdr::BucketConfig::BucketConfig ( BucketConfig &&  )

defaultnoexcept

Member Function Documentation

operator=() [1/2]

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

defaultnoexcept

operator=() [2/2]

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

defaultnoexcept

Member Data Documentation

lowest_trackable_value

std::int64_t toolbox::hdr::BucketConfig::lowest_trackable_value

Definition at line 51 of file Histogram.hpp.

highest_trackable_value

std::int64_t toolbox::hdr::BucketConfig::highest_trackable_value

Definition at line 52 of file Histogram.hpp.

significant_figures

std::int32_t toolbox::hdr::BucketConfig::significant_figures

Definition at line 53 of file Histogram.hpp.

unit_magnitude

std::int32_t toolbox::hdr::BucketConfig::unit_magnitude

Definition at line 54 of file Histogram.hpp.

sub_bucket_half_count_magnitude

std::int32_t toolbox::hdr::BucketConfig::sub_bucket_half_count_magnitude

Definition at line 55 of file Histogram.hpp.

sub_bucket_count

std::int32_t toolbox::hdr::BucketConfig::sub_bucket_count

Definition at line 56 of file Histogram.hpp.

sub_bucket_half_count

std::int32_t toolbox::hdr::BucketConfig::sub_bucket_half_count

Definition at line 57 of file Histogram.hpp.

sub_bucket_mask

std::int64_t toolbox::hdr::BucketConfig::sub_bucket_mask

Definition at line 58 of file Histogram.hpp.

bucket_count

std::int32_t toolbox::hdr::BucketConfig::bucket_count

Definition at line 59 of file Histogram.hpp.

counts_len

std::int32_t toolbox::hdr::BucketConfig::counts_len

Definition at line 60 of file Histogram.hpp.

---

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

• toolbox/hdr/Histogram.hpp