Source: graph/basic.js

  1. /**
  2.  * @overview Includes basic graph functions like creating a graph or cloning it.
  3.  */
  5. import cloneObj from 'lodash/fp/clone'
  6. import curry from 'lodash/fp/curry'
  7. import {create, isomorph as cIsomorph} from '../compound'
  8. import {isomorphComponents} from './component'
  9. import {setMetaKey} from './meta'
  10. import {packageVersion} from '../internals'
  12. /**
  13.  * Creates a new graph that has the exact same nodes and edges.
  14.  * @param {PortGraph} graph The graph to clone
  15.  * @returns {PortGraph} A clone of the input graph.
  16.  */
  17. export function clone (graph) {
  18.   return cloneObj(graph)
  19. }
  21. /**
  22.  * Compares two graphs for structural equality (i.e. tests if they are isomorph, where it is
  23.  * allowed to change the ids and paths of every node).
  24.  * @param {Portgraph} graph1 One of the graphs to compare.
  25.  * @param {Portgraph} graph2 The other the graph to compare.
  26.  * @returns {boolean} True if both graphs are structually equal, false otherwise.
  27.  */
  28. export const isomorph = curry((graph1, graph2) => {
  29.   return cIsomorph(graph1, graph2) && isomorphComponents(graph1, graph2)
  30. })
  32. /**
  33.  * Create a new compound node. Each compound node is itself a graph that can contain further nodes.
  34.  * @param {Node} node The node that should be converted into a compound node.
  35.  * @returns {PortGraph} The graph representing the compound node.
  36.  */
  37. export const compound = create
  39. /**
  40.  * Returns a new empty graph.
  41.  * @returns {PortGraph} A new empty port graph.
  42.  */
  43. export function empty () {
  44.   return setMetaKey('version', packageVersion(), create())
  45. }