1.3.2
CCC
 
NeighCell Class Reference

Neighborhood definition by Cell. More...

#include <NeighCell.hpp>

Inheritance diagram for NeighCell:
ANeigh ASpaceObject ASerializable AStringable

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, int nmini=1, const ASpace *space=nullptr)
 
 NeighCell (const NeighCell &r)
 
NeighCelloperator= (const NeighCell &r)
 
virtual ~NeighCell ()
 
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...
 
int getNMini () const
 
- Public Member Functions inherited from ANeigh
 ANeigh (const ASpace *space=nullptr)
 
 ANeigh (const ANeigh &r)
 
ANeighoperator= (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)
 
ASpaceObjectoperator= (const ASpaceObject &r)
 
virtual ~ASpaceObject ()
 
const ASpacegetSpace () 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 VectorDoublegetOrigin () 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)
 
AStringableoperator= (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)
 
ASerializableoperator= (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 NeighCellcreate (bool flag_xvalid=false, int nmini=1, const ASpace *space=nullptr)
 
static NeighCellcreateFromNF (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 StringgetContainerName ()
 
static const StringgetPrefixName ()
 
static bool createDirectory (const String &dir)
 
static String getExecDirectory ()
 
static String getDirectory (const String &path)
 

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

◆ 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
neutralFilenameName of the Neutral File
verboseVerbose flag
Returns

◆ getMaxSampleNumber()

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

Implements ANeigh.

◆ getNeigh()

void NeighCell::getNeigh ( int  iech_out,
VectorInt ranks 
)
overridevirtual

Select the neighborhood

Parameters
iech_outValid Rank of the sample in the output Db
ranksVector of sample ranks in neighborhood (empty when error)

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.


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