Main Page | Class Hierarchy | Class List | Directories | File List | Class Members | File Members

Neighborhood_System Class Reference

A class representing an abstract neighborhood system. More...

#include <Neighborhood_System.hpp>

Inheritance diagram for Neighborhood_System:

Generic_Neighborhood_System Image_Local_Neighborhood List of all members.

Public Member Functions

virtual ~Neighborhood_System ()
 Destructor for the class Neighborhood_System.
virtual void GetNeighbors (uint site, vector< Weighted_Neighbor * > &neighs)
 Get the (weighted) neighbors for a given site.
uint LMAX ()
 Get the maximum number of neighbors for a given site.
virtual void Info ()
 Display some info about the neighborhood system.
uint Get_N ()
virtual void ReadFromFile (string filename)
 Read the neighborhood system definition from a text file.

Protected Attributes

uint NbPts
 number of sites

Detailed Description

Author:
Lemine Abdallahi
Date:
Aug. 2005


Constructor & Destructor Documentation

Neighborhood_System::~Neighborhood_System  )  [virtual]
 

Destructor for the abstract class Neighborhood_System.

Abstract. To be defined for the derived classes.


Member Function Documentation

uint Neighborhood_System::Get_N  ) 
 

Get the number of the sites

void Neighborhood_System::GetNeighbors uint  site,
vector< Weighted_Neighbor * > &  neighs
[virtual]
 

Get the (weighted) neighbors for a given site.

Parameters:
[in] site : a site.
[out] neighs : the set of neighbors of the site site
Fills the vector neighs with the necessary neighborhood data for the site site.

Abstract. To be defined for the derived classes.

Reimplemented in Generic_Neighborhood_System, and Image_Local_Neighborhood.

void Neighborhood_System::Info  )  [virtual]
 

Display some info about the neighborhood system.

Abstract. to be defined for the derived classes.

Reimplemented in Generic_Neighborhood_System, and Image_Local_Neighborhood.

uint Neighborhood_System::LMAX  ) 
 

Get the maximum number of neighbors for a given site.

void Neighborhood_System::ReadFromFile string  filename  )  [virtual]
 

Read the neighborhood system definition from a text file.

Parameters:
filename : file from which the definition is read.
Abstract. To be defined for the derived classes.

Reimplemented in Generic_Neighborhood_System, and Image_Local_Neighborhood.


The documentation for this class was generated from the following files:
Generated on Thu Jan 12 11:55:03 2006 for NEM by  doxygen 1.4.4