namespace ArrowGraphSorted
An type-invariant immutable valued arrow (directed) graph. The connections are internally maintained using sorted collections See the Graph documentation and the ArrowGraphSorted API documentation
Companion interface: ArrowGraphSorted<N>
Interfaces
| Name | Description |
|---|---|
ArrowGraphSorted.Builder<N> | A mutable ArrowGraphSorted builder used to efficiently create new immutable instances. See the Graph documentation and the ArrowGraphSorted.Builder API documentation |
ArrowGraphSorted.Context<UN> | The ArrowGraphSorted's Context instance that serves as a factory for all related immutable instances and builders. |
ArrowGraphSorted.NonEmpty<N> | A non-empty type-invariant immutable valued arrow (directed) graph. The connections are internally maintained using sorted collections See the Graph documentation and the ArrowGraphSorted API documentation |
ArrowGraphSorted.Types | Utility interface that provides higher-kinded types for this collection. |
Static Methods
builder
Returns an empty builder instance.
builderDefinition
builder<N extends UN>(): WithGraphValues<Tp, N, unknown>['builder'];
Type parameters
| Name | Constraints | Description |
|---|---|---|
| N | UN |
ArrowValuedGraphHashed.builder<number, string>() // => ArrowValuedGraphHashed.Builder<number, string>
Overrides
createContext
Returns a new ArrowValuedGraphSorted context instance based on the given options.
createContextoptions.Definition
createContext<UN>(options?: {
linkMapContext?: SortedMap.Context<UN>;
linkConnectionsContext?: SortedSet.Context<UN>;
}): ArrowGraphSorted.Context<UN>;
Type parameters
| Name | Description |
|---|---|
| UN | the upper node type for which the context can create instances |
Parameters
| Name | Type | Description |
|---|---|---|
options | {linkMapContext?: SortedMap.Context<UN>;linkConnectionsContext?: SortedSet.Context<UN>;} | (optional) an object containing the following properties: - linkMapContext: (optional) the map context to use to maintain link maps - linkConnectionsContext: (optional) the set context to use to maintain link connections |
defaultContext
Returns the default context for this type of graph.
defaultContextDefinition
defaultContext<UN>(): ArrowGraphSorted.Context<UN>;
Type parameters
| Name | Description |
|---|---|
| UN | the upper node type that the context should accept |
empty
Returns the (singleton) empty instance of this type and context with given key and value types.
emptyDefinition
empty<N extends UN>(): WithGraphValues<Tp, N, unknown>['normal'];
Type parameters
| Name | Constraints | Description |
|---|---|---|
| N | UN |
ArrowGraphHashed.empty<number>() // => ArrowGraphHashed<number>
ArrowGraphHashed.empty<string>() // => ArrowGraphHashed<string>
Overrides
from
Returns an immutable valued Graph, containing the graph elements from each of the given sources.
fromsources.Definitions
from<N extends UN>(...sources: ArrayNonEmpty<StreamSource.NonEmpty<GraphElement<N>>>): WithGraphValues<Tp, N, unknown>['nonEmpty'];
from<N extends UN>(...sources: ArrayNonEmpty<StreamSource<GraphElement<N>>>): WithGraphValues<Tp, N, unknown>['normal'];
Type parameters
| Name | Constraints | Description |
|---|---|---|
| N | UN |
Parameters
| Name | Type | Description |
|---|---|---|
sources | ArrayNonEmpty<StreamSource.NonEmpty<GraphElement<N>>> | an array of StreamSource instances containing graph elements to add |
ArrowGraphHashed.from([[1], [2]], [[3, 4]]) // => ArrowGraphHashed.NonEmpty<number>
Overrides
of
Returns an immutable valued Graph instance containing the graph elements from the given graphElements.
ofgraphElements.Definition
of<N extends UN>(...graphElements: ArrayNonEmpty<GraphElement<N>>): WithGraphValues<Tp, N, unknown>['nonEmpty'];
Type parameters
| Name | Constraints | Description |
|---|---|---|
| N | UN |
Parameters
| Name | Type | Description |
|---|---|---|
graphElements | ArrayNonEmpty<GraphElement<N>> | a non-empty array of graph elements that are either a single tuple containing a node, or a triplet containing two connection nodes and the connection value. |
ArrowGraphHashed.of([1], [2], [3, 4]) // => ArrowGraphHashed.NonEmpty<number>
Overrides
reducer
Returns a Reducer that adds received graph elements to a Graph and returns the Graph as a result. When a source is given, the reducer will first create a graph from the source, and then add graph elements to it.
reducerReducer that adds received graph elements to a Graph and returns the Graph as a result. When a source is given, the reducer will first create a graph from the source, and then add graph elements to it.Definition
reducer<N extends UN>(source?: StreamSource.NonEmpty<GraphElement<N>>): Reducer<GraphElement<N>, WithGraphValues<Tp, N, unknown>['normal']>;
Type parameters
| Name | Constraints | Description |
|---|---|---|
| N | UN |
Parameters
| Name | Type | Description |
|---|---|---|
source | StreamSource.NonEmpty<GraphElement<N>> | (optional) an initial source of graph elements to add to |
const someSource: GraphElement<number>[] = [[1, 2], [3], [5]];
const result = Stream.of([1, 3], [4, 3]).reduce(ArrowGraphSorted.reducer(someSource))
result.toArray() // => [[1, 2], [1, 3], [4, 3], [5]]
uses a builder under the hood. If the given source is a Graph in the same context, it will directly call .toBuilder().