Histogram2D< Key, Value, BinType > Class Template Reference

#include <Histogram2D.h>

List of all members.

Public Types
typedef std::pair< Key, Key >	Keys
typedef OutOfRangeException	OutOfRange
Public Member Functions
void	addToBin (const Key &x, const Key &y, const Value &v)
void	addToBin (const Keys &k, const Value &v)
BinType &	bin (const Key &x, const Key &y)
const BinType &	bin (const Key &x, const Key &y) const
BinType &	bin (const Keys &k)
const BinType &	bin (const Keys &k) const
void	getMaxBin (BinType &bin, Key &x, Key &y) const
void	getMaxBin (BinType &bin, Keys &k) const
template<class Comp >
void	getMaxBin (BinType &bin, Key &x, Key &y, Comp comp) const
template<class Comp >
void	getMaxBin (BinType &bin, Keys &k, Comp comp) const
	Histogram2D (const Key &minX, const Key &maxX, const Key &minY, const Key &maxY, const Key &binSize)
	Constructor.
	Histogram2D (const Keys &min, const Keys &max, const Key &binSize)
Protected Types
typedef std::vector< BinType >	Bins
Protected Member Functions
size_t	getIdx (const Key &x, const Key &y) const
size_t	getIdx (const size_t &xIdx, const size_t &yIdx) const
Keys	getKeys (const size_t &idx) const
Protected Attributes
Bins	mBins
Key	mBinSize
Key	mMaxX
Key	mMaxY
Key	mMinX
Key	mMinY
unsigned int	mXSpan
unsigned int	mYSpan

---

Detailed Description

template<class Key, class Value, class BinType = Value>
class Histogram2D< Key, Value, BinType >

Definition at line 46 of file Histogram2D.h.

---

Member Typedef Documentation

template<class Key, class Value, class BinType = Value>

typedef std::vector<BinType> Histogram2D< Key, Value, BinType >::Bins [protected]

Definition at line 95 of file Histogram2D.h.

template<class Key, class Value, class BinType = Value>

typedef std::pair<Key, Key> Histogram2D< Key, Value, BinType >::Keys

Reimplemented in TriangleDistributionHistogram2D.

Definition at line 49 of file Histogram2D.h.

template<class Key, class Value, class BinType = Value>

typedef OutOfRangeException Histogram2D< Key, Value, BinType >::OutOfRange

Definition at line 48 of file Histogram2D.h.

---

Constructor & Destructor Documentation

template<class Key, class Value, class BinType = Value>

Histogram2D< Key, Value, BinType >::Histogram2D	(	const Key &	minX,
		const Key &	maxX,
		const Key &	minY,
		const Key &	maxY,
		const Key &	binSize
	)		[inline]

Constructor.

Parameters:

min	minimum key value (inclusive).
max	maximum key value (inclusive). The key max itself is allocated to the last bin.
binSize	the size of one bin.

Definition at line 56 of file Histogram2D.h.

template<class Key, class Value, class BinType = Value>

Histogram2D< Key, Value, BinType >::Histogram2D	(	const Keys &	min,
		const Keys &	max,
		const Key &	binSize
	)		[inline]

Definition at line 62 of file Histogram2D.h.

---

Member Function Documentation

template<class Key, class Value, class BinType = Value>

void Histogram2D< Key, Value, BinType >::addToBin	(	const Key &	x,
		const Key &	y,
		const Value &	v
	)		[inline]

Definition at line 73 of file Histogram2D.h.

template<class Key, class Value, class BinType = Value>

void Histogram2D< Key, Value, BinType >::addToBin	(	const Keys &	k,
		const Value &	v
	)		[inline]

Definition at line 74 of file Histogram2D.h.

template<class Key, class Value, class BinType = Value>

BinType& Histogram2D< Key, Value, BinType >::bin	(	const Key &	x,
		const Key &	y
	)		[inline]

Definition at line 68 of file Histogram2D.h.

template<class Key, class Value, class BinType = Value>

const BinType& Histogram2D< Key, Value, BinType >::bin	(	const Key &	x,
		const Key &	y
	)		const [inline]

Definition at line 69 of file Histogram2D.h.

template<class Key, class Value, class BinType = Value>

BinType& Histogram2D< Key, Value, BinType >::bin

(

const Keys &

k

)

[inline]

Definition at line 70 of file Histogram2D.h.

template<class Key, class Value, class BinType = Value>

const BinType& Histogram2D< Key, Value, BinType >::bin

(

const Keys &

k

)

const [inline]

Definition at line 71 of file Histogram2D.h.

template<class Key, class Value, class BinType = Value>

size_t Histogram2D< Key, Value, BinType >::getIdx	(	const Key &	x,
		const Key &	y
	)		const [inline, protected]

Definition at line 97 of file Histogram2D.h.

template<class Key, class Value, class BinType = Value>

size_t Histogram2D< Key, Value, BinType >::getIdx	(	const size_t &	xIdx,
		const size_t &	yIdx
	)		const [inline, protected]

Definition at line 111 of file Histogram2D.h.

template<class Key, class Value, class BinType = Value>

Keys Histogram2D< Key, Value, BinType >::getKeys

(

const size_t &

idx

)

const [inline, protected]

Definition at line 118 of file Histogram2D.h.

template<class Key, class Value, class BinType = Value>

void Histogram2D< Key, Value, BinType >::getMaxBin	(	BinType &	bin,
		Key &	x,
		Key &	y
	)		const [inline]

Definition at line 76 of file Histogram2D.h.

template<class Key, class Value, class BinType = Value>

void Histogram2D< Key, Value, BinType >::getMaxBin	(	BinType &	bin,
		Keys &	k
	)		const [inline]

Definition at line 83 of file Histogram2D.h.

template<class Key, class Value, class BinType = Value>

template<class Comp >

void Histogram2D< Key, Value, BinType >::getMaxBin	(	BinType &	bin,
		Key &	x,
		Key &	y,
		Comp	comp
	)		const [inline]

Definition at line 85 of file Histogram2D.h.

template<class Key, class Value , class BinType>

template<class Comp >

void Histogram2D< Key, Value, BinType >::getMaxBin	(	BinType &	bin,
		Keys &	k,
		Comp	comp
	)		const

Definition at line 136 of file Histogram2D.h.

---

Member Data Documentation

template<class Key, class Value, class BinType = Value>

Bins Histogram2D< Key, Value, BinType >::mBins [protected]

Definition at line 131 of file Histogram2D.h.

template<class Key, class Value, class BinType = Value>

Key Histogram2D< Key, Value, BinType >::mBinSize [protected]

Definition at line 129 of file Histogram2D.h.

template<class Key, class Value, class BinType = Value>

Key Histogram2D< Key, Value, BinType >::mMaxX [protected]

Definition at line 129 of file Histogram2D.h.

template<class Key, class Value, class BinType = Value>

Key Histogram2D< Key, Value, BinType >::mMaxY [protected]

Definition at line 129 of file Histogram2D.h.

template<class Key, class Value, class BinType = Value>

Key Histogram2D< Key, Value, BinType >::mMinX [protected]

Definition at line 129 of file Histogram2D.h.

template<class Key, class Value, class BinType = Value>

Key Histogram2D< Key, Value, BinType >::mMinY [protected]

Definition at line 129 of file Histogram2D.h.

template<class Key, class Value, class BinType = Value>

unsigned int Histogram2D< Key, Value, BinType >::mXSpan [protected]

Definition at line 130 of file Histogram2D.h.

template<class Key, class Value, class BinType = Value>

unsigned int Histogram2D< Key, Value, BinType >::mYSpan [protected]

Definition at line 130 of file Histogram2D.h.

---

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

• Histogram2D.h