ipsdk::math::BaseDataPartition Class Reference

Base class for data partitioning. More...

#include <BaseDataPartition.h>

Inheritance diagram for ipsdk::math::BaseDataPartition:

Public Member Functions
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
Constructors and destructor
	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::set< ipUInt32 >	Indexes
	collection of unique indexes

Protected Member Functions
virtual BoolResult	initDerived (const DataSet &fullDataSet, const ipUInt32 subSetRequestedSize)=0
	initialization method of derived classes More...
virtual void	clearDerived ()=0
	clear of derived classes
virtual Indexes	randomSubSet (const ipUInt32 subSetRequestedSize)=0
	random selection of a sub set into derived class
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 data partitioning.

Author

E. Noirfalise

Date

2016/02/15

Copyright

2016 Reactiv'IP, all right reserved.

Member Function Documentation

init()

BoolResult ipsdk::math::BaseDataPartition::init	(	const ipUInt32	subSetRequestedSize,
		const DataSet &	fullDataSet
	)

initialization method

Exceptions

ipsdk::math::IPSDKMathException

if subSetRequestedSize == 0

Returns

false in case of failure

getSubSetRequestedSize()

ipUInt32 ipsdk::math::BaseDataPartition::getSubSetRequestedSize

(

)

const

retrieve requested size for generate data sub sets

Exceptions

ipsdk::math::IPSDKMathException

if isInit() == false

createSubSet()

BoolResult ipsdk::math::BaseDataPartition::createSubSet	(	const DataSet &	fullDataSet,
		DataSet &	subDataSet
	)

method allowing to create a new sub set from data

Note

associated data index are granteed to not have been already returned

Exceptions

ipsdk::math::IPSDKMathException

if isInit() == false

Returns

false in case of failure

initDerived()

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

protectedpure virtual

initialization method of derived classes

Returns

false in case of failure

Implemented in ipsdk::math::BaseGridPartition.

---

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/BaseDataPartition.h