Graph | @mauriciopoppe/graph

Hierarchy

EventEmitter
- Graph

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Graph(opts?: GraphOptions): Graph

- Defined in index.ts:64
Parameters
- Default value opts: GraphOptions = {}
  
  GraphOptions opts.directed boolean opts.multigraph boolean opts.compound boolean
Returns Graph

Properties

Private _children

_children: Map<N, Set<N>>

Private _edgeObjs

_edgeObjs: Map<E, Edge>

Private _edges

_edges: Map<E, any>

Private _inEdges

_inEdges: Map<N, Map<E, Edge>>

Private _isCompound

_isCompound: boolean

True if the graph is compound e.g. when there are parent-child relationship between nodes

default: false

Private _isDirected

_isDirected: boolean

True if the graph is directed, see http://mathworld.wolfram.com/DirectedGraph.html

default: true

Private _isMultigraph

_isMultigraph: boolean

True if the graph is a multigraph, see http://mathworld.wolfram.com/Multigraph.html

default: false

Private _listeners

_listeners: Map<string, Set<function>>

Private _nodes

_nodes: Map<N, any>

Private _outEdges

_outEdges: Map<N, Map<E, Edge>>

Private _parent

_parent: Map<N, N>

Private _predecessors

_predecessors: Map<N, Map<N, number>>

Private _successors

_successors: Map<N, Map<N, number>>

Static prefixed

prefixed: string | boolean

Methods

addListener

addListener(event: string | symbol, fn: ListenerFn, context?: any): this

Inherited from EventEmitter.addListener
- Defined in /Users/mauricio/code/projects/js/graph/node_modules/eventemitter3/index.d.ts:33
Parameters
- event: string | symbol
- fn: ListenerFn
- Optional context: any
Returns this

children

children(node?: N): IterableIterator<N>

- Defined in index.ts:254
Parameters
- Default value node: N = GRAPH_NODE
Returns IterableIterator<N>

edge

edge(...args: Array<any>): E

- Defined in index.ts:398
Parameters
- Rest ...args: Array<any>
Returns E

edgeCount

edgeCount(): number

- Defined in index.ts:319
Returns number

edges

edges(): IterableIterator<Edge>

- Defined in index.ts:323
Returns IterableIterator<Edge>

emit

emit(event: string | symbol, ...args: Array<any>): boolean

Inherited from EventEmitter.emit
- Defined in /Users/mauricio/code/projects/js/graph/node_modules/eventemitter3/index.d.ts:27
Calls each of the listeners registered for a given event.

Parameters
- event: string | symbol
- Rest ...args: Array<any>
Returns boolean

eventNames

eventNames(): Array<string | symbol>

Inherited from EventEmitter.eventNames
- Defined in /Users/mauricio/code/projects/js/graph/node_modules/eventemitter3/index.d.ts:16
Return an array listing the events for which the emitter has registered listeners.

Returns Array<string | symbol>

hasEdge

hasEdge(...args: Array<any>): boolean

- Defined in index.ts:407
Parameters
- Rest ...args: Array<any>
Returns boolean

hasNode

hasNode(node: N): boolean

- Defined in index.ts:173
Parameters
- node: N
Returns boolean

inEdges

inEdges(v: N, u?: N): IterableIterator<Edge>

- Defined in index.ts:437
Parameters
- v: N
- Optional u: N
Returns IterableIterator<Edge>

isCompound

isCompound(): boolean

- Defined in index.ts:115
Returns boolean

isDirected

isDirected(): boolean

- Defined in index.ts:107
Returns boolean

isLeaf

isLeaf(node: N): boolean

- Defined in index.ts:310
Parameters
- node: N
Returns boolean

isMultigraph

isMultigraph(): boolean

- Defined in index.ts:111
Returns boolean

listeners

listeners(event: string | symbol, exists: boolean): Array<ListenerFn> | boolean
listeners(event: string | symbol): Array<ListenerFn>

Inherited from EventEmitter.listeners
- Defined in /Users/mauricio/code/projects/js/graph/node_modules/eventemitter3/index.d.ts:21
Return the listeners registered for a given event.

Parameters
- event: string | symbol
- exists: boolean
Returns Array<ListenerFn> | boolean
Inherited from EventEmitter.listeners
- Defined in /Users/mauricio/code/projects/js/graph/node_modules/eventemitter3/index.d.ts:22
Parameters
- event: string | symbol
Returns Array<ListenerFn>

neighbors

neighbors(node: N): IterableIterator<N>

- Defined in index.ts:291
Parameters
- node: N
Returns IterableIterator<N>

node

node(node: N): any

- Defined in index.ts:169
Parameters
- node: N
Returns any

nodeCount

nodeCount(): number

- Defined in index.ts:120
Returns number

nodeEdges

nodeEdges(v: N, w: N): IterableIterator<Edge>

- Defined in index.ts:466
Parameters
- v: N
- w: N
Returns IterableIterator<Edge>

nodes

nodes(): IterableIterator<N>

- Defined in index.ts:124
Returns IterableIterator<N>

off

off(event: string | symbol, fn?: ListenerFn, context?: any, once?: undefined | true | false): this

Inherited from EventEmitter.off
- Defined in /Users/mauricio/code/projects/js/graph/node_modules/eventemitter3/index.d.ts:44
Parameters
- event: string | symbol
- Optional fn: ListenerFn
- Optional context: any
- Optional once: undefined | true | false
Returns this

on

on(event: string | symbol, fn: ListenerFn, context?: any): this

Inherited from EventEmitter.on
- Defined in /Users/mauricio/code/projects/js/graph/node_modules/eventemitter3/index.d.ts:32
Add a listener for a given event.

Parameters
- event: string | symbol
- fn: ListenerFn
- Optional context: any
Returns this

once

once(event: string | symbol, fn: ListenerFn, context?: any): this

Inherited from EventEmitter.once
- Defined in /Users/mauricio/code/projects/js/graph/node_modules/eventemitter3/index.d.ts:38
Add a one-time listener for a given event.

Parameters
- event: string | symbol
- fn: ListenerFn
- Optional context: any
Returns this

outEdges

outEdges(v: N, w?: N): IterableIterator<Edge>

- Defined in index.ts:451
Parameters
- v: N
- Optional w: N
Returns IterableIterator<Edge>

parent

parent(node: N): N | undefined

- Defined in index.ts:245
Parameters
- node: N
Returns N | undefined

predecessors

predecessors(node: N): IterableIterator<N>

- Defined in index.ts:267
Parameters
- node: N
Returns IterableIterator<N>

removeAllListeners

removeAllListeners(event?: string | symbol): this

Inherited from EventEmitter.removeAllListeners
- Defined in /Users/mauricio/code/projects/js/graph/node_modules/eventemitter3/index.d.ts:49
Remove all listeners, or those of the specified event.

Parameters
- Optional event: string | symbol
Returns this

removeEdge

removeEdge(...args: Array<any>): Graph

- Defined in index.ts:416
Parameters
- Rest ...args: Array<any>
Returns Graph

Private removeFromParentsChildList

removeFromParentsChildList(node: N): void

- Defined in index.ts:475
Parameters
- node: N
Returns void

removeListener

removeListener(event: string | symbol, fn?: ListenerFn, context?: any, once?: undefined | true | false): this

Inherited from EventEmitter.removeListener
- Defined in /Users/mauricio/code/projects/js/graph/node_modules/eventemitter3/index.d.ts:43
Remove the listeners of a given event.

Parameters
- event: string | symbol
- Optional fn: ListenerFn
- Optional context: any
- Optional once: undefined | true | false
Returns this

removeNode

removeNode(node: N): void

- Defined in index.ts:177
Parameters
- node: N
Returns void

setEdge

setEdge(...args: Array<any>): Graph

- Defined in index.ts:339
Parameters
- Rest ...args: Array<any>
Returns Graph

setNode

setNode(node: N, value?: any): Graph

- Defined in index.ts:144
Parameters
- node: N
- Optional value: any
Returns Graph

setParent

setParent(node: N, parent?: N): Graph

- Defined in index.ts:213
Parameters
- node: N
- Optional parent: N
Returns Graph

setPath

setPath(path: Array<N>, value?: any): Graph

- Defined in index.ts:327
Parameters
- path: Array<N>
- Optional value: any
Returns Graph

sinks

sinks(): IterableIterator<N>

- Defined in index.ts:136
Returns IterableIterator<N>

sources

sources(): IterableIterator<N>

- Defined in index.ts:128
Returns IterableIterator<N>

successors

successors(node: N): IterableIterator<N>

- Defined in index.ts:279
Parameters
- node: N
Returns IterableIterator<N>

Generated using TypeDoc

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Default value opts: GraphOptions = {}

Returns Graph

Properties

Private _children

Private _edgeObjs

Private _edges

Private _inEdges

Private _isCompound

Private _isDirected

Private _isMultigraph

Private _listeners

Private _nodes

Private _outEdges

Private _parent

Private _predecessors

Private _successors

Static prefixed

Methods

addListener

Parameters

event: string | symbol

fn: ListenerFn

Optional context: any

Returns this

children

Parameters

Default value node: N = GRAPH_NODE

Returns IterableIterator<N>

edge

Parameters

Rest ...args: Array<any>

Returns E

edgeCount

Returns number

edges

Returns IterableIterator<Edge>

emit

Parameters

event: string | symbol

Rest ...args: Array<any>

Returns boolean

eventNames

Returns Array<string | symbol>

hasEdge

Parameters

Rest ...args: Array<any>

Returns boolean

hasNode

Parameters

node: N

Returns boolean

inEdges

Parameters

v: N

Optional u: N

Returns IterableIterator<Edge>

isCompound

Returns boolean

isDirected

Returns boolean

isLeaf

Parameters

node: N

Returns boolean

isMultigraph

Returns boolean

listeners

Parameters

event: string | symbol

exists: boolean

Returns Array<ListenerFn> | boolean

Parameters