pyclustering.cluster.clique.spatial_block Class Reference

Geometrical description of CLIQUE block in data space. More...

Public Member Functions

def __init__ (self, max_corner, min_corner)
 Creates spatial block in data space. More...
 
def __str__ (self)
 Returns string block description. More...
 
def __contains__ (self, point)
 Point is considered as contained if it lies in block (belong to it). More...
 
def get_corners (self)
 Return spatial description of current block. More...
 

Detailed Description

Geometrical description of CLIQUE block in data space.

Provides services related to spatial functionality.

See also
bang_block

Definition at line 172 of file clique.py.

Constructor & Destructor Documentation

◆ __init__()

def pyclustering.cluster.clique.spatial_block.__init__ (   self,
  max_corner,
  min_corner 
)

Creates spatial block in data space.

Parameters
[in]max_corner(array_like): Maximum corner coordinates of the block.
[in]min_corner(array_like): Minimal corner coordinates of the block.

Definition at line 181 of file clique.py.

Member Function Documentation

◆ __contains__()

def pyclustering.cluster.clique.spatial_block.__contains__ (   self,
  point 
)

Point is considered as contained if it lies in block (belong to it).

Returns
(bool) True if point is in block, otherwise False.

Definition at line 203 of file clique.py.

◆ __str__()

def pyclustering.cluster.clique.spatial_block.__str__ (   self)

Returns string block description.

Returns
String representation of the block.

Definition at line 193 of file clique.py.

◆ get_corners()

def pyclustering.cluster.clique.spatial_block.get_corners (   self)

Return spatial description of current block.

Returns
(tuple) Pair of maximum and minimum corners (max_corner, min_corner).

Definition at line 217 of file clique.py.


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