Module org.arakhne.afc.core.mathtree
Package org.arakhne.afc.math.tree.builder

Interface TreeBuilder<D,​T extends Tree<D,​?>>

  • Type Parameters:
    D - is the type of the data inside the tree
    T - is the type of the tree.
    public interface TreeBuilder<D,​T extends Tree<D,​?>>
    A tree builder is a class that create a tree according to a set of objects and a set of constraints and heuristics.
    Since:
    13.0
    Version:
    17.0 2020-01-04 14:41:41
    Author:
    Stéphane GALLAND
    Maven Group Id:
    org.arakhne.afc.core
    Maven Artifact Id:
    mathtree

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      T buildTree​(List<? extends D> worldEntities)
      Builds a tree.
      int getSplittingCount()
      Replies the maximal count of elements inside a tree's node over each the node must be splitted.
      void setSplittingCount​(int count)
      Set the maximal count of elements inside a tree's node over each the node must be splitted.

    • Method Detail

      • buildTree

        T buildTree​(List<? extends D> worldEntities)
     throws TreeBuilderException
        Builds a tree.
        Parameters:
        worldEntities - is the set of world's entities from which the tree must be built.
        Returns:
        the built tree.
        Throws:
        TreeBuilderException - in case of error during the building.

      • setSplittingCount

        void setSplittingCount​(int count)
        Set the maximal count of elements inside a tree's node over each the node must be splitted.
        Parameters:
        count - is the maximal count of elements per node.

      • getSplittingCount

        @Pure
int getSplittingCount()
        Replies the maximal count of elements inside a tree's node over each the node must be splitted.
        Returns:
        the maximal count of elements per node.