scg.ac.ni.pmf.newgraph.invariants
Interface Invariant

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

InvariantBoolean, InvariantDouble, InvariantDoubleArray, InvariantDoubleEdge, InvariantDoubleMatrix, InvariantDoubleVertex, InvariantEdge, InvariantEdgeArray, InvariantInt, InvariantIntArray, InvariantIntEdge, InvariantIntMatrix, InvariantIntVertex, InvariantString, InvariantVertex, InvariantVertexArray

public interface Invariant
extends java.io.Serializable

A graph invariant is a function calculated on a graph. Its value could be integer, double, boolean and other types.

For instance, the number of vertices in a graph is an invariant. An invariant which returns true if the graph is connected is also an invariant.

The invariants are classified according to the type of their return value. For instance, the invariants which return integer must implement the interface InvariantInt. There is an interface for each of the return types, and this is a base interface for all of those.

Author:

Vladimir Brankov

See Also:

"Plug-in Developer Guide"

Method Summary

java.lang.String	getDescription() Retrieves the description of the invariant.
java.lang.String	getName() Retrieves the name of the invariant.

Method Detail

getName

java.lang.String getName()

Retrieves the name of the invariant.

Returns:

The name.

getDescription

java.lang.String getDescription()

Retrieves the description of the invariant. The description is recommended to be brief.

Returns:

The description.