1.2.2
CCC
 
ANeigh Class Referenceabstract

#include <ANeigh.hpp>

Inheritance diagram for ANeigh:
ASpaceObject ASerializable AStringable NeighBench NeighCell NeighImage NeighMoving NeighUnique

Public Member Functions

 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 int attach (const Db *dbin, const Db *dbout)
 Interface for ANeigh. More...
 
virtual void getNeigh (int iech_out, VectorInt &ranks)=0
 
virtual int getMaxSampleNumber (const Db *db) const =0
 
virtual bool hasChanged (int iech_out) const
 
virtual VectorDouble summary (int iech_out)
 
virtual ENeigh getType () const
 
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 ()
 
virtual String toString (const AStringFormat *strfmt=nullptr) const override
 AStringable interface. More...
 
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
 

Additional Inherited Members

- 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

ANeigh::ANeigh ( const ASpace space = nullptr)
ANeigh::ANeigh ( const ANeigh r)
ANeigh::~ANeigh ( )
virtual

Member Function Documentation

int ANeigh::attach ( const Db dbin,
const Db dbout 
)
virtual

Interface for ANeigh.

Reimplemented in NeighMoving, NeighBench, and NeighCell.

virtual bool ANeigh::getFlagContinuous ( ) const
inlinevirtual

Reimplemented in NeighMoving.

bool ANeigh::getFlagKFold ( ) const
inline
bool ANeigh::getFlagXvalid ( ) const
inline
virtual int ANeigh::getMaxSampleNumber ( const Db db) const
pure virtual
virtual void ANeigh::getNeigh ( int  iech_out,
VectorInt ranks 
)
pure virtual
virtual ENeigh ANeigh::getType ( ) const
inlinevirtual
virtual bool ANeigh::hasChanged ( int  iech_out) const
inlinevirtual
virtual bool ANeigh::isConsistent ( const ASpace space) const
inlineoverridevirtual

ASpaceObject Interface.

Implements ASpaceObject.

bool ANeigh::isUnchanged ( ) const
inline
ANeigh & ANeigh::operator= ( const ANeigh r)
void ANeigh::reset ( )
void ANeigh::select ( int  iech_out,
VectorInt ranks 
)

Generic function for performing neighborhood selection. This function ALWAYS modifies (and resizes) the returned array 'ranks'

Parameters
iech_outRank of the target point (in 'dbout')
ranksInput / Output vector of neighboring sample ranks
void ANeigh::setFlagKFold ( bool  flagKFold)
inline
void ANeigh::setFlagSimu ( bool  flagSimu)
inline
void ANeigh::setFlagXvalid ( bool  flagXvalid)
inline
void ANeigh::setIsChanged ( bool  status = false)
void ANeigh::setRankColCok ( const VectorInt rankColCok)
inline
virtual VectorDouble ANeigh::summary ( int  iech_out)
inlinevirtual

Reimplemented in NeighMoving.


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