@rimbu/graph
Version:
Immutable Graph data structures for TypeScript
56 lines (55 loc) • 3.1 kB
text/typescript
import type { Stream, Streamable } from '@rimbu/stream';
import type { EdgeValuedGraphCreators, ValuedGraphElement } from '@rimbu/graph/custom';
import { type EdgeValuedGraphBase } from '@rimbu/graph/custom';
/**
* A type-invariant immutable valued edge (undirected) graph.
* See the [Graph documentation](https://rimbu.org/docs/collections/graph) and the [EdgeValuedGraph API documentation](https://rimbu.org/api/rimbu/graph/EdgeValuedGraph/interface)
* @typeparam N - the node type
* @typeparam V - the connection value type
*/
export interface EdgeValuedGraph<N, V> extends EdgeValuedGraphBase<N, V, EdgeValuedGraph.Types> {
}
export declare namespace EdgeValuedGraph {
/**
* A non-empty type-invariant immutable valued edge (undirected) graph.
* See the [Graph documentation](https://rimbu.org/docs/collections/graph) and the [EdgeValuedGraph API documentation](https://rimbu.org/api/rimbu/graph/EdgeValuedGraph/interface)
* @typeparam N - the node type
* @typeparam V - the connection value type
*/
interface NonEmpty<N, V> extends EdgeValuedGraphBase.NonEmpty<N, V, EdgeValuedGraph.Types>, Omit<EdgeValuedGraph<N, V>, keyof EdgeValuedGraphBase.NonEmpty<any, any, any>>, Streamable.NonEmpty<ValuedGraphElement<N, V>> {
/**
* Returns a non-empty `Stream` containing all graph elements of this collection as single tuples for isolated nodes
* and 3-valued tuples containing the source node, target node, and connection value for connections.
* @example
* ```ts
* EdgeValuedGraphHashed.of([1, 2, 'a'], [2, 3, 'b']).stream().toArray()
* // => [[1, 2, 'a'], [2, 3, 'b']]
* ```
*/
stream(): Stream.NonEmpty<ValuedGraphElement<N, V>>;
}
/**
* A mutable `EdgeValuedGraph` builder used to efficiently create new immutable instances.
* See the [Graph documentation](https://rimbu.org/docs/collections/graph) and the [EdgeValuedGraph.Builder API documentation](https://rimbu.org/api/rimbu/graph/EdgeValuedGraph/Builder/interface)
* @typeparam N - the node type
* @typeparam V - the connection value type
*/
interface Builder<N, V> extends EdgeValuedGraphBase.Builder<N, V, EdgeValuedGraph.Types> {
}
/**
* The EdgeValuedGraph's Context instance that serves as a factory for all related immutable instances and builders.
* @typeparam UN - the upper type limit for node types for which this context can create instances
*/
interface Context<UN> extends EdgeValuedGraphBase.Context<UN, EdgeValuedGraph.Types> {
}
/**
* Utility interface that provides higher-kinded types for this collection.
*/
interface Types extends EdgeValuedGraphBase.Types {
readonly normal: EdgeValuedGraph<this['_N'], this['_V']>;
readonly nonEmpty: EdgeValuedGraph.NonEmpty<this['_N'], this['_V']>;
readonly context: EdgeValuedGraph.Context<this['_N']>;
readonly builder: EdgeValuedGraph.Builder<this['_N'], this['_V']>;
}
}
export declare const EdgeValuedGraph: EdgeValuedGraphCreators;