Base class for object allowing to create data partition based on grid. More...

#include <BaseGridPartition.h>

Inheritance diagram for ipsdk::math::BaseGridPartition:

Public Member Functions
void	setNbBucketsByAxis (const ipUInt32 nbBucketsByAxis)
	selection of number of buckets by axis More...

ipUInt32	getNbBucketsByAxis () const
	retrieve number of buckets by axis

Constructors and destructor
	BaseGridPartition ()

virtual	~BaseGridPartition ()=0

Public Member Functions inherited from ipsdk::math::BaseDataPartition
virtual eDataPartitionType	getDataPartitionType () const =0
	retrieve type associated to data partition

bool	isInit () const
	check for object initialization

BoolResult	init (const ipUInt32 subSetRequestedSize, const DataSet &fullDataSet)
	initialization method More...

ipUInt32	getSubSetRequestedSize () const
	retrieve requested size for generate data sub sets More...

BoolResult	createSubSet (const DataSet &fullDataSet, DataSet &subDataSet)
	method allowing to create a new sub set from data More...

void	clear ()
	clear of object data

	BaseDataPartition ()

virtual	~BaseDataPartition ()=0

Public Member Functions inherited from ipsdk::BaseSerializationObject
	BaseSerializationObject ()
	Default constructor.

virtual	~BaseSerializationObject ()=0
	destructor

Public Member Functions inherited from ipsdk::BaseDynamicObject
virtual const std::string &	getClassName () const
	method allowing to retrieve object class name

virtual BaseDynamicObject *	createNew () const =0
	method allowing to create new instance of current object type

virtual DynamicObjectPtr	createShared () const =0
	method allowing to create new shared instance of current object type

virtual bool	hasCopySupport () const =0
	check whether objet has copy support

virtual BaseDynamicObject *	duplicate () const =0
	method allowing to duplicate current object More...

virtual DynamicObjectPtr	duplicateShared () const =0
	method allowing shared duplication of current object More...

	BaseDynamicObject ()

virtual	~BaseDynamicObject ()=0

Protected Types
typedef std::vector< ipUInt32 >	BucketId
	id for a bucket of data

typedef std::vector< ipUInt32 >	DataIdColl

typedef std::map< BucketId, DataIdColl >	BucketPopulation
	map associating a bucket if to a collection of data ids

Protected Types inherited from ipsdk::math::BaseDataPartition
typedef std::set< ipUInt32 >	Indexes
	collection of unique indexes

Protected Member Functions
BoolResult	initDerived (const DataSet &fullDataSet, const ipUInt32 subSetRequestedSize)
	initialization method of derived classes More...

void	clearDerived ()
	clear of derived classes

Indexes	randomSubSet (const ipUInt32 subSetRequestedSize)
	random selection of a sub set into derived class

virtual BoolResult	populateBuckets (const DataSet &fullDataSet, BucketPopulation &bucketPopulation)=0
	method allowing to compute buckets population More...

Protected Member Functions inherited from ipsdk::BaseSerializationObject
virtual BoolResult	write (BaseOArchive &ar) const
	method allowing to ensure serialization write part for object

virtual BoolResult	read (BaseIArchive &ar)
	method allowing to ensure serialization read part for object

Protected Member Functions inherited from ipsdk::BaseDynamicObject
virtual void	initCtorCopy (const BaseDynamicObject &object)

virtual void	copy (const BaseDynamicObject &object)
	method allowing to copy data from another object

Additional Inherited Members
Static Public Member Functions inherited from ipsdk::BaseSerializationObject
static ipUInt32	getVersion ()
	method allowing to retrieve class version information for serialization

Static Public Member Functions inherited from ipsdk::BaseDynamicObject
static const std::string &	getTypeName ()
	method allowing to retrieve name associated to class

Detailed Description

Base class for object allowing to create data partition based on grid.

Author: E.Noirfalise

Date: 2017/06/16

Copyright: 2017 Reactiv'IP, all right reserved.

Member Function Documentation

◆ setNbBucketsByAxis()

void ipsdk::math::BaseGridPartition::setNbBucketsByAxis ( const ipUInt32 nbBucketsByAxis )

selection of number of buckets by axis

Note: for a 2 dimensional data set we would have nbBucketsByAxis*nbBucketsByAxis buckets; default value : 5

Exceptions

ipsdk::math::IPSDKMathException if nbBucketsByAxis == 0

◆ initDerived()

BoolResult ipsdk::math::BaseGridPartition::initDerived	(	const DataSet &	fullDataSet,
		const ipUInt32	subSetRequestedSize
	)

protectedvirtual

initialization method of derived classes

Returns: false in case of failure

Implements ipsdk::math::BaseDataPartition.

◆ populateBuckets()

virtual BoolResult ipsdk::math::BaseGridPartition::populateBuckets	(	const DataSet &	fullDataSet,
		BucketPopulation &	bucketPopulation
	)

protectedpure virtual

method allowing to compute buckets population

Returns: false in case of failure

Implemented in ipsdk::math::AdaptiveGridPartition, and ipsdk::math::RegularGridPartition.

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

/media/reactivipdev/Nightly/IPSDK_Patch/IPSDK_4_1/IPSDK_Nightly/include/public/IPSDKMath/Estimation/DataPartition/BaseGridPartition.h

Public Member Functions

Protected Types

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ setNbBucketsByAxis()

◆ initDerived()

◆ populateBuckets()