Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Core > ProfilingDebugging > FHistogram

Light Theme

Dark Theme

FHistogram

Fairly generic histogram for values that have natural lower bound and possibly no upper bound, e.g., frame time

Windows

MacOS

Linux

References

Module	Core
Header	/Engine/Source/Runtime/Core/Public/ProfilingDebugging/Histogram.h
Include	#include "ProfilingDebugging/Histogram.h"

Syntax

struct FHistogram

Remarks

Fairly generic histogram for values that have natural lower bound and possibly no upper bound, e.g., frame time

Variables

	Name	Description
TArray< FBin >	Bins	Bins themselves, should be continous in terms of [MinValue; UpperBound) and sorted ascending by MinValue.
int64	CountOfAllMeasures
friend	FHistogramBuilder	This is exposed as a clean way to build bins while enforcing the condition mentioned above
double	MaximalMeasurement
double	MinimalMeasurement
double	SumOfAllMeasures	Quick stats for all bins

Functions

	Name	Description
void	AddMeasurement ( double Value )	Adds an observed measurement.
void	AddMeasurement ( double ValueForBinning, double MeasurementValue )	Adds an observed measurement (with a different thresholding key than the measurement, e.g., when accumulating time spent in a chart keyed on framerate).
FString	DefaultConvertBinToLabel ( double MinValue, double UpperBound )	Default stringifier for bins for use with DumpToJsonString.
FString	DumpToJsonString ( TFunctionRef< FString(double, doubl... )	Returns a string in a Json format: [{"Bin":"BinName","Count":Count,"Sum":Sum},...].
FString	DumpToJsonString()	Same as DumpToJsonString but uses a DefaultConvertBinToLabel.
FString	DumpToJsonString2 ( TFunctionRef< FString(double, doubl... )	Returns a string in a Json format: [{"BinName":{"Count":Count,"Sum":Sum}},...].
FString	DumpToJsonString2()	Same as DumpToJsonString2 but uses a DefaultConvertBinToLabel.
void	DumpToLog ( const FString& HistogramName )	Prints histogram contents to the log.
double	GetAverageOfAllMeasures()	Returns the average of all measurements (essentially a shortcut for Sum/Count).
double	GetBinLowerBound ( int IdxBin )	Gets lower bound of the bin, i.e. minimum value that goes into it.
int32	GetBinObservationsCount ( int IdxBin )	Gets number of observations in the bin.
double	GetBinObservationsSum ( int IdxBin )	Gets sum of observations in the bin.
double	GetBinUpperBound ( int IdxBin )	Gets upper bound of the bin, i.e. first value that does not go into it.
double	GetMaxOfAllMeasures()	Returns the maximum of all measurements.
double	GetMinOfAllMeasures()	Returns the minimum of all measurements.
int32	GetNumBins()	Gets number of bins.
int64	GetNumMeasurements()	Returns the sum of all counts (the number of recorded measurements)
double	GetSumOfAllMeasures()	Returns the sum of all measurements
void	InitFromArray ( std::initializer_list< double > Thr... )	Inits histogram with the specified bin boundaries, with the final bucket extending to infinity (e.g., passing in 0,5 creates a [0..5) bucket and a [5..infinity) bucket)
void	InitFromArray ( TArrayView< const double > Threshol... )	Inits histogram with the specified bin boundaries, with the final bucket extending to infinity (e.g., passing in 0,5 creates a [0..5) bucket and a [5..infinity) bucket)
void	InitHitchTracking()	Inits histogram to mimic our existing hitch buckets
void	InitLinear ( double MinTime, double MaxTime, double BinSize )	Inits histogram with linear, equally sized bins
void	Reset()	Resets measurements, without resetting the configured bins.

Operators

		Name	Description
	FHistogram	operator- ( const FHistogram& Other )
	FHistogram	operator+ ( const FHistogram& Other )
	FHistogram &	operator+= ( const FHistogram& Other )

Classes

	Name	Description
	FBin	Bin

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss