HyperBinningAlgorithms Class Reference

Detailed Description

HyperPlot, Author: Sam Harnew, sam.h.nosp@m.arne.nosp@m.w@gma.nosp@m.il.c.nosp@m.om , Date: Dec 2015

This class is used to pick one of the binning algorithms (in HyperBinningMakers.h) and then sets any additional options that are passed as AlgOption's

Definition at line 129 of file HyperBinningAlgorithms.h.

#include <HyperBinningAlgorithms.h>

Public Types
enum	Alg {   SMART, MINT, MINT_SMART, MINT_RANDOM,   SMART_RANDOM, LIKELIHOOD, SMART_LIKELIHOOD, SMART_MULTI,   FUNC_PHASE }

Public Member Functions
	HyperBinningAlgorithms (Alg algorithm)
void	addAlgOption (AlgOption option)
	Add an AlgOption which is passed to the binning algortihm.
HyperBinningMaker *	getHyperBinningMaker (HyperCuboid binningRange, HyperPointSet points)
	~HyperBinningAlgorithms ()

Private Member Functions
AlgOption	getOpt (AlgOption::OptionName name)
bool	optExist (AlgOption::OptionName name)

Private Attributes
std::vector< AlgOption >	_algOptions
Alg	_alg

Member Enumeration Documentation

enum HyperBinningAlgorithms::Alg

enum containing a list of the avalible binning algorithms

Definition at line 134 of file HyperBinningAlgorithms.h.

Constructor & Destructor Documentation

HyperBinningAlgorithms::HyperBinningAlgorithms

(

Alg

algorithm

)

Constuct a HyperBinningAlgorithms by selecting the algortihm you would like to use

Definition at line 278 of file HyperBinningAlgorithms.cpp.

HyperBinningAlgorithms::~HyperBinningAlgorithms

(

)

Destructor

Definition at line 405 of file HyperBinningAlgorithms.cpp.

Member Function Documentation

HyperBinningMaker * HyperBinningAlgorithms::getHyperBinningMaker	(	HyperCuboid	binningRange,
		HyperPointSet	points
	)

Get the HyperBinningMaker (the binning algorithm) with the chosen algorithm type, and with the chosen AlgOption's

Definition at line 291 of file HyperBinningAlgorithms.cpp.

AlgOption HyperBinningAlgorithms::getOpt ( AlgOption::OptionName  name )

private

look through the list of AlgOption's and see if one with a specific OptionName exsits. If so, return it, if not return the OptionName EMTPY

Definition at line 259 of file HyperBinningAlgorithms.cpp.

bool HyperBinningAlgorithms::optExist ( AlgOption::OptionName  name )

private

look through the list of AlgOption's and see if one with a specific OptionName exsits.

Definition at line 270 of file HyperBinningAlgorithms.cpp.

Member Data Documentation

Alg HyperBinningAlgorithms::_alg

private

the algorithm (HyperBinningMaker) that will be used in a particular instance of the class

Definition at line 142 of file HyperBinningAlgorithms.h.

std::vector<AlgOption> HyperBinningAlgorithms::_algOptions

private

list of options that will be given to the HyperBinningMaker

Definition at line 139 of file HyperBinningAlgorithms.h.

---

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

• /Users/sh7566/Documents/Work/Code/HyperPlot/include/HyperBinningAlgorithms.h
• /Users/sh7566/Documents/Work/Code/HyperPlot/src/HyperBinningAlgorithms.cpp