@rimbu/graph/src/main/valued/interface/arrow/arrow-valued-graph-hashed.mts

Immutable Graph data structures for TypeScript

import type { Stream, Streamable } from '@rimbu/stream';

import { HashMap } from '@rimbu/hashed';

import type {
  ArrowValuedGraphHashedCreators,
  ValuedGraphElement,
} from '@rimbu/graph/custom';
import {
  type ArrowValuedGraphBase,
  ValuedGraphContext,
} from '@rimbu/graph/custom';

/**
 * A type-invariant immutable valued arrow (directed) graph.
 * The nodes are internally maintained using HashMaps
 * See the [Graph documentation](https://rimbu.org/docs/collections/graph) and the [ArrowValuedGraphHashed API documentation](https://rimbu.org/api/rimbu/graph/ArrowValuedGraphHashed/interface)
 * @typeparam N - the node type
 * @typeparam V - the connection value type
 * @example
 * ```ts
 * const g1 = ArrowValuedGraphHashed.empty<number, string>()
 * const g2 = ArrowValuedGraphHashed.of([1], [2, 3, 'a'], [2, 4, 'b'])
 * ```
 */
export interface ArrowValuedGraphHashed<N, V>
  extends ArrowValuedGraphBase<N, V, ArrowValuedGraphHashed.Types> {}

export namespace ArrowValuedGraphHashed {
  /**
   * A non-empty type-invariant immutable valued arrow (directed) graph.
   * The nodes are internally maintained using HashMaps
   * See the [Graph documentation](https://rimbu.org/docs/collections/graph) and the [ArrowValuedGraphHashed API documentation](https://rimbu.org/api/rimbu/graph/ArrowValuedGraphHashed/interface)
   * @typeparam N - the node type
   * @typeparam V - the connection value type
   */
  export interface NonEmpty<N, V>
    extends ArrowValuedGraphBase.NonEmpty<N, V, ArrowValuedGraphHashed.Types>,
      Omit<
        ArrowValuedGraphHashed<N, V>,
        keyof ArrowValuedGraphBase.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
     * ArrowValuedGraphHashed.of([1, 2, 'a'], [2, 3, 'b']).stream().toArray()
     * // => [[1, 2, 'a'], [2, 3, 'b']]
     * ```
     */
    stream(): Stream.NonEmpty<ValuedGraphElement<N, V>>;
  }

  /**
   * A mutable `ArrowValuedGraphHashed` builder used to efficiently create new immutable instances.
   * See the [Graph documentation](https://rimbu.org/docs/collections/graph) and the [ArrowValuedGraphHashed.Builder API documentation](https://rimbu.org/api/rimbu/graph/ArrowValuedGraphHashed/Builder/interface)
   * @typeparam N - the node type
   * @typeparam V - the connection value type
   */
  export interface Builder<N, V>
    extends ArrowValuedGraphBase.Builder<N, V, ArrowValuedGraphHashed.Types> {}

  /**
   * The ArrowValuedGraphHashed'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
   */
  export interface Context<UN>
    extends ArrowValuedGraphBase.Context<UN, ArrowValuedGraphHashed.Types> {
    readonly typeTag: 'ArrowValuedGraphHashed';
  }

  /**
   * Utility interface that provides higher-kinded types for this collection.
   */
  export interface Types extends ArrowValuedGraphBase.Types {
    readonly normal: ArrowValuedGraphHashed<this['_N'], this['_V']>;
    readonly nonEmpty: ArrowValuedGraphHashed.NonEmpty<this['_N'], this['_V']>;
    readonly context: ArrowValuedGraphHashed.Context<this['_N']>;
    readonly builder: ArrowValuedGraphHashed.Builder<this['_N'], this['_V']>;
    readonly linkMap: HashMap<this['_N'], HashMap<this['_N'], this['_V']>>;
    readonly linkMapNonEmpty: HashMap.NonEmpty<
      this['_N'],
      HashMap<this['_N'], this['_V']>
    >;
    readonly linkMapContext: HashMap.Context<this['_N']>;
    readonly linkConnectionsContext: HashMap.Context<this['_N']>;
    readonly linkMapBuilder: HashMap.Builder<
      this['_N'],
      HashMap.Builder<this['_N'], this['_V']>
    >;
    readonly linkConnectionsBuilder: HashMap.Builder<this['_N'], this['_V']>;
    readonly linkConnections: HashMap<this['_N'], this['_V']>;
  }
}

function createContext<UN>(options?: {
  linkMapContext?: HashMap.Context<UN>;
  linkConnectionsContext?: HashMap.Context<UN>;
}): ArrowValuedGraphHashed.Context<UN> {
  return Object.freeze(
    new ValuedGraphContext<UN, 'ArrowValuedGraphHashed', any>(
      true,
      'ArrowValuedGraphHashed',
      options?.linkMapContext ?? HashMap.defaultContext(),
      options?.linkConnectionsContext ?? HashMap.defaultContext()
    )
  );
}

const _defaultContext: ArrowValuedGraphHashed.Context<any> = createContext();

export const ArrowValuedGraphHashed: ArrowValuedGraphHashedCreators =
  Object.freeze({
    ..._defaultContext,
    createContext,
    defaultContext<UN>(): ArrowValuedGraphHashed.Context<UN> {
      return _defaultContext;
    },
  });