ANeighParam Class Reference

#include <ANeighParam.hpp>

Inheritance diagram for ANeighParam:

Public Member Functions
	ANeighParam (bool flag_xvalid=false, const ASpace *space=nullptr)
	ANeighParam (const ANeighParam &r)
ANeighParam &	operator= (const ANeighParam &r)
virtual	~ANeighParam ()
virtual bool	isConsistent (const ASpace *space) const override
	ASpaceObject Interface. More...
virtual String	toString (const AStringFormat *strfmt=nullptr) const override
	AStringable interface. More...
virtual int	getMaxSampleNumber (const Db *db) const =0
virtual ENeigh	getType () const =0
virtual bool	getFlagContinuous () const
bool	getFlagXvalid () const
bool	getFlagKFold () const
void	setFlagXvalid (bool flagXvalid)
void	setFlagKFold (bool flagKFold)
VectorInt	eval (Db *dbin, Db *dbout, int iech0) const
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...
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

Protected Member Functions
virtual bool	_deserialize (std::istream &is, bool verbose=false) override
virtual bool	_serialize (std::ostream &os, bool verbose=false) const override
String	_getNFName () const override
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
bool	_isDimensionValid (int idim) const

Private Attributes
bool	_flagXvalid
bool	_flagKFold

Additional Inherited Members
Static Public Member Functions inherited from ASerializable
static String	buildFileName (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=String(), 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)
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 ASpaceObject
const ASpace *	_space
	Current space context of the object. More...

Constructor & Destructor Documentation

ANeighParam() [1/2]

ANeighParam::ANeighParam	(	bool	flag_xvalid = false,
		const ASpace *	space = nullptr
	)

ANeighParam() [2/2]

ANeighParam::ANeighParam

(

const ANeighParam &

r

)

~ANeighParam()

ANeighParam::~ANeighParam ( )

virtual

Member Function Documentation

_deserialize()

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

overrideprotectedvirtual

Implements ASerializable.

Reimplemented in NeighMoving, NeighImage, NeighBench, and NeighUnique.

_getNFName()

String ANeighParam::_getNFName ( ) const

inlineoverrideprotectedvirtual

Implements ASerializable.

Reimplemented in NeighMoving, NeighImage, NeighBench, and NeighUnique.

_isDimensionValid()

bool ANeighParam::_isDimensionValid ( int  idim ) const

private

_serialize()

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

overrideprotectedvirtual

Implements ASerializable.

Reimplemented in NeighMoving, NeighImage, NeighBench, and NeighUnique.

eval()

VectorInt ANeighParam::eval	(	Db *	dbin,
		Db *	dbout,
		int	iech0
	)		const

getFlagContinuous()

virtual bool ANeighParam::getFlagContinuous ( ) const

inlinevirtual

Reimplemented in NeighMoving.

getFlagKFold()

bool ANeighParam::getFlagKFold ( ) const

inline

getFlagXvalid()

bool ANeighParam::getFlagXvalid ( ) const

inline

getMaxSampleNumber()

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

pure virtual

Implemented in NeighMoving, NeighBench, NeighImage, and NeighUnique.

getType()

virtual ENeigh ANeighParam::getType ( ) const

pure virtual

Implemented in NeighMoving, NeighBench, NeighImage, and NeighUnique.

isConsistent()

bool ANeighParam::isConsistent ( const ASpace *  space ) const

overridevirtual

ASpaceObject Interface.

Implements ASpaceObject.

operator=()

ANeighParam & ANeighParam::operator=

(

const ANeighParam &

r

)

setFlagKFold()

void ANeighParam::setFlagKFold ( bool  flagKFold )

inline

setFlagXvalid()

void ANeighParam::setFlagXvalid ( bool  flagXvalid )

inline

toString()

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

overridevirtual

AStringable interface.

Reimplemented from ASpaceObject.

Reimplemented in NeighMoving, NeighImage, NeighBench, and NeighUnique.

Member Data Documentation

_flagKFold

bool ANeighParam::_flagKFold

private

_flagXvalid

bool ANeighParam::_flagXvalid

private

---

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

• include/Neigh/ANeighParam.hpp
• src/Neigh/ANeighParam.cpp