Package org.graph4j.util

Class Cycle

java.lang.Object

org.graph4j.util.VertexCollection

org.graph4j.util.VertexList

org.graph4j.util.Walk

org.graph4j.util.Trail

org.graph4j.util.Path

org.graph4j.util.Cycle

All Implemented Interfaces:

Iterable<Integer>

public class Cycle
extends Path

A cycle is a closed path, meaning that the last vertex of the path is connected to the first one. Vertices can not repeat. Edges can not repeat. The length of a cycle is the number of edges in the path plus the one between the endpoints.

Author:

Cristian Frăsinaru

See Also:

• Walk
• Trail
• Circuit
• Path

Field Summary

Fields inherited from class org.graph4j.util.Walk

numEdges

Fields inherited from class org.graph4j.util.VertexCollection

bitset, DEFAULT_CAPACITY, first, graph, numVertices, vertices

Constructor Summary

Constructors

Constructor	Description
Cycle(Graph graph)
Cycle(Graph graph, int initialCapacity)
Cycle(Graph graph, int[] vertices)

Method Summary

Modifier and Type	Method	Description
double	computeEdgesWeight()
boolean	equals(Object obj)
int	hashCode()
boolean	isClosed()
boolean	isInduced()	Checks if the path is induced (there is no chord).
final boolean	isValid()
int	length()	The length of the walk, trail, path or cycle (number of edges).
String	toString()

Methods inherited from class org.graph4j.util.Path

firstVertex, isHamiltonian, lastVertex

Methods inherited from class org.graph4j.util.Trail

checkDuplicateEdges

Methods inherited from class org.graph4j.util.Walk

add, checkEdge, checkEdges, isDirected, reverse, type

Methods inherited from class org.graph4j.util.VertexList

addAll, get, indexOf, indexOf, insert, remove, removeFromPos, set, union, union

Methods inherited from class org.graph4j.util.VertexCollection

clear, computeVerticesWeight, contains, getGraph, grow, isClique, isEmpty, isStableSet, iterator, numVertices, removeAll, removeLast, retainAll, size, union, vertexToString, vertices

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

Cycle

public Cycle(Graph graph)

Cycle

public Cycle(Graph graph,
 int initialCapacity)

Cycle

public Cycle(Graph graph,
 int[] vertices)

Method Details

isValid

public final boolean isValid()

Overrides:

isValid in class Path

Returns:

false if the vertices do not represent the intendended structure.

isInduced

public boolean isInduced()

Description copied from class: Path

Checks if the path is induced (there is no chord).

Overrides:

isInduced in class Path

Returns:

true if the cycle is induced (there is no chord).

isClosed

public boolean isClosed()

Overrides:

isClosed in class Walk

Returns:

true, if the first vertex equals the last one.

length

public int length()

Description copied from class: Walk

The length of the walk, trail, path or cycle (number of edges).

Overrides:

length in class Walk

Returns:

the number of edges.

computeEdgesWeight

public double computeEdgesWeight()

Overrides:

computeEdgesWeight in class Walk

Returns:

the sum of the edge weights.

hashCode

public int hashCode()

Overrides:

hashCode in class Walk

equals

public boolean equals(Object obj)

Overrides:

equals in class Walk

toString

public String toString()

Overrides:

toString in class Walk