#include <NeighCell.hpp>

Inheritance diagram for NeighCell:

Public Member Functions
	NeighCell (bool flag_xvalid=false, int nmini=1, const ASpace *space=nullptr)

	NeighCell (const NeighCell &r)

NeighCell &	operator= (const NeighCell &r)

virtual	~NeighCell ()

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

virtual VectorInt	getNeigh (int iech_out) 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...

int	getNMini () 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

VectorInt	select (int iech_out)

bool	isUnchanged () const

void	setIsChanged ()

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 NeighCell *	create (bool flag_xvalid=false, int nmini=1, const ASpace *space=nullptr)

static NeighCell *	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)

Protected Member Functions
virtual bool	_deserialize (std::istream &is, bool verbose=false) override
	Interface for ASerializable. More...

virtual bool	_serialize (std::ostream &os, bool verbose=false) const override

String	_getNFName () const override

Protected Member Functions inherited from ANeigh
bool	_isNbghMemoEmpty () const

void	_neighCompress (VectorInt &ranks)

void	_display (const VectorInt &ranks)

bool	_discardUndefined (int iech)

int	_xvalid (int iech_in, int iech_out, double eps=EPSILON9)

bool	_isDimensionValid (int idim) const

Protected Member Functions inherited from ASpaceObject
void	setNDim (int ndim)
	Modify the Space dimension of an already created item (To be used only during creation ... in particular when reading NF) More...

Protected Member Functions inherited from ASerializable
bool	_fileOpenWrite (const String &filename, std::ofstream &os, bool verbose=false) const

bool	_fileOpenRead (const String &filename, std::ifstream &is, bool verbose=false) const

Private Member Functions
int	_cell (int iech_out, VectorInt &ranks)

Private Attributes
int	_nMini

BiTargetCheckCell *	_biPtCell

const DbGrid *	_dbgrid

SpaceTarget	_T1

SpaceTarget	_T2

Additional Inherited Members
Static Protected Member Functions inherited from ASerializable
static bool	_commentWrite (std::ostream &os, const String &comment)

template<typename T >
static bool	_recordWrite (std::ostream &os, const String &title, const T &val)

template<typename T >
static bool	_recordWriteVec (std::ostream &os, const String &title, const VectorT< T > &vec)

template<typename T >
static bool	_recordRead (std::istream &is, const String &title, T &val)

template<typename T >
static bool	_recordReadVec (std::istream &is, const String &title, VectorT< T > &vec, int nvalues)

static bool	_onlyBlanks (char *string)

static bool	_tableRead (std::istream &is, const String &string, int ntab, double *tab)

static bool	_tableWrite (std::ostream &os, const String &string, int ntab, const VectorDouble &tab)

Protected Attributes inherited from ANeigh
const Db *	_dbin

const Db *	_dbout

const DbGrid *	_dbgrid

VectorInt	_rankColCok

int	_iechMemo

bool	_flagSimu

bool	_flagXvalid

bool	_flagKFold

Protected Attributes inherited from ASpaceObject
const ASpace *	_space
	Current space context of the object. More...

Constructor & Destructor Documentation

◆ NeighCell() [1/2]

NeighCell::NeighCell	(	bool	flag_xvalid = `false`,
		int	nmini = `1`,
		const ASpace *	space = `nullptr`
	)

◆ NeighCell() [2/2]

NeighCell::NeighCell ( const NeighCell & r )

◆ ~NeighCell()

NeighCell::~NeighCell ( )

virtual

Member Function Documentation

◆ _cell()

int NeighCell::_cell	(	int	iech_out,
		VectorInt &	ranks
	)

private

Search for the cell neighborhood

Returns: Error returned code

Parameters

[in]	iech_out	rank of the output sample
[out]	ranks	Vector of samples elected in the Neighborhood

◆ _deserialize()

bool NeighCell::_deserialize	(	std::istream &	is,
		bool	verbose = `false`
	)

overrideprotectedvirtual

Interface for ASerializable.

Reimplemented from ANeigh.

◆ _getNFName()

String NeighCell::_getNFName ( ) const

inlineoverrideprotectedvirtual

Reimplemented from ANeigh.

◆ _serialize()

bool NeighCell::_serialize	(	std::ostream &	os,
		bool	verbose = `false`
	)		const

overrideprotectedvirtual

Reimplemented from ANeigh.

◆ attach()

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

overridevirtual

Interface for ANeigh.

Reimplemented from ANeigh.

◆ create()

NeighCell * NeighCell::create	(	bool	flag_xvalid = `false`,
		int	nmini = `1`,
		const ASpace *	space = `nullptr`
	)

static

◆ createFromNF()

NeighCell * NeighCell::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()

virtual int NeighCell::getMaxSampleNumber ( const Db * db ) const

inlineoverridevirtual

Implements ANeigh.

◆ getNeigh()

VectorInt NeighCell::getNeigh ( int iech_out )

overridevirtual

Select the neighborhood

Returns: Vector of sample ranks in neighborhood (empty when error)

Parameters

[in] iech_out Valid Rank of the sample in the output Db

Implements ANeigh.

◆ getNMini()

int NeighCell::getNMini ( ) const

inline

◆ getType()

virtual ENeigh NeighCell::getType ( ) const

inlineoverridevirtual

Reimplemented from ANeigh.

◆ hasChanged()

bool NeighCell::hasChanged ( int iech_out ) const

overridevirtual

Reimplemented from ANeigh.

◆ operator=()

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

◆ toString()

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

overridevirtual

Interface for AStringable.

Reimplemented from ASpaceObject.

Member Data Documentation

◆ _biPtCell

BiTargetCheckCell* NeighCell::_biPtCell

private

◆ _dbgrid

const DbGrid* NeighCell::_dbgrid

mutableprivate

◆ _nMini

int NeighCell::_nMini

private

◆ _T1

SpaceTarget NeighCell::_T1

mutableprivate

◆ _T2

SpaceTarget NeighCell::_T2

mutableprivate

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

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ NeighCell() [1/2]

◆ NeighCell() [2/2]

◆ ~NeighCell()

Member Function Documentation

◆ _cell()

◆ _deserialize()

◆ _getNFName()

◆ _serialize()

◆ attach()

◆ create()

◆ createFromNF()

◆ getMaxSampleNumber()

◆ getNeigh()

◆ getNMini()

◆ getType()

◆ hasChanged()

◆ operator=()

◆ toString()

Member Data Documentation

◆ _biPtCell

◆ _dbgrid

◆ _nMini

◆ _T1

◆ _T2