Neighborhood definition by Cell. More...

#include <NeighCell.hpp>

Inheritance diagram for gstlrn::NeighCell:

Detailed Description

Neighborhood definition by Cell.

The Neighborhood is usually meant to select a sub-population from the input Data Base, containing the active samples close to the target.

The selected samples belong to the same 'cell' as the target. This obviously requires that the target belongs to a Grid.

The neighborhood also offers the possibility to suppress any sample which would be too close to (or coincide with) the target: this is the cross-validation option.

Public Member Functions
	NeighCell (bool flag_xvalid=false, Id nmini=1, bool useBallTree=false, Id leaf_size=10, const ASpaceSharedPtr &space=ASpaceSharedPtr())

	NeighCell (const NeighCell &r)

NeighCell &	operator= (const NeighCell &r)

virtual	~NeighCell ()

Id	attach (const Db dbin, const Db dbout=nullptr) override
	Interface for ANeigh.

void	getNeigh (Id iech_out, 1 &ranks) override

bool	hasChanged (Id iech_out) const override

Id	getNSampleMax (const Db *db) const override

ENeigh	getType () const override

String	toString (const AStringFormat *strfmt=nullptr) const override
	Interface for AStringable.

Id	getNMini () const

Public Member Functions inherited from gstlrn::ANeigh
	ANeigh (const ASpaceSharedPtr &space=ASpaceSharedPtr())

	ANeigh (const ANeigh &r)

ANeigh &	operator= (const ANeigh &r)

virtual	~ANeigh ()

bool	isConsistent (const ASpace *space) const override
	ASpaceObject Interface.

virtual	summary (Id iech_out)

virtual bool	getFlagContinuous () const

void	displayDebug (1 &ranks) const

void	select (Id iech_out, 1 &ranks)

bool	isUnchanged () const

void	setIsChanged (bool status=false)

void	reset ()

bool	getFlagXvalid () const

bool	getFlagKFold () const

void	setFlagXvalid (bool flagXvalid)

void	setFlagKFold (bool flagKFold)

void	setFlagSimu (bool flagSimu)

void	setBallSearch (bool status, Id leaf_size=10)

void	attachBall ()

Public Member Functions inherited from gstlrn::ASpaceObject
	ASpaceObject (const ASpaceSharedPtr &space=ASpaceSharedPtr())

	ASpaceObject (const ASpaceObject &r)

ASpaceObject &	operator= (const ASpaceObject &r)

virtual	~ASpaceObject ()

ASpaceSharedPtr	getSpace () const
	Accessor to the current object space context.

bool	isConsistent () const
	Indicate if I am consistent with my current space context.

void	setSpace (ASpaceSharedPtr &&space)

	getUnitaryVector () const
	Return unitary vector for the current space context.

bool	isConsistent (const ASpaceSharedPtr &space) const
	Indicate if I am consistent with the provided space.

size_t	getNDim (Id ispace=-1) const
	Shortcuts to ASpace methods.

const &	getOrigin (Id ispace=-1) const
	Return the current space context origin coordinates.

double	getDistance (const SpacePoint &p1, const SpacePoint &p2, Id ispace=0) const
	Return the distance between two space points for the current space context.

	getDistances (const SpacePoint &p1, const SpacePoint &p2) const
	Return all the distances (space composits) between two space points for the current space context.

	getIncrement (const SpacePoint &p1, const SpacePoint &p2, Id ispace=0) const
	Return the increment vector between two space points for the current space context.

void	getIncrementInPlace (const SpacePoint &p1, const SpacePoint &p2, 1 &ptemp, Id ispace=-1) const

Public Member Functions inherited from gstlrn::AStringable
	AStringable ()

	AStringable (const AStringable &r)

AStringable &	operator= (const AStringable &r)

virtual	~AStringable ()

virtual void	display (const AStringFormat *strfmt=nullptr) const final

virtual void	display (Id level) const final

Public Member Functions inherited from gstlrn::ASerializable
	ASerializable ()

	ASerializable (const ASerializable &r)

ASerializable &	operator= (const ASerializable &r)

	ASerializable (ASerializable &&r) noexcept

ASerializable &	operator= (ASerializable &&r) noexcept

virtual	~ASerializable ()

bool	dumpToNF (const String &NFFilename, const EFormatNF &format=EFormatNF::fromKey("DEFAULT"), bool verbose=false) const
	Dump the contents of an object into an Output File using a given Output NF Format.

void	setDefaultFormatNF (const EFormatNF &format)

Public Member Functions inherited from gstlrn::ICloneable
	ICloneable ()

virtual	~ICloneable ()

virtual ICloneable *	clone () const =0

std::shared_ptr< ICloneable >	cloneShared () const

std::unique_ptr< ICloneable >	cloneUnique () const

Static Public Member Functions
static NeighCell *	create (bool flag_xvalid=false, Id nmini=1, bool useBallTree=false, Id leaf_size=10, const ASpaceSharedPtr &space=ASpaceSharedPtr())

static NeighCell *	createFromNF (const String &NFFilename, bool verbose=true)

Static Public Member Functions inherited from gstlrn::ASerializable
static String	buildFileName (Id status, const String &filename, bool ensureDirExist=false)

static String	getFileIdentity (const String &filename, bool verbose=false)

static void	setPrefixName (const String &prefixName)

static void	unsetPrefixName ()

static const String &	getPrefixName ()

Constructor & Destructor Documentation

◆ NeighCell() [1/2]

gstlrn::NeighCell::NeighCell	(	bool	flag_xvalid = `false`,
		Id	nmini = `1`,
		bool	useBallTree = `false`,
		Id	leaf_size = `10`,
		const ASpaceSharedPtr &	space = `ASpaceSharedPtr()`
	)

◆ NeighCell() [2/2]

gstlrn::NeighCell::NeighCell ( const NeighCell & r )

◆ ~NeighCell()

gstlrn::NeighCell::~NeighCell ( )

virtual

Member Function Documentation

◆ attach()

Id gstlrn::NeighCell::attach	(	const Db *	dbin,
		const Db *	dbout = `nullptr`
	)

overridevirtual

Interface for ANeigh.

Reimplemented from gstlrn::ANeigh.

◆ create()

NeighCell * gstlrn::NeighCell::create	(	bool	flag_xvalid = `false`,
		Id	nmini = `1`,
		bool	useBallTree = `false`,
		Id	leaf_size = `10`,
		const ASpaceSharedPtr &	space = `ASpaceSharedPtr()`
	)

static

◆ createFromNF()

NeighCell * gstlrn::NeighCell::createFromNF	(	const String &	NFFilename,
		bool	verbose = `true`
	)

static

Create a Neighborhood by loading the contents of a Neutral File

Parameters

NFFilename	Name of the Neutral File
verbose	Verbose flag

Returns

◆ getNeigh()

void gstlrn::NeighCell::getNeigh	(	Id	iech_out,
		1 &	ranks
	)

overridevirtual

Select the neighborhood

Parameters

iech_out	Valid Rank of the sample in the output Db
ranks	Vector of sample ranks in neighborhood (empty when error)

Implements gstlrn::ANeigh.

◆ getNMini()

Id gstlrn::NeighCell::getNMini ( ) const

inline

◆ getNSampleMax()

Id gstlrn::NeighCell::getNSampleMax ( const Db * db ) const

inlineoverridevirtual

Implements gstlrn::ANeigh.

◆ getType()

ENeigh gstlrn::NeighCell::getType ( ) const

inlineoverridevirtual

Reimplemented from gstlrn::ANeigh.

◆ hasChanged()

bool gstlrn::NeighCell::hasChanged ( Id iech_out ) const

overridevirtual

Reimplemented from gstlrn::ANeigh.

◆ operator=()

NeighCell & gstlrn::NeighCell::operator= ( const NeighCell & r )

◆ toString()

String gstlrn::NeighCell::toString ( const AStringFormat * strfmt = nullptr ) const

overridevirtual

Interface for AStringable.

Reimplemented from gstlrn::ASpaceObject.

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

include/Neigh/NeighCell.hpp
src/Neigh/NeighCell.cpp

Detailed Description

Public Member Functions

Static Public Member Functions

Constructor & Destructor Documentation

◆ NeighCell() [1/2]

◆ NeighCell() [2/2]

◆ ~NeighCell()

Member Function Documentation

◆ attach()

◆ create()

◆ createFromNF()

◆ getNeigh()

◆ getNMini()

◆ getNSampleMax()

◆ getType()

◆ hasChanged()

◆ operator=()

◆ toString()