loggersoft.kotlin.utils.graph.Vertex.kt Maven / Gradle / Ivy

Go to download
/*
 * Copyright (C) 2018 Alexander Kornilov ([email protected])
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package loggersoft.kotlin.utils.graph

/**
 * Represents interface of a graph's vertex.
 *
 * @author Alexander Kornilov ([email protected]).
 */
interface Vertex {

    /**
     * A vertex parametrized value.
     */
    val value: V

    /**
     * A list of edges which starts from this vertex.
     */
    val startsIn: Collection>

    /**
     * A list of edges which ends with this vertex.
     */
    val endsIn: Collection>

    /**
     * Returns `true` if the vertex contains [edge]; `false` otherwise.
     */
    operator fun contains(edge: Edge<*, *>) = edge in startsIn || edge in endsIn

    /**
     * Returns `true` if the vertex connected with [value]; `false` otherwise.
     */
    fun isConnectedWith(value: V): Boolean
}