BIE::BaseDataTree Class Reference

BaseDataTree instances hold the input data in a summarized/decimated form. More...

#include <BaseDataTree.h>

Inheritance diagram for BIE::BaseDataTree:

[legend]

Collaboration diagram for BIE::BaseDataTree:

[legend]

List of all members.

Public Member Functions
	BaseDataTree ()
	Default constructor.
	BaseDataTree (const BaseDataTree &)
	Copy constructor.
	~BaseDataTree ()
	Destructor.
virtual void	SetDefaultFrontier (Frontier *frontier)
	Sets the default frontier used.
virtual Frontier *	GetDefaultFrontier ()
	Returns a pointer to the default frontier currently being used.
virtual int	Total ()
	Returns the total number of data points in the entire full distribution.
virtual int	Offgrid ()
	Total number of data points rejected because they lie outwith the area covered by the tessellation.
virtual Tile *	GetTile (int tileid)
	Returns tile in tessellation with given tileid.
virtual SampleDistribution *	First (Frontier *frontier)
	Tile iterator method: returns the distribution of the first tile in the frontier.
virtual SampleDistribution *	Last (Frontier *frontier)
	Tile iterator method: returns the distribution of the last tile in the frontier.
virtual SampleDistribution *	Next (Frontier *frontier)
	Tile iterator method: returns the distribution of the next tile in the frontier.
virtual SampleDistribution *	CurrentItem (Frontier *frontier)
	Tile iterator method: returns the distribution of the tile pointed to by the current cursor position.
virtual void	Reset (Frontier *frontier)
	Tile iterator method: Sets the cursor to the first tile in the frontier.
virtual bool	IsDone (Frontier *frontier)
	Tile iterator method: Returns true after Next() has returned the distribution corresponding to the final tile in the frontier.
virtual Tile *	CurrentTile (Frontier *frontier)
	Tile iterator method: Returns the Tile object pointed to by the cursor.
virtual SampleDistribution *	First ()
	Tile iterator method: returns the distribution of the first tile in the default frontier.
virtual SampleDistribution *	Last ()
	Tile iterator method: returns the distribution of the last tile in the default frontier.
virtual SampleDistribution *	Next ()
	Tile iterator method: returns the distribution of the next tile in the default frontier.
SampleDistribution *	CurrentItem ()
	Tile iterator method: returns the distribution of the tile pointed to by the current cursor position.
void	Reset ()
	Tile iterator method: Sets the cursor to the first tile in the default frontier.
bool	IsDone ()
	Tile iterator method: Returns true after Next() has returned the distribution corresponding to the final tile in the default frontier.
Tile *	CurrentTile ()
	Tile iterator method: Returns the Tile object pointed to by the cursor.
virtual int	NumberItems ()
	Returns the number of tiles in current frontier.
virtual SampleDistribution *	getDistribution (int tileid)
	Return a specific tile's distribution.
virtual void	CountData ()
	Debug check: count data in bins.
virtual Tessellation *	GetTessellation ()
	Return the pointer to the Tessellation instance.
Protected Attributes
map< int, SampleDistribution * >	fd_tiledistributions
	Tileid index-ed list of binned distributions.
SampleDistribution *	fd_distributionfactory
	The binned distribution factory.
Tessellation *	fd_tess
	The tessellation, which also holds the frontier.
Frontier *	fd_defaultfrontier
	The default frontier.
int	fd_total
	The total number of points in the data set used to create the dists.
int	fd_offgrid
	The number of points not used when building distributions.
Friends
class	boost::serialization::access

---

Detailed Description

BaseDataTree instances hold the input data in a summarized/decimated form.

Abstract class. Implementations are DataTree and NullDataTree.

---

Member Function Documentation

virtual void BIE::BaseDataTree::SetDefaultFrontier

(

Frontier *

frontier

)

[virtual]

Sets the default frontier used.

The tessellation in the frontier and the tessellation used in this object must match (done by simply checking pointers).

virtual Frontier* BIE::BaseDataTree::GetDefaultFrontier

(

)

[inline, virtual]

Returns a pointer to the default frontier currently being used.

Changes made to the frontier will apply to the DataTree object corresponding to this frontier.

Here is the caller graph for this function:

virtual SampleDistribution* BIE::BaseDataTree::First

(

Frontier *

frontier

)

[virtual]

Tile iterator method: returns the distribution of the first tile in the frontier.

virtual SampleDistribution* BIE::BaseDataTree::Last

(

Frontier *

frontier

)

[virtual]

Tile iterator method: returns the distribution of the last tile in the frontier.

virtual SampleDistribution* BIE::BaseDataTree::Next

(

Frontier *

frontier

)

[virtual]

Tile iterator method: returns the distribution of the next tile in the frontier.

This advances the cursor.

virtual SampleDistribution* BIE::BaseDataTree::CurrentItem

(

Frontier *

frontier

)

[virtual]

Tile iterator method: returns the distribution of the tile pointed to by the current cursor position.

virtual bool BIE::BaseDataTree::IsDone

(

Frontier *

frontier

)

[virtual]

Tile iterator method: Returns true after Next() has returned the distribution corresponding to the final tile in the frontier.

virtual SampleDistribution* BIE::BaseDataTree::First

(

)

[inline, virtual]

Tile iterator method: returns the distribution of the first tile in the default frontier.

virtual SampleDistribution* BIE::BaseDataTree::Last

(

)

[inline, virtual]

Tile iterator method: returns the distribution of the last tile in the default frontier.

virtual SampleDistribution* BIE::BaseDataTree::Next

(

)

[inline, virtual]

Tile iterator method: returns the distribution of the next tile in the default frontier.

This advances the cursor.

SampleDistribution* BIE::BaseDataTree::CurrentItem

(

)

[inline]

Tile iterator method: returns the distribution of the tile pointed to by the current cursor position.

void BIE::BaseDataTree::Reset

(

)

[inline]

Tile iterator method: Sets the cursor to the first tile in the default frontier.

bool BIE::BaseDataTree::IsDone

(

)

[inline]

Tile iterator method: Returns true after Next() has returned the distribution corresponding to the final tile in the default frontier.

---

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

• /home/weinberg/src/BIE/include/BaseDataTree.h