A simple histogram stat. More...

#include <statistics.hh>

Inheritance diagram for gem5::statistics::Histogram:

Public Member Functions
	Histogram (Group *parent=nullptr)

	Histogram (Group parent, const char name, const char *desc=nullptr)

	Histogram (Group parent, const char name, const units::Base unit, const char desc=nullptr)

Histogram &	init (size_type size)
	Set the parameters of this histogram. More...

Public Member Functions inherited from gem5::statistics::DistBase< Histogram, HistStor >
	DistBase (Group parent, const char name, const units::Base unit, const char desc)

void	sample (const U &v, int n=1)
	Add a value to the distribtion n times. More...

size_type	size () const
	Return the number of entries in this stat. More...

bool	zero () const
	Return true if no samples have been added. More...

void	prepare ()

void	reset ()
	Reset stat value to default. More...

void	add (DistBase &d)
	Add the argument distribution to the this distribution. More...

Public Member Functions inherited from gem5::statistics::DataWrap< Histogram, DistInfoProxy >
const Info *	info () const

	DataWrap ()=delete

	DataWrap (const DataWrap &)=delete

	DataWrap (Group parent, const char name, const units::Base unit, const char desc)

DataWrap &	operator= (const DataWrap &)=delete

Histogram &	name (const std::string &name)
	Set the name and marks this stat to print at the end of simulation. More...

const std::string &	name () const

Histogram &	setSeparator (const std::string &_sep)
	Set the character(s) used between the name and vector number on vectors, dist, etc. More...

const std::string &	setSeparator () const

Histogram &	unit (const units::Base *_unit)
	Set the unit of the stat. More...

Histogram &	desc (const std::string &_desc)
	Set the description and marks this stat to print at the end of simulation. More...

Histogram &	precision (int _precision)
	Set the precision and marks this stat to print at the end of simulation. More...

Histogram &	flags (Flags _flags)
	Set the flags and marks this stat to print at the end of simulation. More...

Histogram &	prereq (const Stat &prereq)
	Set the prerequisite stat and marks this stat to print at the end of simulation. More...

Public Member Functions inherited from gem5::statistics::InfoAccess
	InfoAccess ()

void	reset ()
	Reset the stat to the default state. More...

bool	zero () const

bool	check () const
	Check that this stat has been set up properly and is ready for use. More...

Additional Inherited Members
Public Types inherited from gem5::statistics::DistBase< Histogram, HistStor >
typedef DistInfoProxy< Histogram >	Info

typedef HistStor	Storage

typedef HistStor ::Params	Params

Public Types inherited from gem5::statistics::DataWrap< Histogram, DistInfoProxy >
typedef DistInfoProxy< Histogram >	Info

Protected Member Functions inherited from gem5::statistics::DistBase< Histogram, HistStor >
	GEM5_ALIGNED (8) char storage[sizeof(Storage)]
	The storage for this stat. More...

Storage *	data ()
	Retrieve the storage. More...

const Storage *	data () const
	Retrieve a const pointer to the storage. More...

void	doInit ()

Protected Member Functions inherited from gem5::statistics::DataWrap< Histogram, DistInfoProxy >
Histogram &	self ()

Info *	info ()

Protected Member Functions inherited from gem5::statistics::InfoAccess
void	setInfo (Group parent, Info info)
	Set up an info class for this statistic. More...

void	setParams (const StorageParams *params)
	Save Storage class parameters if any. More...

void	setInit ()
	Save Storage class parameters if any. More...

Info *	info ()
	Grab the information class for this statistic. More...

const Info *	info () const
	Grab the information class for this statistic. More...

bool	newStyleStats () const
	Check if the info is new style stats. More...

Detailed Description

A simple histogram stat.

See also: Stat, DistBase, HistStor

Definition at line 2126 of file statistics.hh.

Constructor & Destructor Documentation

◆ Histogram() [1/3]

gem5::statistics::Histogram::Histogram ( Group * parent = nullptr )

inline

Definition at line 2129 of file statistics.hh.

◆ Histogram() [2/3]

gem5::statistics::Histogram::Histogram	(	Group *	parent,
		const char *	name,
		const char *	desc = `nullptr`
	)

inline

Definition at line 2135 of file statistics.hh.

◆ Histogram() [3/3]

gem5::statistics::Histogram::Histogram	(	Group *	parent,
		const char *	name,
		const units::Base *	unit,
		const char *	desc = `nullptr`
	)

inline

Definition at line 2142 of file statistics.hh.

Member Function Documentation

◆ init()

Histogram& gem5::statistics::Histogram::init ( size_type size )

inline

Set the parameters of this histogram.

See also: HistStor::Params

Parameters

size	The number of buckets in the histogram

Returns: A reference to this histogram.

Definition at line 2154 of file statistics.hh.

References gem5::statistics::DistBase< Histogram, HistStor >::doInit(), gem5::statistics::InfoAccess::setParams(), and gem5::statistics::DistBase< Histogram, HistStor >::size().

Referenced by gem5::ruby::CacheMemory::CacheMemoryStats::CacheMemoryStats(), gem5::FlashDevice::FlashDeviceStats::FlashDeviceStats(), gem5::ruby::HTMSequencer::HTMSequencer(), gem5::ruby::AbstractController::init(), gem5::CommMonitor::MonitorStats::MonitorStats(), gem5::ruby::Profiler::ProfilerStats::ProfilerStats(), gem5::SimpleCache::SimpleCacheStats::SimpleCacheStats(), gem5::StackDistProbe::StackDistProbeStats::StackDistProbeStats(), gem5::ArmISA::TableWalker::TableWalkerStats::TableWalkerStats(), and gem5::UFSHostDevice::UFSHostDeviceStats::UFSHostDeviceStats().

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

base/statistics.hh

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Histogram() [1/3]

◆ Histogram() [2/3]

◆ Histogram() [3/3]

Member Function Documentation

◆ init()