Package com.jgalgo.graph

Interface IntGraphFactory

All Superinterfaces:
GraphFactory<Integer,Integer>
All Known Subinterfaces:
IndexGraphFactory
public interface IntGraphFactory extends GraphFactory<Integer,Integer>
A factory for IntGraph objects.

The factory can be used to create new empty graphs, with different options and capabilities. Few methods are available to optimize the graph implementation choice. The factory can also be used to create a copy of an existing graphs, with the same vertices and edges, with/without copying the vertices/edges weights.

Both the graph factory and IntGraphBuilder are used to create new graphs. The difference is that vertices and edges can be added to the builder, which is then used to construct non empty graphs, while the factory is only used to choose a graph implementation and create an empty graph.

This interface is a specification of GraphFactory for IntGraph.

Author:
Barak Ugav
See Also:

  • Method Details

    • newGraph

      IntGraph newGraph()
      Description copied from interface: GraphFactory
      Create a new empty graph.
      Specified by:
      newGraph in interface GraphFactory<Integer,Integer>
      Returns:
      a new graph with the factory options

    • newCopyOf

      default IntGraph newCopyOf(Graph<Integer,Integer> g)
      Description copied from interface: GraphFactory
      Create a copy of a given graph, with the same vertices and edges, without copying weights.

      An identical copy of the given graph will be created, with the same vertices and edges, without copying the vertices/edges weights. The returned Graph will always be mutable, with no side affects on the original graph.

      Differing from Graph.copy(), the capabilities of the new graph are determined by the factory configuration, rather than copied from the given graph. Note for example that if the factory chooses to use an implementation that does not support self edges (if GraphFactory.allowSelfEdges(boolean) was not called with true), attempting to create a copy of a graph that does contains self edges will result in an exception.

      For an immutable copy of a graph, see GraphFactory.newImmutableCopyOf(Graph, boolean, boolean).

      Specified by:
      newCopyOf in interface GraphFactory<Integer,Integer>
      Parameters:
      g - the original graph to copy
      Returns:
      an identical copy of the given graph, with the same vertices and edges, without the original graph weights

    • newCopyOf

      IntGraph newCopyOf(Graph<Integer,Integer> g, boolean copyVerticesWeights, boolean copyEdgesWeights)
      Description copied from interface: GraphFactory
      Create a copy of a given graph, with the same vertices and edges, with/without copying weights.

      An identical copy of the given graph will be created, with the same vertices and edges, with/without copying the vertices/edges weights. The returned Graph will always be mutable, with no side affects on the original graph.

      Differing from Graph.copy(boolean, boolean), the capabilities of the new graph are determined by the factory configuration, rather than copied from the given graph. Note for example that if the factory chooses to use an implementation that does not support self edges (if GraphFactory.allowSelfEdges(boolean) was not called with true), attempting to create a copy of a graph that does contains self edges will result in an exception.

      For an immutable copy of a graph, see GraphFactory.newImmutableCopyOf(Graph, boolean, boolean).

      Specified by:
      newCopyOf in interface GraphFactory<Integer,Integer>
      Parameters:
      g - the original graph to copy
      copyVerticesWeights - if true, the weights of the vertices will be copied to the new graph
      copyEdgesWeights - if true, the weights of the edges will be copied to the new graph
      Returns:
      an identical copy of the given graph, with the same vertices and edges, with/without the original graph weights

    • newImmutableCopyOf

      default IntGraph newImmutableCopyOf(Graph<Integer,Integer> g)
      Description copied from interface: GraphFactory
      Create a new immutable copy of a given graph, with the same vertices and edges, without copying weights.

      An identical copy of the given graph will be created, with the same vertices and edges, without copying the vertices/edges weights. The returned Graph will be immutable, with no side affects on the original graph.

      Differing from Graph.immutableCopy(), the capabilities of the new graph are determined by the factory configuration, rather than copied from the given graph. Note for example that if the factory chooses to use an implementation that does not support self edges (if GraphFactory.allowSelfEdges(boolean) was not called with true), attempting to create a copy of a graph that does contains self edges will result in an exception.

      For a mutable copy of a graph, see GraphFactory.newCopyOf(Graph, boolean, boolean).

      Specified by:
      newImmutableCopyOf in interface GraphFactory<Integer,Integer>
      Parameters:
      g - the original graph to copy
      Returns:
      an identical immutable copy of the given graph, with the same vertices and edges, without the original graph weights

    • newImmutableCopyOf

      IntGraph newImmutableCopyOf(Graph<Integer,Integer> g, boolean copyVerticesWeights, boolean copyEdgesWeights)
      Description copied from interface: GraphFactory
      Create a new immutable copy of a given graph, with the same vertices and edges, with/without copying weights.

      An identical copy of the given graph will be created, with the same vertices and edges, with/without copying the vertices/edges weights. The returned Graph will be immutable, with no side affects on the original graph.

      Differing from Graph.immutableCopy(boolean, boolean), the capabilities of the new graph are determined by the factory configuration, rather than copied from the given graph. Note for example that if the factory chooses to use an implementation that does not support self edges (if GraphFactory.allowSelfEdges(boolean) was not called with true), attempting to create a copy of a graph that does contains self edges will result in an exception.

      For a mutable copy of a graph, see GraphFactory.newCopyOf(Graph, boolean, boolean).

      Specified by:
      newImmutableCopyOf in interface GraphFactory<Integer,Integer>
      Parameters:
      g - the original graph to copy
      copyVerticesWeights - if true, the weights of the vertices will be copied to the new graph
      copyEdgesWeights - if true, the weights of the edges will be copied to the new graph
      Returns:
      an identical immutable copy of the given graph, with the same vertices and edges, without the original graph weights

    • newBuilder

      IntGraphBuilder newBuilder()
      Description copied from interface: GraphFactory
      Create a new graph builder with the factory parameters.

      The created builder can be used to add vertices and edges, and then build a (mutable or immutable) non empty graph, differing from the factory which only builds empty graphs. The capabilities such as un/directed, support of self edges, support of parallel edges, and hints such as expected number of vertices and edges, other hints, etc. are copied from the factory to the builder.

      Specified by:
      newBuilder in interface GraphFactory<Integer,Integer>
      Returns:
      a new graph builder with the factory parameters

    • newBuilderCopyOf

      default IntGraphBuilder newBuilderCopyOf(Graph<Integer,Integer> g)
      Description copied from interface: GraphFactory
      Create a new graph builder with the factory parameters initialized with an existing graph vertices and edges, without copying the weights.

      If the given graph is directed, the new builder will build directed graphs, and similarly for undirected graphs.

      Specified by:
      newBuilderCopyOf in interface GraphFactory<Integer,Integer>
      Parameters:
      g - a graph
      Returns:
      a graph builder with the factory parameters initialized with the given graph vertices and edges, without the original graph vertices/edges weights.

    • newBuilderCopyOf

      IntGraphBuilder newBuilderCopyOf(Graph<Integer,Integer> g, boolean copyVerticesWeights, boolean copyEdgesWeights)
      Description copied from interface: GraphFactory
      Create a new graph builder with the factory parameters initialized with an existing graph vertices and edges, with/without copying the weights.

      If the given graph is directed, the new builder will build directed graphs, and similarly for undirected graphs.

      Specified by:
      newBuilderCopyOf in interface GraphFactory<Integer,Integer>
      Parameters:
      g - a graph
      copyVerticesWeights - if true, the weights of the vertices will be copied from the graph to the builder
      copyEdgesWeights - if true, the weights of the edges will be copied from the graph to the builder
      Returns:
      a graph builder with the factory parameters initialized with the given graph vertices and edges, with/without the original graph vertices/edges weights.

    • setDirected

      IntGraphFactory setDirected(boolean directed)
      Description copied from interface: GraphFactory
      Determine if graphs built by this factory should be directed.

      Usually the factory will be created using either GraphFactory.directed() or GraphFactory.undirected(), and there will be no need to call this method. However, it is sometimes useful use the same factory to build both directed and undirected graphs, and this method can be used to change the factory configuration. For example, a factory can be passed to a random graph generator, which can generated both directed and undirected graphs, depending on the generator parameters.

      Specified by:
      setDirected in interface GraphFactory<Integer,Integer>
      Parameters:
      directed - if true graphs built by this factory will be directed, else they will be undirected
      Returns:
      this factory

    • allowSelfEdges

      default IntGraphFactory allowSelfEdges()
      Description copied from interface: GraphFactory
      Change the config of this factory so that the built graphs will support self edges.

      By default, graphs built by this factory will not support self edges.

      Specified by:
      allowSelfEdges in interface GraphFactory<Integer,Integer>
      Returns:
      this factory

    • allowSelfEdges

      IntGraphFactory allowSelfEdges(boolean selfEdges)
      Description copied from interface: GraphFactory
      Determine if graphs built by this factory should be support self edges.

      By default, graphs built by this factory will not support self edges.

      Specified by:
      allowSelfEdges in interface GraphFactory<Integer,Integer>
      Parameters:
      selfEdges - if true graphs built by this factory will support self edges, else they will not
      Returns:
      this factory

    • allowParallelEdges

      default IntGraphFactory allowParallelEdges()
      Description copied from interface: GraphFactory
      Change the config of this factory so that the built graphs will support parallel edges.

      By default, graphs built by this factory will support parallel edges. The reason is that in order to enforce no parallel edges are added to the graph, an efficient lookup of edges (keyed by an edge's vertices) is required, which is an operation most graph algorithms do not use and therefore most implementations are not optimized for. See GraphFactory.Hint.FastEdgeLookup.

      Specified by:
      allowParallelEdges in interface GraphFactory<Integer,Integer>
      Returns:
      this factory

    • allowParallelEdges

      IntGraphFactory allowParallelEdges(boolean parallelEdges)
      Description copied from interface: GraphFactory
      Determine if graphs built by this factory should be support parallel edges.

      By default, graphs built by this factory will support parallel edges. The reason is that in order to enforce no parallel edges are added to the graph, an efficient lookup of edges (keyed by an edge's vertices) is required, which is an operation most graph algorithms do not use and therefore most implementations are not optimized for. See GraphFactory.Hint.FastEdgeLookup.

      Specified by:
      allowParallelEdges in interface GraphFactory<Integer,Integer>
      Parameters:
      parallelEdges - if true graphs built by this factory will support parallel edges, else they will not
      Returns:
      this factory

    • expectedVerticesNum

      IntGraphFactory expectedVerticesNum(int expectedVerticesNum)
      Description copied from interface: GraphFactory
      Set the expected number of vertices that will exist in the graph.
      Specified by:
      expectedVerticesNum in interface GraphFactory<Integer,Integer>
      Parameters:
      expectedVerticesNum - the expected number of vertices in the graph
      Returns:
      this factory

    • expectedEdgesNum

      IntGraphFactory expectedEdgesNum(int expectedEdgesNum)
      Description copied from interface: GraphFactory
      Set the expected number of edges that will exist in the graph.
      Specified by:
      expectedEdgesNum in interface GraphFactory<Integer,Integer>
      Parameters:
      expectedEdgesNum - the expected number of edges in the graph
      Returns:
      this factory

    • setVertexBuilder

      default IntGraphFactory setVertexBuilder(IdBuilder<Integer> vertexBuilder)
      Set the vertex builder used by the built graph(s).

      The vertex builder is used by graphs to create new vertices when the user does not provide them explicitly, see Graph.addVertex(). The same vertex builder will be used for all graphs built by this factory, and graphs built by GraphBuilder created by this factory. If a different instance of a vertex builder is required for each graph, consider using GraphFactory.setVertexFactory(Supplier) instead.

      For some types there is a default vertex builder, see IdBuilder.defaultBuilder(Class).

      By default, graphs built by this factory will not have a vertex builder, namely a null vertex builder.

      By default, graphs created by this factory will have a vertex builder that uses a counter and assign the next id to each new vertex by incrementing the counter until there is no vertex with that id.

      Specified by:
      setVertexBuilder in interface GraphFactory<Integer,Integer>
      Parameters:
      vertexBuilder - the vertex builder, or null if no vertex builder should be used
      Returns:
      this factory

    • setVertexFactory

      IntGraphFactory setVertexFactory(Supplier<? extends IdBuilder<Integer>> vertexFactory)
      Description copied from interface: GraphFactory
      Set the vertex factory which create builders for the vertices of the built graph(s).

      The vertex builder is used by graphs to create new vertices when the user does not provide them explicitly, see Graph.addVertex(). The factory will be used to insatiate a new vertex builder for each graph built by this factory, and graphs built by GraphBuilder created by this factory. If the same vertex builder can be used for all graphs, consider using GraphFactory.setVertexBuilder(IdBuilder) instead.

      For some types there is a default vertex factory, see IdBuilder.defaultFactory(Class).

      By default, graphs built by this factory will not have a vertex builder, namely a null vertex builder.

      Specified by:
      setVertexFactory in interface GraphFactory<Integer,Integer>
      Parameters:
      vertexFactory - the vertex factory, or null if no vertex builder should be used
      Returns:
      this factory

    • setEdgeBuilder

      default IntGraphFactory setEdgeBuilder(IdBuilder<Integer> edgeBuilder)
      Set the edge builder used by the built graph(s).

      The edge builder is used by graphs to create new edges when the user does not provide them explicitly, see Graph.addEdge(Object, Object). The same edge builder will be used for all graphs built by this factory, and graphs built by GraphBuilder created by this factory. If a different instance of an edge builder is required for each graph, consider using GraphFactory.setEdgeFactory(Supplier) instead.

      For some types there is a default edge builder, see IdBuilder.defaultBuilder(Class).

      By default, graphs built by this factory will not have an edge builder, namely a null edge builder.

      By default, graphs created by this factory will have an edge builder that uses a counter and assign the next id to each new edge by incrementing the counter until there is no edge with that id.

      Specified by:
      setEdgeBuilder in interface GraphFactory<Integer,Integer>
      Parameters:
      edgeBuilder - the edge builder, or null if no edge builder should be used
      Returns:
      this factory

    • setEdgeFactory

      IntGraphFactory setEdgeFactory(Supplier<? extends IdBuilder<Integer>> edgeFactory)
      Description copied from interface: GraphFactory
      Set the edge factory which create builders for the edges of the built graph(s).

      The edge builder is used by graphs to create new edges when the user does not provide them explicitly, see Graph.addEdge(Object, Object). The factory will be used to insatiate a new edge builder for each graph built by this factory, and graphs built by GraphBuilder created by this factory. If the same edge builder can be used for all graphs, consider using GraphFactory.setEdgeBuilder(IdBuilder) instead.

      For some types there is a default edge factory, see IdBuilder.defaultFactory(Class).

      By default, graphs built by this factory will not have an edge builder, namely a null edge builder.

      Specified by:
      setEdgeFactory in interface GraphFactory<Integer,Integer>
      Parameters:
      edgeFactory - the edge factory, or null if no edge builder should be used
      Returns:
      this factory

    • addHint

      IntGraphFactory addHint(GraphFactory.Hint hint)
      Description copied from interface: GraphFactory
      Add a hint to this factory.

      Hints do not change the behavior of the graphs built by this factory, by may affect performance.

      Specified by:
      addHint in interface GraphFactory<Integer,Integer>
      Parameters:
      hint - the hint to add
      Returns:
      this factory

    • removeHint

      IntGraphFactory removeHint(GraphFactory.Hint hint)
      Description copied from interface: GraphFactory
      Remove a hint from this factory.

      Hints do not change the behavior of the graphs built by this factory, by may affect performance.

      Specified by:
      removeHint in interface GraphFactory<Integer,Integer>
      Parameters:
      hint - the hint to remove
      Returns:
      this factory

    • undirected

      static IntGraphFactory undirected()
      Create an undirected int graph factory.
      Returns:
      a new factory that can build undirected int graphs

    • directed

      static IntGraphFactory directed()
      Create a directed int graph factory.
      Returns:
      a new factory that can build directed int graphs

    • newInstance

      static IntGraphFactory newInstance(boolean directed)
      Create a new un/directed int graph factory.
      Parameters:
      directed - whether the graphs created by the factory should be directed
      Returns:
      a new factory that can build un/directed int graphs

    • setOption

      default IntGraphFactory setOption(String key, Object value)
      Description copied from interface: GraphFactory
      [TL;DR Don't call me!] Set an option.

      The builder might support different options to customize its implementation. These options never change the behavior of the algorithm, only its internal implementation. The possible options are not exposed as 'public' because they are not part of the API and may change in the future.

      These options are mainly for debug and benchmark purposes.

      Specified by:
      setOption in interface GraphFactory<Integer,Integer>
      Parameters:
      key - the option key
      value - the option value
      Returns:
      this builder