Class EdgeCollection<E, D, S>

A collection of edges from a given graph. All edges have a common edge type. If the edges can be of any edge type, the common type is BaseEdge.

Type Parameters

E extends BaseEdge.Class<D, S>
D extends BaseEdge.Data = Edge.ExtractData<E>
S extends BaseEdge.ScratchData = Edge.ExtractScratchData<E>

Indexable

[index: number]: E
Access the edge at the given index.

Accessors

graph

get graph(): BaseGraph.Class<BaseGraph.Data, BaseGraph.ScratchData>
Returns BaseGraph.Class<BaseGraph.Data, BaseGraph.ScratchData>
the graph that this collection is a part of.
- Defined in lara-flow/src/graph/EdgeCollection.ts:869

isEmpty

get isEmpty(): boolean
Returns boolean
Whether this collection is empty.
- Defined in lara-flow/src/graph/EdgeCollection.ts:214

length

get length(): number
Returns number
The number of edges in this collection.
- Defined in lara-flow/src/graph/EdgeCollection.ts:207

sources

get sources(): NodeCollection<BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>, BaseNode.Data, BaseNode.ScratchData>
Returns NodeCollection<BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>, BaseNode.Data, BaseNode.ScratchData>
The source nodes connected to the edges in this collection.
- Defined in lara-flow/src/graph/EdgeCollection.ts:233

targets

get targets(): NodeCollection<BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>, BaseNode.Data, BaseNode.ScratchData>
Returns NodeCollection<BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>, BaseNode.Data, BaseNode.ScratchData>
The target nodes connected to the edges in this collection.
- Defined in lara-flow/src/graph/EdgeCollection.ts:241

Methods

[iterator]

[iterator](): Iterator<E, void, any>
Makes this class behave like an iterable object.

Returns Iterator<E, void, any>
- Defined in lara-flow/src/graph/EdgeCollection.ts:853

allAre

allAre<D2, S2, E2>(EdgeType): this is EdgeCollection<BaseEdge.Class<D2, S2>, D2, S2>
Checks if all edges in this collection are compatible with a specific type. This is effectively a type guard function.
Type Parameters
- D2 extends BaseEdge.Data
- S2 extends BaseEdge.ScratchData
- E2 extends BaseEdge.Class<D2, S2>
Parameters
- EdgeType: Edge<D2, S2, E2>
  The edge type to check compatibility with.
Returns this is EdgeCollection<BaseEdge.Class<D2, S2>, D2, S2>
Whether the edge is compatible with the given type.
- Defined in lara-flow/src/graph/EdgeCollection.ts:253

allAs

allAs<E>(EdgeType): EdgeCollection<E, D, S>
Changes the functionality class of the edges. This is only possible if the data and scratch data are compatible with the new class.

This is analogous to BaseEdge.Class.as but for a collection of edges.
Type Parameters
- E extends BaseEdge.Class<D, S>
Parameters
- EdgeType: {
  Class: Edge.Class<D, S, E>;
  }
  The edge type to change the functionality class into.
  - Class: Edge.Class<D, S, E>
Returns EdgeCollection<E, D, S>
The same collection, with the new functionality class.
- Defined in lara-flow/src/graph/EdgeCollection.ts:298

at

at(index): undefined | E
Access the edge at the given index. This is similar to indexing, but has undefined in the return type.
Parameters
- index: number
  The index of the edge to access.
Returns undefined | E
The edge at the given index, or undefined if it does not exist.
- Defined in lara-flow/src/graph/EdgeCollection.ts:182

compareDiff

compareDiff<D2, S2, E2>(other): {
    both: EdgeCollection<E, D, S>;
    onlyLeft: EdgeCollection<E, D, S>;
    onlyRight: EdgeCollection<E2, D2, S2>;
}
Performs a diff comparison between this collection and another collection. You can think of the result as the added, removed, and kept elements to go from this collection to the other collection.
Type Parameters
- D2 extends BaseEdge.Data
- S2 extends BaseEdge.ScratchData
- E2 extends BaseEdge.Class<D2, S2>
Parameters
- other: EdgeCollection<E2, D2, S2>
  The other collection to compare with.
Returns {
    both: EdgeCollection<E, D, S>;
    onlyLeft: EdgeCollection<E, D, S>;
    onlyRight: EdgeCollection<E2, D2, S2>;
}
An object with three properties:
- both: A collection with the edges that are in both collections. The type of this collection is maintained.
- onlyLeft: A collection with the edges that are only in this collection. The type of this collection is maintained.
- onlyRight: A collection with the edges that are only in the other collection. The type of the other collection is maintained.
- both: EdgeCollection<E, D, S>
- onlyLeft: EdgeCollection<E, D, S>
- onlyRight: EdgeCollection<E2, D2, S2>
- Defined in lara-flow/src/graph/EdgeCollection.ts:543

complement

complement(): EdgeCollection<BaseEdge.Class<BaseEdge.Data, BaseEdge.ScratchData>, BaseEdge.Data, BaseEdge.ScratchData>
Returns EdgeCollection<BaseEdge.Class<BaseEdge.Data, BaseEdge.ScratchData>, BaseEdge.Data, BaseEdge.ScratchData>
The complement of this collection with respect to the universe of all edges in the graph.
- Defined in lara-flow/src/graph/EdgeCollection.ts:458

contains

contains<E2, D2, S2>(elements): boolean
Returns whether the collection contains the given edge or collection.
Type Parameters
- E2 extends BaseEdge.Class<D2, S2>
- D2 extends BaseEdge.Data
- S2 extends BaseEdge.ScratchData
Parameters
- elements: E2 | EdgeCollection<E2, D2, S2>
  The edge or collection to check for.
Returns boolean
Whether the collection contains the given edge or collection.
- Defined in lara-flow/src/graph/EdgeCollection.ts:370

containsAny

containsAny<E2, D2, S2>(elements): boolean
Returns whether the collection contains any of the edges in the given collection.
Type Parameters
- E2 extends BaseEdge.Class<D2, S2>
- D2 extends BaseEdge.Data
- S2 extends BaseEdge.ScratchData
Parameters
- elements: EdgeCollection<E2, D2, S2>
  The collection to check for.
Returns boolean
Whether the collection contains any of the edges in the given collection.
- Defined in lara-flow/src/graph/EdgeCollection.ts:384

difference

difference<D2, S2>(other): EdgeCollection<E, D, S>
Returns the set difference of this collection with another collection. You may chain this method to remove multiple collections.
Type Parameters
- D2 extends BaseEdge.Data
- S2 extends BaseEdge.ScratchData
Parameters
- other: EdgeCollection<BaseEdge.Class<D2, S2>, D2, S2>
  The other collection.
Returns EdgeCollection<E, D, S>
A new collection that consists of the edges in this collection that are not in the other collection.
- Defined in lara-flow/src/graph/EdgeCollection.ts:470

every

every(f): boolean
Returns whether all edges in the collection satisfy the provided function. Returns true for an empty collection.
Parameters
- f: ((ele: E, i: number, eles: this) => boolean)
  The function to test each edge. ele - The current element, i - The index of the current element, eles - The collection of elements being iterated.
  - - (ele, i, eles): boolean
    - Parameters
      ele: E
      i: number
      eles: this
      Returns boolean
Returns boolean
Whether all edges in the collection satisfy the function.
- Defined in lara-flow/src/graph/EdgeCollection.ts:628
every<T>(f, thisArg): boolean
Returns whether all edges in the collection satisfy the provided function. Returns true for an empty collection.
Type Parameters
- T
Parameters
- f: ((this: T, ele: E, i: number, eles: this) => boolean)
  The function to test each edge. ele - The current element, i - The index of the current element, eles - The collection of elements being iterated.
  - - (this, ele, i, eles): boolean
    - Parameters
      this: T
      ele: E
      i: number
      eles: this
      Returns boolean
- thisArg: T
  The value to use as this when executing the function.
Returns boolean
Whether all edges in the collection satisfy the function.
- Defined in lara-flow/src/graph/EdgeCollection.ts:638

expectAll

expectAll<E2, D2, S2>(EdgeType, message?): EdgeCollection<E2, D2, S2>
Changes the functionality class of the edges. Should only be used when it is known (but not statically provable) that all edges are compatible with the new class. If not, an error will be thrown.

It is bad practice to try and catch the error thrown by this function. For such cases, combine EdgeCollection.allAre with EdgeCollection.allAs.
Type Parameters
- E2 extends BaseEdge.Class<D2, S2>
- D2 extends BaseEdge.Data
- S2 extends BaseEdge.ScratchData
Parameters
- EdgeType: Edge<D2, S2, E2>
  The edge type to change the functionality class into.
- Optionalmessage: string | ((i: number) => string)
  The message to throw if the edge is not compatible with the type. May also be a function that takes the index of the first incompatible edge and returns a message.
Returns EdgeCollection<E2, D2, S2>
The edge collection, wrapped in the new functionality class.

Throws
LaraFlowError if any edge is not compatible with the type. This error should be seen as a logic error and not catched.
- Defined in lara-flow/src/graph/EdgeCollection.ts:323

filter

filter(f): EdgeCollection<E, D, S>
Returns a new collection containing only the edges that satisfy the provided function.
Parameters
- f: ((ele: E, i: number, eles: this) => boolean)
  The function to test each edge. ele - The current element, i - The index of the current element, eles - The collection of elements being iterated.
  - - (ele, i, eles): boolean
    - Parameters
      ele: E
      i: number
      eles: this
      Returns boolean
Returns EdgeCollection<E, D, S>
A new collection containing only the edges that satisfy the function.
- Defined in lara-flow/src/graph/EdgeCollection.ts:705
filter<T>(f, thisArg): EdgeCollection<E, D, S>
Returns a new collection containing only the edges that satisfy the provided function.
Type Parameters
- T
Parameters
- f: ((this: T, ele: E, i: number, eles: this) => boolean)
  The function to test each edge. ele - The current element, i - The index of the current element, eles - The collection of elements being iterated.
  - - (this, ele, i, eles): boolean
    - Parameters
      this: T
      ele: E
      i: number
      eles: this
      Returns boolean
- thisArg: T
  The value to use as this when executing the function.
Returns EdgeCollection<E, D, S>
A new collection containing only the edges that satisfy the function.
- Defined in lara-flow/src/graph/EdgeCollection.ts:715

filterIs

filterIs<E2, D2, S2>(EdgeType): EdgeCollection<E2, D2, S2>
Filters the collection, keeping only the edges that are compatible with the given type. The collection automatically becomes a collection of that type.
Type Parameters
- E2 extends BaseEdge.Class<D2, S2>
- D2 extends BaseEdge.Data
- S2 extends BaseEdge.ScratchData
Parameters
- EdgeType: Edge<D2, S2, E2>
  The edge type to test compatibility with.
Returns EdgeCollection<E2, D2, S2>
The collection, with the new edge type.
- Defined in lara-flow/src/graph/EdgeCollection.ts:277

first

first(): undefined | E
Get the first edge in the collection.

Returns undefined | E
- Defined in lara-flow/src/graph/EdgeCollection.ts:193

forEach

forEach(f): void
Executes the provided function once for each edge in the collection.

Unline the analogous cytoscape method, this method does not support exiting early by returning false, due to the fact that a return false; would not be clear and intuitive for someone reading the code. As such, this function follows the behavior of the Array.prototype.forEach method.

In the future, if that feature is really desirable, instead of returning false, the function could return an enum value that represents a control flow instruction. Until then, a for loop may be used.
Parameters
- f: ((ele: E, i: number, eles: this) => void)
  The function to execute for each edge. ele - The current element, i - The index of the current element, eles - The collection of elements being iterated.
  - - (ele, i, eles): void
    - Parameters
      ele: E
      i: number
      eles: this
      Returns void
Returns void
- Defined in lara-flow/src/graph/EdgeCollection.ts:669
forEach<T>(f, thisArg): void
Executes the provided function once for each edge in the collection.

Unline the analogous cytoscape method, this method does not support exiting early by returning false, due to the fact that a return false; would not be clear and intuitive for someone reading the code. As such, this function follows the behavior of the Array.prototype.forEach method.

In the future, if that feature is really desirable, instead of returning false, the function could return an enum value that represents a control flow instruction. Until then, a for loop may be used.
Type Parameters
- T
Parameters
- f: ((this: T, ele: E, i: number, eles: this) => void)
  The function to execute for each edge. ele - The current element, i - The index of the current element, eles - The collection of elements being iterated.
  - - (this, ele, i, eles): void
    - Parameters
      this: T
      ele: E
      i: number
      eles: this
      Returns void
- thisArg: T
  The value to use as this when executing the function.
Returns void
- Defined in lara-flow/src/graph/EdgeCollection.ts:686

getElementById

getElementById(id): undefined | E
Parameters
- id: string
Returns undefined | E
The edge with the given id, or undefined if it is not in this collection.
- Defined in lara-flow/src/graph/EdgeCollection.ts:222

intersection

intersection<D2, S2>(other): EdgeCollection<E, D, S>
Returns the intersection of this collection with another collection. You may chain this method to intersect multiple collections.
Type Parameters
- D2 extends BaseEdge.Data
- S2 extends BaseEdge.ScratchData
Parameters
- other: EdgeCollection<BaseEdge.Class<D2, S2>, D2, S2>
  The other collection to intersect with.
Returns EdgeCollection<E, D, S>
A new collection containing the intersection of all edges.
- Defined in lara-flow/src/graph/EdgeCollection.ts:443

last

last(): undefined | E
Get the last edge in the collection.

Returns undefined | E
- Defined in lara-flow/src/graph/EdgeCollection.ts:200

max

max(f): undefined | {
element: E;
value: number;
}
Find the maximum value in a collection.
Parameters
- f: ((ele: E, i: number, eles: this) => number)
  The function that returns the value to compare. ele - The current element, i - The index of the current element, eles - The collection of elements being iterated.
  - - (ele, i, eles): number
    - Parameters
      ele: E
      i: number
      eles: this
      Returns number
Returns undefined | {
element: E;
value: number;
}
An object with the maximum element and its value, or undefined if the collection is empty.
- Defined in lara-flow/src/graph/EdgeCollection.ts:793
max<T>(f, thisArg): undefined | {
element: E;
value: number;
}
Find the maximum value in a collection.
Type Parameters
- T
Parameters
- f: ((this: T, ele: E, i: number, eles: this) => number)
  The function that returns the value to compare. ele - The current element, i - The index of the current element, eles - The collection of elements being iterated.
  - - (this, ele, i, eles): number
    - Parameters
      this: T
      ele: E
      i: number
      eles: this
      Returns number
- thisArg: T
  The value to use as this when executing the function.
Returns undefined | {
element: E;
value: number;
}
An object with the maximum element and its value, or undefined if the collection is empty.
- Defined in lara-flow/src/graph/EdgeCollection.ts:806

min

min(f): undefined | {
element: E;
value: number;
}
Find the minimum value in a collection.
Parameters
- f: ((ele: E, i: number, eles: this) => number)
  The function that returns the value to compare. ele - The current element, i - The index of the current element, eles - The collection of elements being iterated.
  - - (ele, i, eles): number
    - Parameters
      ele: E
      i: number
      eles: this
      Returns number
Returns undefined | {
element: E;
value: number;
}
An object with the minimum element and its value, or undefined if the collection is empty.
- Defined in lara-flow/src/graph/EdgeCollection.ts:746
min<T>(f, thisArg): undefined | {
element: E;
value: number;
}
Find the minimum value in a collection.
Type Parameters
- T
Parameters
- f: ((this: T, ele: E, i: number, eles: this) => number)
  The function that returns the value to compare. ele - The current element, i - The index of the current element, eles - The collection of elements being iterated.
  - - (this, ele, i, eles): number
    - Parameters
      this: T
      ele: E
      i: number
      eles: this
      Returns number
- thisArg: T
  The value to use as this when executing the function.
Returns undefined | {
element: E;
value: number;
}
An object with the minimum element and its value, or undefined if the collection is empty.
- Defined in lara-flow/src/graph/EdgeCollection.ts:759

same

same<E2, D2, S2>(other): boolean
Returns whether the elements in the collection are the same as the elements in the other collection.
Type Parameters
- E2 extends BaseEdge.Class<D2, S2>
- D2 extends BaseEdge.Data
- S2 extends BaseEdge.ScratchData
Parameters
- other: EdgeCollection<E2, D2, S2>
  The other collection to compare with.
Returns boolean
Whether the elements in the collection are the same as the elements in the other collection.
- Defined in lara-flow/src/graph/EdgeCollection.ts:356

slice

slice(start?, end?): EdgeCollection<E, D, S>
Get a subset of the elements in the collection based on specified indices.
Parameters
- Optionalstart: number
  An integer that specifies where to start the selection. If omitted, the first element, with an index of 0, will be selected. Use negative numbers to select from the end of an array.
- Optionalend: number
  An integer that specifies where to end the selection. If omitted, all elements from the start position and to the end of the array will be selected. Use negative numbers to select from the end of an array.
Returns EdgeCollection<E, D, S>
A new collection containing the selected elements.
- Defined in lara-flow/src/graph/EdgeCollection.ts:841

some

some(f): boolean
Returns whether any edge in the collection satisfies the provided function. Returns false for an empty collection.
Parameters
- f: ((ele: E, i: number, eles: this) => boolean)
  The function to test each edge. ele - The current element, i - The index of the current element, eles - The collection of elements being iterated.
  - - (ele, i, eles): boolean
    - Parameters
      ele: E
      i: number
      eles: this
      Returns boolean
Returns boolean
Whether any edge in the collection satisfies the function.
- Defined in lara-flow/src/graph/EdgeCollection.ts:594
some<T>(f, thisArg): boolean
Returns whether any edge in the collection satisfies the provided function. Returns false for an empty collection.
Type Parameters
- T
Parameters
- f: ((this: T, ele: E, i: number, eles: this) => boolean)
  The function to test each edge. ele - The current element, i - The index of the current element, eles - The collection of elements being iterated.
  - - (this, ele, i, eles): boolean
    - Parameters
      this: T
      ele: E
      i: number
      eles: this
      Returns boolean
- thisArg: T
  The value to use as this when executing the function.
Returns boolean
Whether any edge in the collection satisfies the function.
- Defined in lara-flow/src/graph/EdgeCollection.ts:604

sort

sort(f): EdgeCollection<E, D, S>
Returns a collection with the elements sorted according to the given comparison function.

Regarding the return value of the comparison function:
- A negative value indicates that a should come before b.
- A positive value indicates that a should come after b.
- Zero or NaN indicates that a and b are considered equal.
Parameters
- f: ((a: E, b: E) => number)
  The comparison function to use for sorting.
  - - (a, b): number
    - Parameters
      a: E
      b: E
      Returns number
Returns EdgeCollection<E, D, S>
A new collection with the elements sorted.
- Defined in lara-flow/src/graph/EdgeCollection.ts:575

symmetricDifference

symmetricDifference<D2, S2>(other): EdgeCollection<E, D, S>
Returns the symmetric difference of this collection with another collection. This collection consists of the edges that are in either collection, but not in both.

If the rhs collection is a subtype of the lhs collection, the resulting collection will have the lhs type.
Type Parameters
- D2 extends BaseEdge.Data
- S2 extends BaseEdge.ScratchData
Parameters
- other: EdgeCollection<BaseEdge.Class<D2, S2>, D2, S2>
  The other collection to apply the symmetric difference with.
Returns EdgeCollection<E, D, S>
A new collection containing the symmetric difference of the two collections.

Throws
LaraFlowError if the other collection is from a different graph.
- Defined in lara-flow/src/graph/EdgeCollection.ts:494
symmetricDifference<D2, S2>(other): EdgeCollection<BaseEdge.Class<D | D2, S | S2>, D | D2, S | S2>
Returns the symmetric difference of this collection with another collection. This collection consists of the edges that are in either collection, but not in both.

If the rhs collection is not a subtype of the lhs collection, the resulting collection will be downgraded to a BaseEdge and must be casted to the desired type explicitly with EdgeCollection.allAs.
Type Parameters
- D2 extends BaseEdge.Data
- S2 extends BaseEdge.ScratchData
Parameters
- other: EdgeCollection<BaseEdge.Class<D2, S2>, D2, S2>
  The other collection to apply the symmetric difference with.
Returns EdgeCollection<BaseEdge.Class<D | D2, S | S2>, D | D2, S | S2>
A new collection containing the symmetric difference of the two collections.

Throws
LaraFlowError if the other collection is from a different graph.
- Defined in lara-flow/src/graph/EdgeCollection.ts:511

toArray

toArray(): E[]
Returns E[]
This collection as an array of edges.
- Defined in lara-flow/src/graph/EdgeCollection.ts:862

toCy

toCy(): EdgeCollection
Returns EdgeCollection
The underlying cytoscape collection object.
- Defined in lara-flow/src/graph/EdgeCollection.ts:876

union

union<D2, S2>(other): EdgeCollection<E, D, S>
Returns the union of this collection with another collection. You may chain this method to union multiple collections.

If the rhs collection is a subtype of the lhs collection, the resulting collection will have the lhs type.
Type Parameters
- D2 extends BaseEdge.Data
- S2 extends BaseEdge.ScratchData
Parameters
- other: EdgeCollection<BaseEdge.Class<D2, S2>, D2, S2>
  The other collection to union with.
Returns EdgeCollection<E, D, S>
A new collection containing the union of all edges.

Throws
LaraFlowError if the other collection is from a different graph.
- Defined in lara-flow/src/graph/EdgeCollection.ts:403
union<D2, S2>(other): EdgeCollection<BaseEdge.Class<D | D2, S | S2>, D | D2, S | S2>
Returns the union of this collection with another collection. You may chain this method to union multiple collections.

If the rhs collection is not a subtype of the lhs collection, the resulting collection will be downgraded to a BaseEdge and must be casted to the desired type explicitly with EdgeCollection.allAs.
Type Parameters
- D2 extends BaseEdge.Data
- S2 extends BaseEdge.ScratchData
Parameters
- other: EdgeCollection<BaseEdge.Class<D2, S2>, D2, S2>
  The other collection to union with.
Returns EdgeCollection<BaseEdge.Class<D | D2, S | S2>, D | D2, S | S2>
A new collection containing the union of all edges.

Throws
LaraFlowError if the other collection is from a different graph.
- Defined in lara-flow/src/graph/EdgeCollection.ts:418

`Static`from

from<E, D, S>(first, ...elements): EdgeCollection<E, D, S>
Creates a new collection from the given edges. At least one edge must be provided. For an empty collection, use BaseGraph.Class.emptyCollection.
Type Parameters
- E extends BaseEdge.Class<D, S>
- D extends BaseEdge.Data
- S extends BaseEdge.ScratchData
Parameters
- first: E
  The first edge in the collection.
- Rest...elements: E[]
  The rest of the edges in the collection.
Returns EdgeCollection<E, D, S>
A new collection containing the given edges.
- Defined in lara-flow/src/graph/EdgeCollection.ts:115

`Static`fromCy

fromCy(edges): EdgeCollection<BaseEdge.Class<BaseEdge.Data, BaseEdge.ScratchData>, BaseEdge.Data, BaseEdge.ScratchData>
Creates a new collection from the given cytoscape collection.
Parameters
- edges: EdgeCollection
  The cytoscape collection to create the collection from.
Returns EdgeCollection<BaseEdge.Class<BaseEdge.Data, BaseEdge.ScratchData>, BaseEdge.Data, BaseEdge.ScratchData>
A new collection containing the edges from the cytoscape collection.
- Defined in lara-flow/src/graph/EdgeCollection.ts:144

Class EdgeCollection<E, D, S>

Type Parameters

Indexable

Index

Accessors

Methods

Accessors

graph

Returns BaseGraph.Class<BaseGraph.Data, BaseGraph.ScratchData>

isEmpty

Returns boolean

length

Returns number

sources

Returns NodeCollection<BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>, BaseNode.Data, BaseNode.ScratchData>

targets

Returns NodeCollection<BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>, BaseNode.Data, BaseNode.ScratchData>

Methods

[iterator]

Returns Iterator<E, void, any>

allAre

Type Parameters

Parameters

Returns this is EdgeCollection<BaseEdge.Class<D2, S2>, D2, S2>

allAs

Type Parameters

Parameters

Class: Edge.Class<D, S, E>

Returns EdgeCollection<E, D, S>

at

Parameters

Returns undefined | E

compareDiff

Type Parameters

Parameters

Returns { both: EdgeCollection<E, D, S>; onlyLeft: EdgeCollection<E, D, S>; onlyRight: EdgeCollection<E2, D2, S2>; }

both: EdgeCollection<E, D, S>

onlyLeft: EdgeCollection<E, D, S>

onlyRight: EdgeCollection<E2, D2, S2>

complement

Returns EdgeCollection<BaseEdge.Class<BaseEdge.Data, BaseEdge.ScratchData>, BaseEdge.Data, BaseEdge.ScratchData>

contains

Type Parameters

Parameters

Returns boolean

containsAny

Type Parameters

Parameters

Returns boolean

difference

Type Parameters

Parameters

Returns EdgeCollection<E, D, S>

every

Parameters

Parameters

Returns boolean

Returns boolean

Type Parameters

Parameters

Parameters

Returns boolean

Returns boolean

expectAll

Type Parameters

Parameters

Returns EdgeCollection<E2, D2, S2>

Throws

filter

Parameters

Parameters

Returns boolean

Returns EdgeCollection<E, D, S>

Type Parameters

Parameters

Parameters

Returns boolean

Returns EdgeCollection<E, D, S>

filterIs

Type Parameters

Returns {
both: EdgeCollection<E, D, S>;
onlyLeft: EdgeCollection<E, D, S>;
onlyRight: EdgeCollection<E2, D2, S2>;
}

Returns undefined | {
element: E;
value: number;
}

Returns undefined | {
element: E;
value: number;
}

Returns undefined | {
element: E;
value: number;
}

Returns undefined | {
element: E;
value: number;
}