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


com.chemaxon.descriptors.vectors.binary
Class BvParameters

Object
  extended by com.chemaxon.descriptors.vectors.binary.BvParameters
All Implemented Interfaces:
DescriptorParameters, Serializable

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

Parameters for generic binary vector descriptor.

Author:
Gabor Imre
See Also:
Serialized Form

Nested Class Summary
static class BvParameters.Builder
          Builder for BvParameters.
protected static interface BvParameters.ConstructBvGenerator
          Interface representing BvGenerator implementation constructor
static class BvParameters.StringFormat
          Fingerprint textual representation.
 
Field Summary
static BinaryVectors.Endianness DEFAULT_ENDIANNESS
          Default endianness of packing operations.
static int DEFAULT_LENGTH
          Default length (bit count).
static BvParameters.StringFormat DEFAULT_STRING_FORMAT
          Default String format.
 
Constructor Summary
BvParameters()
          Construct with default values.
BvParameters(BvParameters.Builder builder)
          Constructor based on a builder.
 
Method Summary
static BvParameters.Builder createNewBuilder()
          Construct a builder for this parameter class, initialized to default.
 BvGenerator getDescriptorGenerator()
          Return the represented descriptor generator.
 BinaryVectors.Endianness getEndianness()
          Endianness of packing operations.
 int getLength()
          Returns represented fingerprint length (bit count) setting.
 BvParameters.StringFormat getStringFormat()
          Returns represented string format.
 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 (bit count).

See Also:
Constant Field Values

DEFAULT_STRING_FORMAT

public static final BvParameters.StringFormat DEFAULT_STRING_FORMAT
Default String format.


DEFAULT_ENDIANNESS

public static final BinaryVectors.Endianness DEFAULT_ENDIANNESS
Default endianness of packing operations.

Constructor Detail

BvParameters

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

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

BvParameters

public BvParameters()
Construct with default values.

Method Detail

getDescriptorGenerator

public BvGenerator 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 BvParameters.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.

Note that length is positive and multiply of 64 (bitcount of long).

Returns:
Fingerprint length

getStringFormat

public BvParameters.StringFormat getStringFormat()
Returns represented string format.

Returns:
String format used when converting descriptors to/from strings

getEndianness

public BinaryVectors.Endianness getEndianness()
Endianness of packing operations.

Binary vectors (fingerprints) represent a fixed number of bits identified by bit indices. The same fingerprint can be represented as a binary string, int, long or byte array. The first bit (having index 0), always maps to the first element from each of the packed array representations. Further mapping is determined by the endianness parameter.

Returns:
Endianness of packing operations.

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