@crstrskp/graph/dist/IGraph.d.ts

High-performance TypeScript graph algorithms library optimized for trading bots and arbitrage detection

import { Edge } from "./Edge";
import { Attributes } from "./types/Attributes";
import { Vertex } from "./Vertex";
export interface IGraph {
    edges: Edge[];
    vertices: Vertex[];
    attributes: Attributes;
    /**
     * return an array of all the vertices of the graph.
     * @Input: None; @Output: array of vertices
     */
    getAllVertices(): Array<Vertex>;
    /**
     * Return an array of all the edges of the graph.
     * @Input: None; @Output: array of edges
     */
    getAllEdges(): Array<Edge>;
    /**
     * Return an array of the edges incident upon vertex v.
     * @param v incident edges upon this given vertex
     * @Output: array of edges incident upon vertex v.
     */
    getIncidentEdges(v: Vertex): Array<Edge>;
    getIncidentStartEdges(v: Vertex): Array<Edge>;
    getIncidentEndEdges(v: Vertex): Array<Edge>;
    /**
     * Returns the endvertex of edge {e} distinct from vertex {v}. Returns undefined if {e} is not incident on {v}.
     * @param v the vertex of which the opposite is sought.
     * @param e the edge of which the endVertex is sought.
     */
    getOpposite(v: Vertex, e: Edge): Vertex | undefined;
    /**
     * Return an array storing the end vertices of edge {e}.
     * @param e Edge that connects the vertices returned.
     */
    getVertices(e: Edge): Array<Vertex>;
    /**
     * Returns an Array<Vertex> containing all adjacent vertices to v.
     * @param v src
     */
    getAdjacentVertices(v: Vertex): Array<Vertex>;
    /**
     * Test whether vertices {v} and {w} are adjacent.
     * @param v Vertex 1
     * @param w Vertex 2
     */
    areAdjacent(v: Vertex, w: Vertex): boolean;
    /**
     * Insert and return a new Vertex storing element o
     * @param o Object
     */
    insertVertex(o: any): Vertex;
    /**
     * Insert and return a new undirected edge with end vertices v and w storing element o
     * NOTE: As of writing, this will create a directedEdge as this is the only thing this framework currently supports.
     * @param v Vertex 1
     * @param w Vertex 2
     * @param o the object that will be used as the element for the edge.
     */
    insertEdge(v: Vertex, w: Vertex, o: any): Edge;
    /**
     * Insert and return a new directed edge from vertex {start} to vertex {end} storin element o
     * @param start Start vertex
     * @param end End Vertex
     * @param o the object that will be used as the element for the edge.
     */
    /**
     * Remove vertex v and all its incident edges.
     * @param v The vertex that are to be removed.
     */
    removeVertex(v: Vertex): any;
    /**
     * Remove edge {e}.
     * @param e The edge that are to be removed.
     */
    removeEdge(e: Edge): any;
    /**
     * Sorts the edges in ascending order.
     * @param edges list of edges to be sorted
     * @returns a new list of sorted edges
     */
    sortEdgesASC(edges: Edge[]): Edge[];
    /**
     * Sorts the edges in descending order.
     * @param edges list of edges to be sorted
     * @returns a new list of sorted edges
     */
    sortEdgesDESC(edges: Edge[]): Edge[];
    /**
     * Return the vertex with the given label.
     * @param label The label of the vertex.
     */
    getVertexByLabel(label: string): Vertex | undefined;
    /**
     * Return the vertex with the given id.
     * @param id The id of the vertex.
     */
    getVertexById(id: number): Vertex | undefined;
    /**
     * Return the edge with the given id.
     * @param id The id of the edge.
     */
    getEdgeById(id: number): Edge | undefined;
}
//# sourceMappingURL=IGraph.d.ts.map