Class MinimalPerfectHashFunction.Builder<T>

java.lang.Object

it.unimi.dsi.sux4j.mph.MinimalPerfectHashFunction.Builder<T>

Enclosing class:

MinimalPerfectHashFunction<T>

public static class MinimalPerfectHashFunction.Builder<T>
extends Object

A builder class for MinimalPerfectHashFunction.

Since:

0.1

Author:

Sebastiano Vigna

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	built	Whether build() has already been called.
protected ChunkedHashStore<T>	chunkedHashStore
protected Iterable<? extends T>	keys
protected int	signatureWidth
protected File	tempDir
protected it.unimi.dsi.bits.TransformationStrategy<? super T>	transform

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
MinimalPerfectHashFunction<T>	build()	Builds a minimal perfect hash function.
MinimalPerfectHashFunction.Builder<T>	keys(Iterable<? extends T> keys)	Specifies the keys to hash; if you have specified a it.unimi.dsi.sux4j.io.ChunkedHashStore, it can be null.
MinimalPerfectHashFunction.Builder<T>	signed(int signatureWidth)	Specifies that the resulting MinimalPerfectHashFunction should be signed using a given number of bits per key.
MinimalPerfectHashFunction.Builder<T>	store(ChunkedHashStore<T> chunkedHashStore)	Specifies a chunked hash store containing the keys.
MinimalPerfectHashFunction.Builder<T>	tempDir(File tempDir)	Specifies a temporary directory for the it.unimi.dsi.sux4j.io.ChunkedHashStore.
MinimalPerfectHashFunction.Builder<T>	transform(it.unimi.dsi.bits.TransformationStrategy<? super T> transform)	Specifies the transformation strategy for the keys to hash.

Methods inherited from class Object

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

Field Details

keys

protected Iterable<? extends T> keys

transform

protected it.unimi.dsi.bits.TransformationStrategy<? super T> transform

signatureWidth

protected int signatureWidth

tempDir

protected File tempDir

chunkedHashStore

protected ChunkedHashStore<T> chunkedHashStore

built

protected boolean built

Whether build() has already been called.

Constructor Details

Builder

public Builder()

Method Details

keys

public MinimalPerfectHashFunction.Builder<T> keys(Iterable<? extends T> keys)

Specifies the keys to hash; if you have specified a it.unimi.dsi.sux4j.io.ChunkedHashStore, it can be null.

Parameters:

keys - the keys to hash.

Returns:

this builder.

transform

public MinimalPerfectHashFunction.Builder<T> transform(it.unimi.dsi.bits.TransformationStrategy<? super T> transform)

Specifies the transformation strategy for the keys to hash.

Parameters:

transform - a transformation strategy for the keys to hash.

Returns:

this builder.

signed

public MinimalPerfectHashFunction.Builder<T> signed(int signatureWidth)

Specifies that the resulting MinimalPerfectHashFunction should be signed using a given number of bits per key.

Parameters:

signatureWidth - a signature width, or 0 for no signature.

Returns:

this builder.

tempDir

public MinimalPerfectHashFunction.Builder<T> tempDir(File tempDir)

Specifies a temporary directory for the it.unimi.dsi.sux4j.io.ChunkedHashStore.

Parameters:

tempDir - a temporary directory for the it.unimi.dsi.sux4j.io.ChunkedHashStore files, or null for the standard temporary directory.

Returns:

this builder.

store

public MinimalPerfectHashFunction.Builder<T> store(ChunkedHashStore<T> chunkedHashStore)

Specifies a chunked hash store containing the keys.

Parameters:

chunkedHashStore - a chunked hash store containing the keys, or null; the store can be unchecked, but in this case you must specify keys and a transform (otherwise, in case of a hash collision in the store an IllegalStateException will be thrown).

Returns:

this builder.

build

public MinimalPerfectHashFunction<T> build()
                                    throws IOException

Builds a minimal perfect hash function.

Returns:

a MinimalPerfectHashFunction instance with the specified parameters.

Throws:

IllegalStateException - if called more than once.

IOException