PeriPyDIC
Public Member Functions | Public Attributes | List of all members
util.neighbor.NeighborSearch Class Reference

Class for handling the neighborhood. More...

Collaboration diagram for util.neighbor.NeighborSearch:
Collaboration graph

Public Member Functions

def __init__ (self, deck)
 Constructor. More...
 
def get_index_x_family (self, i)
 Returns the family of node "i". More...
 
def findNeighbors (self, deck)
 Generates adjacency lists. More...
 

Public Attributes

 safety_factor
 Safety factor for the search of the neighborhood.
 
 horizon
 Horizon of the neighborhood.
 
 family
 Adjaceny list.
 

Detailed Description

Class for handling the neighborhood.

Constructor & Destructor Documentation

§ __init__()

def util.neighbor.NeighborSearch.__init__ (   self,
  deck 
)

Constructor.

Parameters
deckThe input deck

Member Function Documentation

§ findNeighbors()

def util.neighbor.NeighborSearch.findNeighbors (   self,
  deck 
)

Generates adjacency lists.

Parameters
deckThe input deck

§ get_index_x_family()

def util.neighbor.NeighborSearch.get_index_x_family (   self,
  i 
)

Returns the family of node "i".

Parameters
iId of the node
Returns
The ids of the neighbors of node "i"

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