pyclustering.container.kdtree.node Class Reference

Represents a node in a KD-Tree. More...

Public Member Functions

def __init__ (self, data=None, payload=None, left=None, right=None, disc=None, parent=None)
 Creates KD-tree node. More...
 
def __repr__ (self)
 
def __str__ (self)
 
def get_children (self)
 Returns list of not None children of the node. More...
 

Public Attributes

 data
 Data point that is presented as list of coordinates. More...
 
 payload
 Payload of node that can be used by user for storing specific information in the node. More...
 
 left
 Left node successor of the node. More...
 
 right
 Right node successor of the node. More...
 
 disc
 Index of dimension. More...
 
 parent
 Parent node of the node. More...
 

Detailed Description

Represents a node in a KD-Tree.

The KD-Tree node contains point's coordinates, discriminator, payload and pointers to parent and children.

See also
kdtree_balanced
kdtree

Definition at line 184 of file kdtree.py.

Constructor & Destructor Documentation

◆ __init__()

def pyclustering.container.kdtree.node.__init__ (   self,
  data = None,
  payload = None,
  left = None,
  right = None,
  disc = None,
  parent = None 
)

Creates KD-tree node.

Parameters
[in]data(list): Data point that is presented as list of coordinates.
[in]payload(any): Payload of node (pointer to essence that is attached to this node).
[in]left(node): Node of KD-Tree that represents left successor.
[in]right(node): Node of KD-Tree that represents right successor.
[in]disc(uint): Index of dimension of that node.
[in]parent(node): Node of KD-Tree that represents parent.

Definition at line 194 of file kdtree.py.

Member Function Documentation

◆ __repr__()

def pyclustering.container.kdtree.node.__repr__ (   self)
Returns
(string) Default representation of the node.

Definition at line 225 of file kdtree.py.

Referenced by pyclustering.container.kdtree.node.__str__().

◆ __str__()

def pyclustering.container.kdtree.node.__str__ (   self)
Returns
(string) String representation of the node.

Definition at line 241 of file kdtree.py.

◆ get_children()

def pyclustering.container.kdtree.node.get_children (   self)

Returns list of not None children of the node.

Returns
(list) list of not None children of the node; if the node does not have children then None is returned.

Definition at line 248 of file kdtree.py.

Member Data Documentation

◆ data

pyclustering.container.kdtree.node.data

Data point that is presented as list of coordinates.

Definition at line 208 of file kdtree.py.

Referenced by pyclustering.container.kdtree.node.__repr__().

◆ disc

pyclustering.container.kdtree.node.disc

Index of dimension.

Definition at line 220 of file kdtree.py.

◆ left

pyclustering.container.kdtree.node.left

Left node successor of the node.

Definition at line 214 of file kdtree.py.

Referenced by pyclustering.container.kdtree.node.__repr__(), and pyclustering.container.kdtree.node.get_children().

◆ parent

pyclustering.container.kdtree.node.parent

Parent node of the node.

Definition at line 223 of file kdtree.py.

◆ payload

pyclustering.container.kdtree.node.payload

Payload of node that can be used by user for storing specific information in the node.

Definition at line 211 of file kdtree.py.

◆ right

pyclustering.container.kdtree.node.right

Right node successor of the node.

Definition at line 217 of file kdtree.py.

Referenced by pyclustering.container.kdtree.node.__repr__(), and pyclustering.container.kdtree.node.get_children().


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