com.chemaxon.descriptors.common.binary

Class BinaryVectorDescriptorImpl

java.lang.Object

com.chemaxon.descriptors.common.binary.BinaryVectorDescriptorImpl

All Implemented Interfaces:

BinaryVectorDescriptor, Descriptor, Guarded, Serializable

public class BinaryVectorDescriptorImpl
extends Object
implements BinaryVectorDescriptor

Binary vector fingerprint representation.

Note that compatibility of instances is enforced by checking the guard object references. It is expected that all parameters (endianness, length) should match for the instances having the same guard object reference associated.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.chemaxon.descriptors.common.Guarded

Guarded.EnsureThat, Guarded.New

Constructor Summary

Constructors

Constructor and Description
BinaryVectorDescriptorImpl(BitSet fp, Object guardObject, int size, BinaryVectors.Endianness endianness) Constructor.
BinaryVectorDescriptorImpl(byte[] serialized, Object guardObject, int size) Deprecated. Use BinaryVectorDescriptorImpl(byte[], java.lang.Object, int, com.chemaxon.descriptors.common.BinaryVectors.Endianness)
BinaryVectorDescriptorImpl(byte[] serialized, Object guardObject, int size, BinaryVectors.Endianness endianness) Construct from serialized form.
BinaryVectorDescriptorImpl(int[] fp, Object guardObject, int size) Deprecated. Use BinaryVectorDescriptorImpl(int[], java.lang.Object, int, com.chemaxon.descriptors.common.BinaryVectors.Endianness)
BinaryVectorDescriptorImpl(int[] fp, Object guardObject, int size, BinaryVectors.Endianness endianness) Constructor.
BinaryVectorDescriptorImpl(long[] fp, Object guardObject, int size) Deprecated. Use BinaryVectorDescriptorImpl(long[], java.lang.Object, int, com.chemaxon.descriptors.common.BinaryVectors.Endianness) with explicit endianness specification
BinaryVectorDescriptorImpl(long[] fp, Object guardObject, int size, BinaryVectors.Endianness endianness) Construct from a long array representation.
BinaryVectorDescriptorImpl(String decimalString, Object guardObject, int size, BinaryVectors.Endianness endianness) Construct from decimal String representation.

Method Summary

Modifier and Type	Method and Description
int	calculateDarkness() Calculate the darkness of this fingerprint.
int[]	getFP() Get integer array representation of this fingerprint.
BitSet	getFpAsBitset() Get BitSet representation of this fingerprint.
byte[]	getFpAsBytes() Convert to byte array.
long[]	getFpAsLongs() Get long array representation of this fingerprint.
Object	getGuardObject() Gets the guard object associated to the generated descriptors/utilities.
byte[]	serialize() Deprecated. Use getFpAsBytes()
String	toBinaryString() Converts the fingerprint into a binary string containing '0' and '1' characters without further delimiters.
String	toDecimalString() Deprecated. Use toIntDecimalString()
String	toIntDecimalString() Converts the fingerprints integer array representation into a tab separated string.
String	toLongDecimalString() Converts the fingerprints long array representation into a tab separated string.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

BinaryVectorDescriptorImpl

public BinaryVectorDescriptorImpl(BitSet fp,
                                  Object guardObject,
                                  int size,
                                  BinaryVectors.Endianness endianness)

Constructor.

Parameters:

fp - Fingerprint to represent

guardObject - Associated guard object

size - Fingerprint size in bits

endianness - Endianness of packing operations

BinaryVectorDescriptorImpl

public BinaryVectorDescriptorImpl(int[] fp,
                                  Object guardObject,
                                  int size,
                                  BinaryVectors.Endianness endianness)

Constructor.

Parameters:

fp - Fingerprint to represent

guardObject - Associated guard object

size - Fingerprint size

endianness - Endianness of packing operations

BinaryVectorDescriptorImpl

@Deprecated
public BinaryVectorDescriptorImpl(int[] fp,
                                              Object guardObject,
                                              int size)

Deprecated. Use BinaryVectorDescriptorImpl(int[], java.lang.Object, int, com.chemaxon.descriptors.common.BinaryVectors.Endianness)

Constructor.

Parameters:

fp - Fingerprint to represent

guardObject - Associated guard object

size - Fingerprint size

BinaryVectorDescriptorImpl

public BinaryVectorDescriptorImpl(long[] fp,
                                  Object guardObject,
                                  int size,
                                  BinaryVectors.Endianness endianness)

Construct from a long array representation.

Parameters:

fp - Fingerprint to represent

guardObject - Associated guard object

size - Fingerprint size; expected to be multiply of 64 (bits in a long value)

endianness - Endianness of packing operations

BinaryVectorDescriptorImpl

@Deprecated
public BinaryVectorDescriptorImpl(long[] fp,
                                              Object guardObject,
                                              int size)

Deprecated. Use BinaryVectorDescriptorImpl(long[], java.lang.Object, int, com.chemaxon.descriptors.common.BinaryVectors.Endianness) with explicit endianness specification

Construct from a long array representation.

Note that endianness of the long - int conversion is not specified. To retrieve the long array representation use getFpAsLongs().

Parameters:

fp - Fingerprint to represent

guardObject - Associated guard object

size - Fingerprint size; expected to be multiply of 64 (bits in a long value)

BinaryVectorDescriptorImpl

public BinaryVectorDescriptorImpl(byte[] serialized,
                                  Object guardObject,
                                  int size,
                                  BinaryVectors.Endianness endianness)

Construct from serialized form.

Byte array serialized form.

Parameters:

serialized - Serialized form

guardObject - Associated guard object

size - Expected fingerprint size

endianness - Endianness of packing operations

BinaryVectorDescriptorImpl

@Deprecated
public BinaryVectorDescriptorImpl(byte[] serialized,
                                              Object guardObject,
                                              int size)

Deprecated. Use BinaryVectorDescriptorImpl(byte[], java.lang.Object, int, com.chemaxon.descriptors.common.BinaryVectors.Endianness)

Construct from serialized form.

Byte array serialized form.

Parameters:

serialized - Serialized form

guardObject - Associated guard object

size - Expected fingerprint size

BinaryVectorDescriptorImpl

public BinaryVectorDescriptorImpl(String decimalString,
                                  Object guardObject,
                                  int size,
                                  BinaryVectors.Endianness endianness)

Construct from decimal String representation.

Parameters:

decimalString - Decimal String representation

guardObject - Associated guard object

size - Expected fingerprint size

endianness - Endianness of packing operations

Method Detail

getFP

public int[] getFP()

Description copied from interface: BinaryVectorDescriptor

Get integer array representation of this fingerprint.

The returned array might be the the internal representation array so changing the values is forbidden. Please note that this behavior is not guaranteed, the returned array can be a non cached copy of the represented binary vector generated on every invocation.

Specified by:

getFP in interface BinaryVectorDescriptor

Returns:

Integer array representation

getGuardObject

public Object getGuardObject()

Description copied from interface: Guarded

Gets the guard object associated to the generated descriptors/utilities. Note that serialization/deserialization must preserve guard object reference.

This method is intended to use only for ensuring the compatibility of manipulated objects.

Implementations might use the associated DescriptorGenerator or DescriptorParameters reference as the guard object, however it is a non recommended practice to use this method to access the associated generator to perform further operations on it.

Specified by:

getGuardObject in interface Guarded

Returns:

The guard object, can not be null.

getFpAsBytes

public byte[] getFpAsBytes()

Description copied from interface: BinaryVectorDescriptor

Convert to byte array.

Specified by:

getFpAsBytes in interface BinaryVectorDescriptor

Returns:

byte array representation

serialize

@Deprecated
public byte[] serialize()

Deprecated. Use getFpAsBytes()

Create serialized byte array representation.

Returns:

Serialized byte array representation

calculateDarkness

public int calculateDarkness()

Description copied from interface: BinaryVectorDescriptor

Calculate the darkness of this fingerprint.

Please note that the returned value is not necessarily cached, so the calculation might be executed for multiple consecutive invocations.

Specified by:

calculateDarkness in interface BinaryVectorDescriptor

Returns:

Count of set bits in the fingerprint

toIntDecimalString

public String toIntDecimalString()

Description copied from interface: BinaryVectorDescriptor

Converts the fingerprints integer array representation into a tab separated string.

Specified by:

toIntDecimalString in interface BinaryVectorDescriptor

Returns:

string representation of the fingerprint. The first integer in the returned string is the integer representation arrays first element (with index 0)

toLongDecimalString

public String toLongDecimalString()

Description copied from interface: BinaryVectorDescriptor

Converts the fingerprints long array representation into a tab separated string.

Specified by:

toLongDecimalString in interface BinaryVectorDescriptor

Returns:

string representation of the fingerprint. The first long in the returned string is the long representation arrays first element (with index 0)

toDecimalString

@Deprecated
public String toDecimalString()

Deprecated. Use toIntDecimalString()

Converts the fingerprints integer array representation into a tab separated string.

Returns:

string representation of the fingerprint. The first integer in the returned string is the integer representation arrays first element (with index 0)

toBinaryString

public String toBinaryString()

Converts the fingerprint into a binary string containing '0' and '1' characters without further delimiters.

The first bit is the least significant bit of the first integer value of the integer representation.

Specified by:

toBinaryString in interface BinaryVectorDescriptor

Returns:

binary string representation of the fingerprint.

toString

public String toString()

Overrides:

toString in class Object

getFpAsLongs

public long[] getFpAsLongs()

Description copied from interface: BinaryVectorDescriptor

Get long array representation of this fingerprint.

The returned array might be the the internal representation array so changing the values is forbidden. Please note that this behavior is not guaranteed, the returned array can be a non cached copy of the represented binary vector generated on every invocation.

Specified by:

getFpAsLongs in interface BinaryVectorDescriptor

Returns:

Long array representation

getFpAsBitset

public BitSet getFpAsBitset()

Description copied from interface: BinaryVectorDescriptor

Get BitSet representation of this fingerprint.

Specified by:

getFpAsBitset in interface BinaryVectorDescriptor

Returns:

BitSet representation