Module fr.univartois.cril.jkahypar

Package fr.univartois.cril.jkahypar.hypergraph

Class AbstractHypergraphBuilder

java.lang.Object

fr.univartois.cril.jkahypar.hypergraph.AbstractHypergraphBuilder

All Implemented Interfaces:

HypergraphBuilder

public abstract class AbstractHypergraphBuilder
extends Object
implements HypergraphBuilder

The AbstractHypergraphBuilder provides a base implementation for HypergraphBuilder.

Since:

0.2.0

Field Summary

Fields

Modifier and Type	Field	Description
protected long[]	hyperedgeIndices	The indices at which the vertices of each hyperedge start in hyperedgeVertices.
protected int[]	hyperedgeVertices	The vertices of the different hyperedges.
protected int[]	hyperedgeWeights	The weights of the hyperedges.
protected int	numberOfHyperedges	The number of hyperedges in the hypergraph.
protected int	numberOfVertices	The number of vertices in the hypergraph.
protected int[]	vertexWeights	The weights of the vertices.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractHypergraphBuilder(int nbVertices, int nbHyperedges)	Creates a new AbstractHypergraphBuilder.

Method Summary

Modifier and Type	Method	Description
protected void	appendVertex(int vertex)	Appends a vertex to hyperedgeVertices.
protected void	appendVertices(Hyperedge hyperedge)	Appends the vertices of the given hyperedge to hyperedgeVertices.
Hypergraph	build()	Creates the hypergraph built by this builder.
long[]	getHyperedgeIndices()	Gives the indices at which the vertices of each hyperedge start in the array returned by HypergraphBuilder.getHyperedgeVertices().
int[]	getHyperedgeVertices()	Gives the vertices of the hyperedges in the hypergraph.
int	getNumberOfHyperedges()	Gives the number of hyperedges in the hypergraph.
int	getNumberOfVertices()	Gives the number of vertices in the hypergraph.
protected abstract void	resizeArrays()	Resizes the internal arrays to make sure their lengths correspond exactly to their number of elements.
protected abstract void	setHyperedgeIndex(int index, int vertexIndex)	Sets the index at which the vertices of a hyperedge start in hyperedgeIndices.
HypergraphBuilder	withHyperedge(UnweightedHyperedge hyperedge)	Adds an UnweightedHyperedge to the hypergraph.
HypergraphBuilder	withHyperedge(WeightedHyperedge hyperedge)	Adds a WeightedHyperedge to the hypergraph.
protected abstract HypergraphBuilder	withHyperedgeWeight(int hyperedge, int weight)	Sets the weight of a hyperedge in the hypergraph.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface fr.univartois.cril.jkahypar.hypergraph.HypergraphBuilder

withVertexWeight

Field Details

numberOfVertices

protected int numberOfVertices

The number of vertices in the hypergraph.

vertexWeights

protected int[] vertexWeights

The weights of the vertices. If vertices are not weighted, this array remains null.

numberOfHyperedges

protected int numberOfHyperedges

The number of hyperedges in the hypergraph.

hyperedgeWeights

protected int[] hyperedgeWeights

The weights of the hyperedges. If hyperedges are not weighted, this array remains null.

hyperedgeIndices

protected long[] hyperedgeIndices

The indices at which the vertices of each hyperedge start in hyperedgeVertices.

hyperedgeVertices

protected int[] hyperedgeVertices

The vertices of the different hyperedges.

Constructor Details

AbstractHypergraphBuilder

protected AbstractHypergraphBuilder(int nbVertices,
 int nbHyperedges)

Creates a new AbstractHypergraphBuilder.

Parameters:

nbVertices - The number of vertices in the hypergraph.

nbHyperedges - The number of hyperedges in the hypergraph.

Method Details

getNumberOfVertices

public int getNumberOfVertices()

Description copied from interface: HypergraphBuilder

Gives the number of vertices in the hypergraph.

Specified by:

getNumberOfVertices in interface HypergraphBuilder

Returns:

The number of vertices.

getNumberOfHyperedges

public int getNumberOfHyperedges()

Description copied from interface: HypergraphBuilder

Gives the number of hyperedges in the hypergraph.

Specified by:

getNumberOfHyperedges in interface HypergraphBuilder

Returns:

The number of hyperedges.

getHyperedgeIndices

public long[] getHyperedgeIndices()

Description copied from interface: HypergraphBuilder

Gives the indices at which the vertices of each hyperedge start in the array returned by HypergraphBuilder.getHyperedgeVertices().

Specified by:

getHyperedgeIndices in interface HypergraphBuilder

Returns:

The indices of the vertices for each hyperedge.

See Also:

• HypergraphBuilder.getHyperedgeVertices()

getHyperedgeVertices

public int[] getHyperedgeVertices()

Description copied from interface: HypergraphBuilder

Gives the vertices of the hyperedges in the hypergraph.

Specified by:

getHyperedgeVertices in interface HypergraphBuilder

Returns:

The vertices of the different hyperedges.

See Also:

• HypergraphBuilder.getHyperedgeIndices()

withHyperedge

public HypergraphBuilder withHyperedge(UnweightedHyperedge hyperedge)

Description copied from interface: HypergraphBuilder

Adds an UnweightedHyperedge to the hypergraph.

Specified by:

withHyperedge in interface HypergraphBuilder

Parameters:

hyperedge - The hyperedge to add.

Returns:

This builder.

withHyperedge

public HypergraphBuilder withHyperedge(WeightedHyperedge hyperedge)

Description copied from interface: HypergraphBuilder

Adds a WeightedHyperedge to the hypergraph.

Specified by:

withHyperedge in interface HypergraphBuilder

Parameters:

hyperedge - The hyperedge to add.

Returns:

This builder.

setHyperedgeIndex

protected abstract void setHyperedgeIndex(int index,
 int vertexIndex)

Sets the index at which the vertices of a hyperedge start in hyperedgeIndices.

Parameters:

index - The index of the hyperedge.

vertexIndex - The index at which the vertices of the hyperedge start.

withHyperedgeWeight

protected abstract HypergraphBuilder withHyperedgeWeight(int hyperedge,
 int weight)

Sets the weight of a hyperedge in the hypergraph.

Parameters:

hyperedge - The hyperedge to set the weight of.

weight - The weight of the hyperedge.

Returns:

This builder.

appendVertices

protected void appendVertices(Hyperedge hyperedge)

Appends the vertices of the given hyperedge to hyperedgeVertices.

Parameters:

hyperedge - The hyperedge to append the vertices of.

appendVertex

protected void appendVertex(int vertex)

Appends a vertex to hyperedgeVertices. The size of the array is doubled if there is not enough room to add the vertex.

Parameters:

vertex - The vertex to append.

build

public Hypergraph build()

Description copied from interface: HypergraphBuilder

Creates the hypergraph built by this builder.

Specified by:

build in interface HypergraphBuilder

Returns:

The built hypergraph.

resizeArrays

protected abstract void resizeArrays()

Resizes the internal arrays to make sure their lengths correspond exactly to their number of elements.