Module fr.univartois.cril.jkahypar

Package fr.univartois.cril.jkahypar.hypergraph

Enum Class HmetisFormat

java.lang.Object

java.lang.Enum<HmetisFormat>

fr.univartois.cril.jkahypar.hypergraph.HmetisFormat

All Implemented Interfaces:

Serializable, Comparable<HmetisFormat>, Constable

public enum HmetisFormat
extends Enum<HmetisFormat>

The HmetisFormat enumerates the possible hypergraph formats recognized by hMetis.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
UNWEIGHTED	The format representing a hypergraph without weights.
WEIGHT_ON_HYPEREDGES	The format representing a hypergraph with weights on its hyperedges.
WEIGHT_ON_VERTICES	The format representing a hypergraph with weights on its vertices.

Method Summary

Modifier and Type	Method	Description
int	getIdentifier()	Gives the hMetis identifier of this format.
boolean	isEncodedIn(int formatIdentifier)	Checks whether the given integer encodes that the associated hypergraph has this format.
static HmetisFormat	valueOf(String name)	Returns the enum constant of this class with the specified name.
static HmetisFormat[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

UNWEIGHTED

public static final HmetisFormat UNWEIGHTED

The format representing a hypergraph without weights.

WEIGHT_ON_HYPEREDGES

public static final HmetisFormat WEIGHT_ON_HYPEREDGES

The format representing a hypergraph with weights on its hyperedges.

WEIGHT_ON_VERTICES

public static final HmetisFormat WEIGHT_ON_VERTICES

The format representing a hypergraph with weights on its vertices.

Method Details

values

public static HmetisFormat[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static HmetisFormat valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getIdentifier

public int getIdentifier()

Gives the hMetis identifier of this format.

Returns:

The identifier of this format.

isEncodedIn

public boolean isEncodedIn(int formatIdentifier)

Checks whether the given integer encodes that the associated hypergraph has this format.

Parameters:

formatIdentifier - The integer encoding the format of a hypergraph.

Returns:

Whether this format is encoded in the given integer.