Neighborhood definition by Bench. More...

#include <NeighBench.hpp>

Inheritance diagram for NeighBench:

Detailed Description

Neighborhood definition by Bench.

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 'bench' as the target: the distance (according to the last space coordinate, e.g. the elevation in the 3-D case) between a selected sample and the target is smaller than the bench width.

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
	NeighBench (bool flag_xvalid=false, double width=0., const ASpace *space=nullptr)

	NeighBench (const NeighBench &r)

NeighBench &	operator= (const NeighBench &r)

virtual	~NeighBench ()

virtual int	attach (const Db dbin, const Db dbout=nullptr) override
	Interface for ANeigh. More...

virtual void	getNeigh (int iech_out, VectorInt &ranks) override

virtual bool	hasChanged (int iech_out) const override

virtual int	getMaxSampleNumber (const Db *db) const override

virtual ENeigh	getType () const override

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

double	getWidth () const

Public Member Functions inherited from ANeigh
	ANeigh (const ASpace *space=nullptr)

	ANeigh (const ANeigh &r)

ANeigh &	operator= (const ANeigh &r)

virtual	~ANeigh ()

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

virtual VectorDouble	summary (int iech_out)

virtual bool	getFlagContinuous () const

void	select (int iech_out, VectorInt &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	setRankColCok (const VectorInt &rankColCok)

Public Member Functions inherited from ASpaceObject
	ASpaceObject (const ASpace *space=nullptr)

	ASpaceObject (const ASpace &space)

	ASpaceObject (const ASpaceObject &r)

ASpaceObject &	operator= (const ASpaceObject &r)

virtual	~ASpaceObject ()

const ASpace *	getSpace () const
	Accessor to the current object space context. More...

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

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

unsigned int	getNDim () const
	Shortcuts to ASpace methods. More...

const VectorDouble &	getOrigin () const
	Return the current space context origin coordinates. More...

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

double	getDistance1D (const SpacePoint &p1, const SpacePoint &p2, int idim) const
	Return the distance along one direction between two space points. More...

VectorDouble	getIncrement (const SpacePoint &p1, const SpacePoint &p2) const
	Return the increment vector between two space points for the current space context. More...

Public Member Functions inherited from 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 (int level) const final

Public Member Functions inherited from ASerializable
	ASerializable ()

	ASerializable (const ASerializable &r)

ASerializable &	operator= (const ASerializable &r)

virtual	~ASerializable ()

bool	deserialize (std::istream &is, bool verbose=true)

bool	serialize (std::ostream &os, bool verbose=true) const

bool	dumpToNF (const String &neutralFilename, bool verbose=false) const

Static Public Member Functions
static NeighBench *	create (bool flag_xvalid=false, double width=0, const ASpace *space=nullptr)

static NeighBench *	createFromNF (const String &neutralFilename, bool verbose=true)

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

static String	getHomeDirectory (const String &sub="")

static String	getWorkingDirectory ()

static String	getTestData (const String &subdir, const String &filename)

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

static void	setContainerName (bool useDefault, const String &containerName="", bool verbose=false)

static void	unsetContainerName ()

static void	setPrefixName (const String &prefixName)

static void	unsetPrefixName ()

static const String &	getContainerName ()

static const String &	getPrefixName ()

static bool	createDirectory (const String &dir)

static String	getExecDirectory ()

static String	getDirectory (const String &path)

Constructor & Destructor Documentation

◆ NeighBench() [1/2]

NeighBench::NeighBench	(	bool	flag_xvalid = `false`,
		double	width = `0.`,
		const ASpace *	space = `nullptr`
	)

◆ NeighBench() [2/2]

NeighBench::NeighBench ( const NeighBench & r )

◆ ~NeighBench()

NeighBench::~NeighBench ( )

virtual

Member Function Documentation

◆ attach()

int NeighBench::attach	(	const Db *	dbin,
		const Db *	dbout = `nullptr`
	)

overridevirtual

Interface for ANeigh.

Reimplemented from ANeigh.

◆ create()

NeighBench * NeighBench::create	(	bool	flag_xvalid = `false`,
		double	width = `0`,
		const ASpace *	space = `nullptr`
	)

static

◆ createFromNF()

NeighBench * NeighBench::createFromNF	(	const String &	neutralFilename,
		bool	verbose = `true`
	)

static

Create a Neighborhood by loading the contents of a Neutral File

Parameters

neutralFilename	Name of the Neutral File
verbose	Verbose flag

Returns

◆ getMaxSampleNumber()

int NeighBench::getMaxSampleNumber ( const Db * db ) const

overridevirtual

Given a Db, returns the maximum number of samples per NeighBenchborhood

Parameters

db	Pointer to the target Db

Returns

Implements ANeigh.

◆ getNeigh()

void NeighBench::getNeigh	(	int	iech_out,
		VectorInt &	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 ANeigh.

◆ getType()

virtual ENeigh NeighBench::getType ( ) const

inlineoverridevirtual

Reimplemented from ANeigh.

◆ getWidth()

double NeighBench::getWidth ( ) const

inline

◆ hasChanged()

bool NeighBench::hasChanged ( int iech_out ) const

overridevirtual

Reimplemented from ANeigh.

◆ operator=()

NeighBench & NeighBench::operator= ( const NeighBench & r )

◆ toString()

String NeighBench::toString ( const AStringFormat * strfmt = nullptr ) const

overridevirtual

Interface for AStringable.

Reimplemented from ASpaceObject.

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

include/Neigh/NeighBench.hpp
src/Neigh/NeighBench.cpp

Detailed Description

Public Member Functions

Static Public Member Functions

Constructor & Destructor Documentation

◆ NeighBench() [1/2]

◆ NeighBench() [2/2]

◆ ~NeighBench()

Member Function Documentation

◆ attach()

◆ create()

◆ createFromNF()

◆ getMaxSampleNumber()

◆ getNeigh()

◆ getType()

◆ getWidth()

◆ hasChanged()

◆ operator=()

◆ toString()