google_dataflow_api::Histogram Class Reference

#include <histogram.h>

Inheritance diagram for google_dataflow_api::Histogram:

Public Member Functions
	Histogram (const Json::Value &storage)
	Histogram (Json::Value *storage)
virtual	~Histogram ()
const StringPiece	GetTypeName () const
bool	has_bucket_counts () const
void	clear_bucket_counts ()
const client::JsonCppArray< int64 >	get_bucket_counts () const
client::JsonCppArray< int64 >	mutable_bucketCounts ()
bool	has_first_bucket_offset () const
void	clear_first_bucket_offset ()
int32	get_first_bucket_offset () const
void	set_first_bucket_offset (int32 value)

Static Public Member Functions
static Histogram *	New ()

Detailed Description

Histogram of value counts for a distribution.

Buckets have an inclusive lower bound and exclusive upper bound and use "1,2,5 bucketing": The first bucket range is from [0,1) and all subsequent bucket boundaries are powers of ten multiplied by 1, 2, or 5. Thus, bucket boundaries are 0, 1, 2, 5, 10, 20, 50, 100, 200, 500, 1000, ... Negative values are not supported.

Constructor & Destructor Documentation

Histogram() [1/2]

google_dataflow_api::Histogram::Histogram ( const Json::Value &  storage )

explicit

Standard constructor for an immutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

Histogram() [2/2]

google_dataflow_api::Histogram::Histogram ( Json::Value *  storage )

explicit

Standard constructor for a mutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

~Histogram()

google_dataflow_api::Histogram::~Histogram ( )

virtual

Standard destructor.

Member Function Documentation

clear_bucket_counts()

void google_dataflow_api::Histogram::clear_bucket_counts ( )

inline

Clears the 'bucketCounts' attribute.

clear_first_bucket_offset()

void google_dataflow_api::Histogram::clear_first_bucket_offset ( )

inline

Clears the 'firstBucketOffset' attribute.

get_bucket_counts()

const client::JsonCppArray<int64 > google_dataflow_api::Histogram::get_bucket_counts ( ) const

inline

Get a reference to the value of the 'bucketCounts' attribute.

get_first_bucket_offset()

int32 google_dataflow_api::Histogram::get_first_bucket_offset ( ) const

inline

Get the value of the 'firstBucketOffset' attribute.

GetTypeName()

const StringPiece google_dataflow_api::Histogram::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns

google_dataflow_api::Histogram

has_bucket_counts()

bool google_dataflow_api::Histogram::has_bucket_counts ( ) const

inline

Determine if the 'bucketCounts' attribute was set.

Returns

true if the 'bucketCounts' attribute was set.

has_first_bucket_offset()

bool google_dataflow_api::Histogram::has_first_bucket_offset ( ) const

inline

Determine if the 'firstBucketOffset' attribute was set.

Returns

true if the 'firstBucketOffset' attribute was set.

mutable_bucketCounts()

client::JsonCppArray<int64 > google_dataflow_api::Histogram::mutable_bucketCounts ( )

inline

Gets a reference to a mutable value of the 'bucketCounts' property.

Counts of values in each bucket. For efficiency, prefix and trailing buckets with count = 0 are elided. Buckets can store the full range of values of an unsigned long, with ULLONG_MAX falling into the 59th bucket with range [1e19, 2e19).

Returns

The result can be modified to change the attribute value.

New()

Histogram * google_dataflow_api::Histogram::New ( )

static

Creates a new default instance.

Returns

Ownership is passed back to the caller.

set_first_bucket_offset()

void google_dataflow_api::Histogram::set_first_bucket_offset ( int32  value )

inline

Change the 'firstBucketOffset' attribute.

Starting index of first stored bucket. The non-inclusive upper-bound of the ith bucket is given by: pow(10,(i-first_bucket_offset)/3) * (1,2,5)[(i-first_bucket_offset)%3].

Parameters

[in]

value

The new value.

---

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

• google/dataflow_api/histogram.h
• google/dataflow_api/histogram.cc