com.chemaxon.descriptors.common.realvector

Class ScaledShortsFloatVectorDescriptor

java.lang.Object

com.chemaxon.descriptors.common.realvector.ScaledShortsFloatVectorDescriptor

All Implemented Interfaces:

Descriptor, FloatVectorDescriptor, Guarded, ScaledFvDescriptor, Serializable

public class ScaledShortsFloatVectorDescriptor
extends Object
implements ScaledFvDescriptor, Serializable

Float vector descriptor implementation over scaled shorts.

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
ScaledShortsFloatVectorDescriptor(byte[] fp, ScaledFvDescriptorGenerator gen, int length) Construct.
ScaledShortsFloatVectorDescriptor(float[] fp, ScaledFvDescriptorGenerator gen, int length) Construct.

Method Summary

Modifier and Type	Method and Description
double	euclidSqrShorts(short[] other) Square of euclidean.
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.
short[]	getShorts() Get scaled shorts representation.
double	manhattanShorts(short[] other) Manhattan.
double	maximumShorts(short[] other) Maximum.
static double	tanimotoShorts(LinearScaler scaler, short[] target, short[] query) Tanimoto.
byte[]	toByteArray() Create byte array serialized form.

Methods inherited from class java.lang.Object

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

Constructor Detail

ScaledShortsFloatVectorDescriptor

public ScaledShortsFloatVectorDescriptor(float[] fp,
                                         ScaledFvDescriptorGenerator gen,
                                         int length)

Construct.

Parameters:

fp - Float values

gen - Scaler to use for projection; also serves as the guard object

length - Expected length of descriptors

ScaledShortsFloatVectorDescriptor

public ScaledShortsFloatVectorDescriptor(byte[] fp,
                                         ScaledFvDescriptorGenerator gen,
                                         int length)

Construct.

Parameters:

fp - Bytes serialized representation

gen - Scaler to use for projection; also serves as the guard object

length - Expected length of descriptors

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

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

toByteArray

public byte[] toByteArray()

Description copied from interface: ScaledFvDescriptor

Create byte array serialized form.

Specified by:

toByteArray in interface ScaledFvDescriptor

Returns:

Byte array serialized form

getShorts

public short[] getShorts()

Get scaled shorts representation.

Returns:

Scaled shorts representation

euclidSqrShorts

public double euclidSqrShorts(short[] other)

Square of euclidean.

Parameters:

other - Scaled shorts representation of the other descriptor.

Returns:

Square of euclidean dissimilarity

manhattanShorts

public double manhattanShorts(short[] other)

Manhattan.

Parameters:

other - Scaled shorts representation of the other descriptor.

Returns:

Manhattan dissimilarity

maximumShorts

public double maximumShorts(short[] other)

Maximum.

Parameters:

other - Scaled shorts representation of the other descriptor.

Returns:

Manhattan dissimilarity

tanimotoShorts

public static double tanimotoShorts(LinearScaler scaler,
                                    short[] target,
                                    short[] query)

Tanimoto.

Parameters:

scaler - Underlying scaler

target - Scaled shorts representation of the target descriptor.

query - Scaled shorts representation of the query descriptor.

Returns:

Generalized tanimoto dissimilarity

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.