jklustor-all-api-0.0.7-20140619012755 (ChemAxon)


com.chemaxon.descriptors.vectors.floats
Class FvParameters

Object
  extended by com.chemaxon.descriptors.vectors.floats.FvParameters
All Implemented Interfaces:
DescriptorParameters, Serializable

@Beta
public final class FvParameters
extends Object
implements DescriptorParameters, Serializable

Parameters for generic float vector descriptor.

Author:
Gabor Imre
See Also:
Serialized Form

Nested Class Summary
static class FvParameters.Builder
          Builder for FvParameters.
protected static interface FvParameters.ConstructFvGenerator
          Interface representing BvGenerator implementation constructor
static class FvParameters.NumericRepresentation
          Representation of the vector coordinates.
static class FvParameters.SparseCompression
          Optimization for sparse vectors.
 
Field Summary
static int DEFAULT_LENGTH
          Default length (dimensions).
static FvParameters.NumericRepresentation DEFAULT_NUMERIC_REPRESENTATION
          Default numeric representation.
static double DEFAULT_SCALED_MAX
          Default max value for scaling.
static double DEFAULT_SCALED_MIN
          Default min value for scaling.
static FvParameters.SparseCompression DEFAULT_SPARSE_COMPRESSION
          Default compression.
 
Constructor Summary
FvParameters()
          Construct with default values.
FvParameters(FvParameters.Builder builder)
          Constructor based on a builder.
 
Method Summary
static FvParameters.Builder createNewBuilder()
          Construct a builder for this parameter class, initialized to default.
 FvGenerator getDescriptorGenerator()
          Return the represented descriptor generator.
 int getLength()
          Returns represented fingerprint length (bit count) setting.
 FvParameters.NumericRepresentation getNumericRepresentation()
          Numeric representation.
 double getScaledMax()
          Max value for scaled fixed point representations.
 double getScaledMin()
          Min value for scaled fixed point representations.
 FvParameters.SparseCompression getSparseCompression()
          Sparse compression.
 String toString()
           
 
Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

DEFAULT_LENGTH

public static final int DEFAULT_LENGTH
Default length (dimensions).

See Also:
Constant Field Values

DEFAULT_NUMERIC_REPRESENTATION

public static final FvParameters.NumericRepresentation DEFAULT_NUMERIC_REPRESENTATION
Default numeric representation.


DEFAULT_SCALED_MIN

public static final double DEFAULT_SCALED_MIN
Default min value for scaling.

See Also:
Constant Field Values

DEFAULT_SCALED_MAX

public static final double DEFAULT_SCALED_MAX
Default max value for scaling.

See Also:
Constant Field Values

DEFAULT_SPARSE_COMPRESSION

public static final FvParameters.SparseCompression DEFAULT_SPARSE_COMPRESSION
Default compression.

Constructor Detail

FvParameters

public FvParameters(FvParameters.Builder builder)
Constructor based on a builder.

Parameters:
builder - Builder which current state will be represented.

FvParameters

public FvParameters()
Construct with default values.

Method Detail

getDescriptorGenerator

public FvGenerator getDescriptorGenerator()
Description copied from interface: DescriptorParameters
Return the represented descriptor generator.

Please note that certain descriptors might provide multiple DescriptorGenerator implementations for different descriptor representations. (Consider structure based fingerprints feature list/feature counts/folded finite binary vector representations.) Such different descriptor generators might be exposed through their parameters object as multiple factory methods.

Specified by:
getDescriptorGenerator in interface DescriptorParameters
Returns:
Associated generator

toString

public String toString()
Overrides:
toString in class Object

createNewBuilder

public static FvParameters.Builder createNewBuilder()
Construct a builder for this parameter class, initialized to default.

Returns:
Builder initialized to default settings

getLength

public int getLength()
Returns represented fingerprint length (bit count) setting.

Returns:
Fingerprint length

getNumericRepresentation

public FvParameters.NumericRepresentation getNumericRepresentation()
Numeric representation.

Returns:
Numeric representation of underlying vector

getSparseCompression

public FvParameters.SparseCompression getSparseCompression()
Sparse compression.

Returns:
Optimization for sparse vectors.

getScaledMax

public double getScaledMax()
Max value for scaled fixed point representations.

Returns:
max value

getScaledMin

public double getScaledMin()
Min value for scaled fixed point representations.

Returns:
min value

jklustor-all-api-0.0.7-20140619012755 (ChemAxon)