Class TwoStepsGOV3Function.Builder<T>

java.lang.Object

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

Enclosing class:

TwoStepsGOV3Function<T>

public static class TwoStepsGOV3Function.Builder<T>
extends Object

A builder class for TwoStepsGOV3Function.

Since:

4.0

Author:

Sebastiano Vigna

Field Summary

Fields

Modifier and Type	Field	Description
protected BucketedHashStore<T>	bucketedHashStore
protected boolean	built	Whether build() has already been called.
protected Iterable<? extends T>	keys
protected File	tempDir
protected it.unimi.dsi.bits.TransformationStrategy<? super T>	transform
protected it.unimi.dsi.fastutil.longs.LongBigList	values

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
TwoStepsGOV3Function<T>	build()	Builds a new function.
TwoStepsGOV3Function.Builder<T>	keys(Iterable<? extends T> keys)	Specifies the keys of the function; if you have specified a BucketedHashStore, it can be null.
TwoStepsGOV3Function.Builder<T>	store(BucketedHashStore<T> bucketedHashStore)	Specifies a bucketed hash store containing the keys associated with their rank.
TwoStepsGOV3Function.Builder<T>	tempDir(File tempDir)	Specifies a temporary directory for the BucketedHashStore.
TwoStepsGOV3Function.Builder<T>	transform(it.unimi.dsi.bits.TransformationStrategy<? super T> transform)	Specifies the transformation strategy for the keys of the function.
TwoStepsGOV3Function.Builder<T>	values(it.unimi.dsi.fastutil.longs.LongBigList values)	Specifies the values assigned to the keys; the output width of the function will be the minimum width needed to represent all values.

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

tempDir

protected File tempDir

bucketedHashStore

protected BucketedHashStore<T> bucketedHashStore

values

protected it.unimi.dsi.fastutil.longs.LongBigList values

built

protected boolean built

Whether build() has already been called.

Constructor Details

Builder

public Builder()

Method Details

keys

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

Specifies the keys of the function; if you have specified a BucketedHashStore, it can be null.

Parameters:

keys - the keys of the function.

Returns:

this builder.

transform

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

Specifies the transformation strategy for the keys of the function.

Parameters:

transform - a transformation strategy for the keys of the function.

Returns:

this builder.

tempDir

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

Specifies a temporary directory for the BucketedHashStore.

Parameters:

tempDir - a temporary directory for the BucketedHashStore files, or null for the standard temporary directory.

Returns:

this builder.

store

public TwoStepsGOV3Function.Builder<T> store(BucketedHashStore<T> bucketedHashStore)

Specifies a bucketed hash store containing the keys associated with their rank.

Warning: during the construction phase, a filter will be set on the specified BucketedHashStore. You will have to reset it to its previous state.

Parameters:

bucketedHashStore - a bucketed hash store containing the keys associated with their rank, 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.

values

public TwoStepsGOV3Function.Builder<T> values(it.unimi.dsi.fastutil.longs.LongBigList values)

Specifies the values assigned to the keys; the output width of the function will be the minimum width needed to represent all values.

Parameters:

values - values to be assigned to each element, in the same order of the keys.

Returns:

this builder.

build

public TwoStepsGOV3Function<T> build()
                              throws IOException

Builds a new function.

Returns:

a GOV3Function instance with the specified parameters.

Throws:

IllegalStateException - if called more than once.

IOException