com.chemaxon.descriptors.vectors.floats

Class FvParameters.Builder

java.lang.Object

com.chemaxon.descriptors.vectors.floats.FvParameters.Builder

All Implemented Interfaces:

ParameterBuilder<FvParameters>

Enclosing class:

FvParameters

public static class FvParameters.Builder
extends Object
implements ParameterBuilder<FvParameters>

Builder for FvParameters.

Constructor Summary

Constructors

Constructor and Description
Builder() Constructor with default settings.
Builder(FvParameters parameters) Construct to represent the state of a parameter object instance.

Method Summary

Modifier and Type	Method and Description
FvParameters	build() Constructs an immutable instance of T.
FvParameters.Builder	length(int length) Set fingerprint length.
FvParameters.Builder	numericRepresentation(FvParameters.NumericRepresentation numericRepresentation) Set numeric representation of vector coordinates.
FvParameters.Builder	scaledMax(double scaledMax) Set upper bound for coordinate values used by fixed point backed representation.
FvParameters.Builder	scaledMin(double scaledMin) Set lower bound for coordinate values used by fixed point backed representation.
FvParameters.Builder	sparseCompression(FvParameters.SparseCompression sparseCompression) Set compression of sparse vectors.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Constructor with default settings.

Builder

public Builder(FvParameters parameters)

Construct to represent the state of a parameter object instance.

Parameters:

parameters - Parameter object

Method Detail

length

public FvParameters.Builder length(int length)

Set fingerprint length.

Parameters:

length - Fingerprint length (number of bits)

Returns:

Reference to this builder

Throws:

IllegalArgumentException - when the set length is not a positive number

numericRepresentation

public FvParameters.Builder numericRepresentation(FvParameters.NumericRepresentation numericRepresentation)

Set numeric representation of vector coordinates.

Parameters:

numericRepresentation - Numeric representation

Returns:

reference to this builder

sparseCompression

public FvParameters.Builder sparseCompression(FvParameters.SparseCompression sparseCompression)

Set compression of sparse vectors.

Parameters:

sparseCompression - Compression for sparse vectors

Returns:

Reference to this builder

scaledMin

public FvParameters.Builder scaledMin(double scaledMin)

Set lower bound for coordinate values used by fixed point backed representation.

Parameters:

scaledMin - Lower bound for coordinate values

Returns:

Reference to this builder

scaledMax

public FvParameters.Builder scaledMax(double scaledMax)

Set upper bound for coordinate values used by fixed point backed representation.

Parameters:

scaledMax - Lower bound for coordinate values

Returns:

Reference to this builder

build

public FvParameters build()

Description copied from interface: ParameterBuilder

Constructs an immutable instance of T.

Specified by:

build in interface ParameterBuilder<FvParameters>

Returns:

An immutable instance of T