Package com.jgalgo.alg.shortestpath

Interface VoronoiAlgo.IResult

All Superinterfaces:
VoronoiAlgo.Result<Integer,Integer>
Enclosing interface:
VoronoiAlgo
public static interface VoronoiAlgo.IResult extends VoronoiAlgo.Result<Integer,Integer>
A result object of VoronoiAlgo computation for IntGraph.

See VoronoiAlgo.Result for the result object documentation.

Author:
Barak Ugav

  • Method Details

    • partition

      IVertexPartition partition()
      Description copied from interface: VoronoiAlgo.Result
      Get the partition of the graph to blocks where each block contains the vertices which are closest to a single site.
      Specified by:
      partition in interface VoronoiAlgo.Result<Integer,Integer>
      Returns:
      the partition of the graph to sites blocks

    • distance

      double distance(int vertex)
      Get the distance of a vertex from its site.

      Note that the direction of the distances and paths (in case of a directed graph) is from the sites to the vertices.

      Parameters:
      vertex - a target vertex
      Returns:
      the shortest distance from any site to the target vertex, or Double.POSITIVE_INFINITY if the target vertex is unreachable from any site

    • distance

      @Deprecated default double distance(Integer vertex)
      Deprecated.
      Please use distance(int) instead to avoid un/boxing.
      Get the distance of a vertex from its site.

      Note that the direction of the distances and paths (in case of a directed graph) is from the sites to the vertices.

      Specified by:
      distance in interface VoronoiAlgo.Result<Integer,Integer>
      Parameters:
      vertex - a target vertex
      Returns:
      the shortest distance from any site to the target vertex, or Double.POSITIVE_INFINITY if the target vertex is unreachable from any site

    • getPath

      IPath getPath(int target)
      Get the shortest path of a vertex from its site.

      Note that the direction of the distances and paths (in case of a directed graph) is from the sites to the vertices.

      Parameters:
      target - a target vertex
      Returns:
      the shortest path from any site to the target vertex, or null if the target vertex is unreachable from any site

    • getPath

      @Deprecated default IPath getPath(Integer target)
      Deprecated.
      Please use getPath(int) instead to avoid un/boxing.
      Get the shortest path of a vertex from its site.

      Note that the direction of the distances and paths (in case of a directed graph) is from the sites to the vertices.

      Specified by:
      getPath in interface VoronoiAlgo.Result<Integer,Integer>
      Parameters:
      target - a target vertex
      Returns:
      the shortest path from any site to the target vertex, or null if the target vertex is unreachable from any site

    • blockSiteInt

      int blockSiteInt(int block)
      Get the site vertex of a block.

      The Voronoi cells are defined by the sites. Each 'block' contains all the vertices that are closer to the site of the block than to any other site. This method return the site vertex of one of the blocks [0, numberOfBlocks()).

      In case some vertices are unreachable from any sites, the partition will contain an addition block with index siteNumber+1 that contains all these vertices. This method will return -1 for this block.

      Parameters:
      block - index of a block
      Returns:
      the site vertex of the block, or -1 if the block is the unreachable block

    • blockSite

      @Deprecated default Integer blockSite(int block)
      Deprecated.
      Please use blockSiteInt(int) instead to avoid un/boxing.
      Get the site vertex of a block.

      The Voronoi cells are defined by the sites. Each 'block' contains all the vertices that are closer to the site of the block than to any other site. This method return the site vertex of one of the blocks [0, numberOfBlocks()).

      In case some vertices are unreachable from any sites, the partition will contain an addition block with index siteNumber+1 that contains all these vertices. This method will return null for this block.

      Specified by:
      blockSite in interface VoronoiAlgo.Result<Integer,Integer>
      Parameters:
      block - index of a block
      Returns:
      the site vertex of the block, or null if the block is the unreachable block

    • vertexSite

      int vertexSite(int vertex)
      Get the site vertex of a vertex.

      The Voronoi cells are defined by the sites. Each 'block' contains all the vertices that are closer to the site of the block than to any other site. This method return the site vertex of the block that contains the vertex, namely the site with the shortest path from any site to the vertex.

      Parameters:
      vertex - a vertex
      Returns:
      the site vertex with the shortest path from any site to the vertex

    • vertexSite

      @Deprecated default Integer vertexSite(Integer vertex)
      Deprecated.
      Please use vertexSite(int) instead to avoid un/boxing.
      Get the site vertex of a vertex.

      The Voronoi cells are defined by the sites. Each 'block' contains all the vertices that are closer to the site of the block than to any other site. This method return the site vertex of the block that contains the vertex, namely the site with the shortest path from any site to the vertex.

      Specified by:
      vertexSite in interface VoronoiAlgo.Result<Integer,Integer>
      Parameters:
      vertex - a vertex
      Returns:
      the site vertex with the shortest path from any site to the vertex, or null if the block is the unreachable block