com.chemaxon.descriptors.metrics

Class TverskyParameters.Builder

java.lang.Object

com.chemaxon.descriptors.metrics.TverskyParameters.Builder

All Implemented Interfaces:

ParameterBuilder<TverskyParameters>

Enclosing class:

TverskyParameters

@Beta
public static class TverskyParameters.Builder
extends Object
implements ParameterBuilder<TverskyParameters>

Builder for parameter object.

Constructor Summary

Constructors

Constructor and Description
Builder() Instantiate builder with default values.
Builder(double coeffQuery, double coeffTarget) Instantiate with weights.
Builder(TverskyParameters parameters) Instantiate builder based on an actual parameter instance.

Method Summary

Modifier and Type	Method and Description
TverskyParameters	build() Constructs an immutable instance of T.
TverskyParameters.Builder	coeffQuery(double coeffQuery) Set query coefficient.
TverskyParameters.Builder	coeffTarget(double coeffTarget) Set target coefficient.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Instantiate builder with default values.

Builder

public Builder(double coeffQuery,
               double coeffTarget)

Instantiate with weights.

Parameters:

coeffQuery - Query side coefficient

coeffTarget - Target side coefficient

Builder

public Builder(TverskyParameters parameters)

Instantiate builder based on an actual parameter instance.

Parameters:

parameters - Parameters to use

Method Detail

coeffTarget

public TverskyParameters.Builder coeffTarget(double coeffTarget)

Set target coefficient.

Parameters:

coeffTarget - Target coefficient

Returns:

Reference to this

coeffQuery

public TverskyParameters.Builder coeffQuery(double coeffQuery)

Set query coefficient.

Parameters:

coeffQuery - Query coefficient

Returns:

Reference to this

build

public TverskyParameters build()

Description copied from interface: ParameterBuilder

Constructs an immutable instance of T.

Specified by:

build in interface ParameterBuilder<TverskyParameters>

Returns:

An immutable instance of T