Basics

Functions
	oevislib_net.Histogram.Histogram ()
	Constructs an empty Histogram object with bin size set to 1.0f, starting (and ending) the domain at 0.0f.
	oevislib_net.Histogram.Histogram (float inDomainStart, float inDomainEnd, float inBinSize)
	Constructs a new Histogram object, given start and end values for the domain and the bins' width.
	oevislib_net.Histogram.Histogram (float inDomainStart, float inBinSize, int inBinCount, double inValue=0)
	Constructs a new Histogram object, given the domain and the number of bins.
	oevislib_net.Histogram.Histogram (float inDomainStart, float inBinSize, double[] inData, int inBinCount)
	Constructs a new Histogram object from existing data.
	oevislib_net.Histogram.Histogram (Array< double > inValues, int inStartIndex=0, float inDomainStart=0.0f, float inBinSize=1.0f, Optional< int > inBinCount=null)
	Constructs a new Histogram from an existing distribution.
	oevislib_net.Histogram.Histogram (Array< float > inValues, Optional< Array< double > > inWeights=null, Optional< float > inDomainStart=null, float inBinSize=1.0f, Optional< int > inBinCount=null, bool inCyclic=false)
	Creates a new Histogram object given an array of values and their relative weights.
float	oevislib_net.Histogram.GetDomainStart ()
	Returns the domain starting value.
float	oevislib_net.Histogram.GetBinSize ()
	Returns the bin size.
int	oevislib_net.Histogram.GetBinCount ()
	Returns the number of bins.
float	oevislib_net.Histogram.GetDomainLength ()
	Returns the domain length.
float	oevislib_net.Histogram.GetDomainEnd ()
	Returns the domain end.
int	oevislib_net.Histogram.GetSize ()
	Returns the number of histogram bins.
void	oevislib_net.Histogram.SetDomainStart (float inDomainStart)
	Sets the domain starting value.
void	oevislib_net.Histogram.SetDomainStartOf (Histogram inHistogram)
	Sets the domain start value from another Histogram starting value.
void	oevislib_net.Histogram.SetBinSize (float inBinSize)
	Sets a new bin size.
void	oevislib_net.Histogram.SetBinSizeOf (Histogram inHistogram)
	Sets the same bin size as another Histogram.
void	oevislib_net.Histogram.SetBinCount (int inBinCount)
	Sets a new number of bins.
void	oevislib_net.Histogram.SetBinCountOf (Histogram inHistogram)
	Sets the same bin count of another Histogram.
double[]	oevislib_net.Histogram.GetData ()
	Returns the pointer to the array's values.
bool	oevislib_net.Histogram.HasSameDomain (Histogram inHistogram)
	Checks if two histograms have the same domain.
ByteBuffer	oevislib_net.Histogram.Serialize ()
	Serialize the Histogram object using flatbuffers.
static Histogram	oevislib_net.Histogram.Deserialize (ByteBuffer inBuffer)
	De-serialize a Histogram buffer.
float	oevislib_net.Histogram.GetBinStart (int inIndex, bool inCyclic=false, bool inInverse=false, Optional< double > outValue=null)
	Returns the lower bound of a specific histogram bar.
float	oevislib_net.Histogram.GetBinEnd (int inIndex, bool inCyclic=false, bool inInverse=false, Optional< double > outValue=null)
	Returns the upper bound of a specific histogram bar.
void	oevislib_net.Histogram.SetBin (int inIndex, double inValue, bool inCyclic, bool inInverse)
	Sets the value of a specific bin.
double	oevislib_net.Histogram.GetBinValue (float inBin, bool inCyclic)
	Returns the value of the bin of which inBin is part.
void	oevislib_net.Histogram.SetBinValue (float inBin, double inValue, bool inCyclic)
	Sets the value of the bin of which inBinValue is part.
Array< int >	oevislib_net.Histogram.GetIndices ()
	Returns the array of indices for the histogram (increasing values starting from 0).

Detailed Description

Function Documentation

Deserialize()

Histogram oevislib_net.Histogram.Deserialize ( ByteBuffer inBuffer )

inlinestatic

De-serialize a Histogram buffer.

Parameters

inBuffer

Buffer containing the object.

Returns

Deserialized object.

GetBinCount()

int oevislib_net.Histogram.GetBinCount ( )

inline

Returns the number of bins.

Returns

Bins.

GetBinEnd()

float oevislib_net.Histogram.GetBinEnd ( int inIndex, bool inCyclic = false, bool inInverse = false, Optional< double > outValue = null )

inline

Returns the upper bound of a specific histogram bar.

Parameters

inIndex	Bin index. Range: [0, +inf).
inCyclic	Whether to consider the histogram as cyclic.
inInverse	Whether to start searching from the end.
outValue	Bin's value.

Returns

Upper bound of the bin.

GetBinSize()

float oevislib_net.Histogram.GetBinSize ( )

inline

Returns the bin size.

Returns

float Bin size.

GetBinStart()

float oevislib_net.Histogram.GetBinStart ( int inIndex, bool inCyclic = false, bool inInverse = false, Optional< double > outValue = null )

inline

Returns the lower bound of a specific histogram bar.

Parameters

inIndex	Bin index. Range: [0, +inf).
inCyclic	Whether to consider the histogram as cyclic.
inInverse	Whether to start searching from the end.
outValue	Bin's value.

Returns

Lower bound of the bin.

GetBinValue()

double oevislib_net.Histogram.GetBinValue ( float inBin, bool inCyclic )

inline

Returns the value of the bin of which inBin is part.

Parameters

inBin	Value in the histogram domain used to select the bin.
inCyclic	Whether to consider the histogram as cyclic.

Returns

Bin's value.

GetData()

double[] oevislib_net.Histogram.GetData ( )

inline

Returns the pointer to the array's values.

Returns

Pointer to the distribution.

GetDomainEnd()

float oevislib_net.Histogram.GetDomainEnd ( )

inline

Returns the domain end.

Returns

float Domain end.

GetDomainLength()

float oevislib_net.Histogram.GetDomainLength ( )

inline

Returns the domain length.

Returns

float Domain length.

GetDomainStart()

float oevislib_net.Histogram.GetDomainStart ( )

inline

Returns the domain starting value.

Returns

float Domain start.

GetIndices()

Array< int > oevislib_net.Histogram.GetIndices ( )

inline

Returns the array of indices for the histogram (increasing values starting from 0).

Returns

Output indices.

GetSize()

int oevislib_net.Histogram.GetSize ( )

inline

Returns the number of histogram bins.

Returns

Number of bins.

HasSameDomain()

bool oevislib_net.Histogram.HasSameDomain ( Histogram inHistogram )

inline

Checks if two histograms have the same domain.

Parameters

inHistogram

Another Histogram object.

Returns

If the two have the same domain.

Histogram() [1/6]

oevislib_net.Histogram.Histogram ( )

inline

Constructs an empty Histogram object with bin size set to 1.0f, starting (and ending) the domain at 0.0f.

Histogram() [2/6]

oevislib_net.Histogram.Histogram ( Array< double > inValues, int inStartIndex = 0, float inDomainStart = 0::0f, float inBinSize = 1::0f, Optional< int > inBinCount = null )

inline

Constructs a new Histogram from an existing distribution.

Parameters

inValues	Bin values.
inStartIndex	Index of the first array bin from which to copy the values. Range: [0, +inf).
inDomainStart	Domain start.
inBinSize	Bin size. Range: (0, +inf).
inBinCount	Number of bins in the resulting histogram. Range: (0, +inf).

Histogram() [3/6]

oevislib_net.Histogram.Histogram ( Array< float > inValues, Optional< Array< double > > inWeights = null, Optional< float > inDomainStart = null, float inBinSize = 1::0f, Optional< int > inBinCount = null, bool inCyclic = false )

inline

Creates a new Histogram object given an array of values and their relative weights.

Parameters

inValues	Array from which histogram will be generated.
inWeights	Weights for every element of inValues.
inDomainStart	Domain start.
inBinSize	Bin size. Range: (0, +inf).
inBinCount	Number of bins. Range: (0, +inf).
inCyclic	Whether to consider the input data as cyclic.

Histogram() [4/6]

oevislib_net.Histogram.Histogram ( float inDomainStart, float inBinSize, double[] inData, int inBinCount )

inline

Constructs a new Histogram object from existing data.

Parameters

inDomainStart	Start value.
inBinSize	Bin size. Range: (0, +inf).
inData	Data pointer.
inBinCount	Number of bins. Range: (0, +inf).

Histogram() [5/6]

oevislib_net.Histogram.Histogram ( float inDomainStart, float inBinSize, int inBinCount, double inValue = 0 )

inline

Constructs a new Histogram object, given the domain and the number of bins.

Parameters

inDomainStart	Start value.
inBinSize	Bin size.
inBinCount	Number of bins. Range: [1, +inf).
inValue	Default value for all bins.

Histogram() [6/6]

oevislib_net.Histogram.Histogram ( float inDomainStart, float inDomainEnd, float inBinSize )

inline

Constructs a new Histogram object, given start and end values for the domain and the bins' width.

Parameters

inDomainStart	Start value.
inDomainEnd	End value.
inBinSize	Bin size. Range: (0, +inf).

Serialize()

ByteBuffer oevislib_net.Histogram.Serialize ( )

inline

Serialize the Histogram object using flatbuffers.

Returns

Buffer where the object is stored.

SetBin()

void oevislib_net.Histogram.SetBin ( int inIndex, double inValue, bool inCyclic, bool inInverse )

inline

Sets the value of a specific bin.

Parameters

inIndex	Input bin index. Range: [0, +inf).
inValue	Input value.
inCyclic	Whether to consider the histogram as cyclic.
inInverse	Whether to start searching from the end.

SetBinCount()

void oevislib_net.Histogram.SetBinCount ( int inBinCount )

inline

Sets a new number of bins.

Parameters

inBinCount

Bins. Range: (0, +inf).

SetBinCountOf()

void oevislib_net.Histogram.SetBinCountOf ( Histogram inHistogram )

inline

Sets the same bin count of another Histogram.

Parameters

inHistogram

Another Histogram object.

SetBinSize()

void oevislib_net.Histogram.SetBinSize ( float inBinSize )

inline

Sets a new bin size.

Parameters

inBinSize

Bin size. Range: (0, +inf).

SetBinSizeOf()

void oevislib_net.Histogram.SetBinSizeOf ( Histogram inHistogram )

inline

Sets the same bin size as another Histogram.

Parameters

inHistogram

Another Histogram object.

SetBinValue()

void oevislib_net.Histogram.SetBinValue ( float inBin, double inValue, bool inCyclic )

inline

Sets the value of the bin of which inBinValue is part.

Parameters

inBin	Value in the histogram domain used to select the bin.
inValue	Input value for the bin.
inCyclic	Whether to consider the histogram as cyclic.

SetDomainStart()

void oevislib_net.Histogram.SetDomainStart ( float inDomainStart )

inline

Sets the domain starting value.

Parameters

inDomainStart

Domain start.

SetDomainStartOf()

void oevislib_net.Histogram.SetDomainStartOf ( Histogram inHistogram )

inline

Sets the domain start value from another Histogram starting value.

Parameters

inHistogram

Another Histogram object.