com.chemaxon.descriptors.common.realvector

Class FloatVectorDescriptorImpl

java.lang.Object

com.chemaxon.descriptors.common.realvector.FloatVectorDescriptorImpl

All Implemented Interfaces:

Descriptor, FloatVectorDescriptor, Guarded, Serializable

Direct Known Subclasses:

PharmacophoreFPImpl

public class FloatVectorDescriptorImpl
extends Object
implements FloatVectorDescriptor

Float vector descriptor implementation.

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
FloatVectorDescriptorImpl(byte[] serialized, Object guardObject) Deprecated. use FloatVectorDescriptorImpl(byte[], java.lang.Object, int) with explicit expected vector length instead
FloatVectorDescriptorImpl(byte[] serialized, Object guardObject, int length) Construct from serialized form.
FloatVectorDescriptorImpl(float[] fp, Object guardObject) Deprecated. Use FloatVectorDescriptorImpl(float[], Object, int) with explicit expected vector length parameter
FloatVectorDescriptorImpl(float[] fp, Object guardObject, int length) Construct new instance.
FloatVectorDescriptorImpl(String decimalString, Object guardObject) Deprecated. Use FloatVectorDescriptorImpl(java.lang.String, Object, int) with explicit expected vector length instead
FloatVectorDescriptorImpl(String decimalString, Object guardObject, int length) Construct from decimal String representation.

Method Summary

Modifier and Type	Method and Description
double	getEuclideanNorm() Euclidean norm of the represented vector.
float[]	getFP() Gets the float array representation of the fingerprint.
Object	getGuardObject() Gets the guard object associated to the generated descriptors/utilities.
double	getManhattanNorm() Manhattan norm of the represented vector.
double	getMaximumNorm() Maximum norm of the represented vector.
byte[]	serialize() Create serialized byte array representation.
String	toDecimalString() Converts the fingerprints float array representation into a tab separated string.

Methods inherited from class java.lang.Object

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

Constructor Detail

FloatVectorDescriptorImpl

@Deprecated
public FloatVectorDescriptorImpl(float[] fp,
                                             Object guardObject)

Deprecated. Use FloatVectorDescriptorImpl(float[], Object, int) with explicit expected vector length parameter

Construct new instance.

Parameters:

fp - float representation

guardObject - associated guard

FloatVectorDescriptorImpl

public FloatVectorDescriptorImpl(float[] fp,
                                 Object guardObject,
                                 int length)

Construct new instance.

Parameters:

fp - float representation

guardObject - associated generator

length - Expected descriptor length

FloatVectorDescriptorImpl

@Deprecated
public FloatVectorDescriptorImpl(byte[] serialized,
                                             Object guardObject)

Deprecated. use FloatVectorDescriptorImpl(byte[], java.lang.Object, int) with explicit expected vector length instead

Construct from serialized form.

Parameters:

serialized - serialized form

guardObject - associated guard object

FloatVectorDescriptorImpl

public FloatVectorDescriptorImpl(byte[] serialized,
                                 Object guardObject,
                                 int length)

Construct from serialized form.

Parameters:

serialized - serialized form

guardObject - associated guard object

length - Expected descriptor length

FloatVectorDescriptorImpl

@Deprecated
public FloatVectorDescriptorImpl(String decimalString,
                                             Object guardObject)

Deprecated. Use FloatVectorDescriptorImpl(java.lang.String, Object, int) with explicit expected vector length instead

Construct from decimal String representation.

Parameters:

decimalString - decimal String representation

guardObject - associated guard object

FloatVectorDescriptorImpl

public FloatVectorDescriptorImpl(String decimalString,
                                 Object guardObject,
                                 int length)

Construct from decimal String representation.

Parameters:

decimalString - decimal String representation

guardObject - associated guard object

length - Length of float vectors

Method Detail

getFP

public float[] getFP()

Description copied from interface: FloatVectorDescriptor

Gets the float array representation of the 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 vector generated on every invocation.

Specified by:

getFP in interface FloatVectorDescriptor

Returns:

float array

serialize

public byte[] serialize()

Create serialized byte array representation.

Returns:

serialized byte array representation

toDecimalString

public String toDecimalString()

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

Returns:

string representation of the fingerprint

getEuclideanNorm

public double getEuclideanNorm()

Description copied from interface: FloatVectorDescriptor

Euclidean norm of the represented vector.

Note that the actual implementation might or might not cache the returned value.

Specified by:

getEuclideanNorm in interface FloatVectorDescriptor

Returns:

Square root of the sum of the squares of the coordinates

See Also:

http://en.wikipedia.org/wiki/Norm_(mathematics)#Euclidean_norm

getManhattanNorm

public double getManhattanNorm()

Description copied from interface: FloatVectorDescriptor

Manhattan norm of the represented vector.

Note that the actual implementation might or might not cache the returned value.

Specified by:

getManhattanNorm in interface FloatVectorDescriptor

Returns:

Sum of the squares of the coordinates

See Also:

http://en.wikipedia.org/wiki/Norm_(mathematics)#Taxicab_norm_or_Manhattan_norm, http://en.wikipedia.org/wiki/Taxicab_geometry

getMaximumNorm

public double getMaximumNorm()

Description copied from interface: FloatVectorDescriptor

Maximum norm of the represented vector.

Note that the actual implementation might or might not cache the returned value.

Specified by:

getMaximumNorm in interface FloatVectorDescriptor

Returns:

Maximum of the absolute values of the coordinates

See Also:

http://en.wikipedia.org/wiki/Maximum_norm

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.