alchemist-euclidean-geometry/it.unibo.alchemist.model.geometry.navigationgraph/BaseNavigationGraph

BaseNavigationGraph

open class BaseNavigationGraph<V : Vector<V>, A : Transformation<V>, N : ConvexShape<V, A>, E>(vertexSupplier: Supplier<N>?, edgeSupplier: Supplier<E>?, graphType: GraphType) : AbstractBaseGraph<N, E> , NavigationGraph<V, A, N, E> (source)

An implementation of NavigationGraph, deriving from AbstractBaseGraph. The user can specify the GraphType so as to obtain a custom graph (e.g. weighted or not, directed or undirected, etc). AbstractBaseGraph guarantees deterministic ordering for the collection it maintains, as stated in its api documentation. Note that vertices and edges are used as keys inside AbstractBaseGraph, so when choosing their types, you must follow these rules:

You must follow the contract defined in java.lang.Object for both equals and hashCode.
In particular, if you override either equals or hashCode, you must override them both.
Your implementation for hashCode must produce a value which does not change over the lifetime of the object. Further information available here.

Inheritors

DirectedNavigationGraph

UndirectedNavigationGraph

Constructors

BaseNavigationGraph

constructor(vertexSupplier: Supplier<N>?, edgeSupplier: Supplier<E>?, graphType: GraphType)

constructor(edgeClass: Class<out E>, directed: Boolean)

Properties

open override var edgeSupplier: Supplier<E?>?

open override val type: GraphType?

open override var vertexSupplier: Supplier<N?>?

Functions

open fun addEdge(sourceVertex: N?, targetVertex: N?): E?

open fun addEdge(sourceVertex: N?, targetVertex: N?, e: E?): Boolean

open fun addVertex(): N?

open fun addVertex(v: N?): Boolean

open fun clone(): Any

open fun containsEdge(e: E?): Boolean

open fun containsEdge(sourceVertex: N?, targetVertex: N?): Boolean

open fun containsVertex(v: N?): Boolean

open fun degreeOf(vertex: N?): Int

open fun edgeSet(): Set<E?>?

open fun edgesOf(vertex: N?): Set<E?>?

open fun getAllEdges(sourceVertex: N?, targetVertex: N?): Set<E?>?

open fun getEdge(sourceVertex: N?, targetVertex: N?): E?

open fun getEdgeSource(e: E?): N?

getEdgeSupplier

open fun getEdgeSupplier(): Supplier<E?>?

open fun getEdgeTarget(e: E?): N?

open fun getEdgeWeight(e: E?): Double

open fun getType(): GraphType?

getVertexSupplier

open fun getVertexSupplier(): Supplier<N?>?

incomingEdgesOf

open fun incomingEdgesOf(vertex: N?): Set<E?>?

open fun inDegreeOf(vertex: N?): Int

open fun iterables(): GraphIterables<N?, E?>?

open fun nodeContaining(position: V): N?

open fun outDegreeOf(vertex: N?): Int

outgoingEdgesOf

open fun outgoingEdgesOf(vertex: N?): Set<E?>?

open fun removeAllEdges(edges: Collection<out E?>?): Boolean

open fun removeAllEdges(sourceVertex: N?, targetVertex: N?): Set<E?>?

removeAllVertices

open fun removeAllVertices(vertices: Collection<out N?>?): Boolean

open fun removeEdge(e: E?): Boolean

open fun removeEdge(sourceVertex: N?, targetVertex: N?): E?

open fun removeVertex(v: N?): Boolean

setEdgeSupplier

open fun setEdgeSupplier(edgeSupplier: Supplier<E?>?)

open fun setEdgeWeight(e: E?, weight: Double)

open fun setEdgeWeight(sourceVertex: N?, targetVertex: N?, weight: Double)

setVertexSupplier

open fun setVertexSupplier(vertexSupplier: Supplier<N?>?)

open fun vertexSet(): Set<N?>?