Package org.tribuo.math.distance

Class CosineDistance

java.lang.Object

org.tribuo.math.distance.CosineDistance

All Implemented Interfaces:

com.oracle.labs.mlrg.olcut.config.Configurable, com.oracle.labs.mlrg.olcut.provenance.Provenancable<com.oracle.labs.mlrg.olcut.provenance.ConfiguredObjectProvenance>, Serializable, Distance, ProtoSerializable<org.tribuo.math.protos.DistanceProto>

public final class CosineDistance
extends Object
implements Distance

Cosine similarity used as a distance measure.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final int	CURRENT_VERSION	Protobuf serialization version.

Fields inherited from interface org.tribuo.protos.ProtoSerializable

DESERIALIZATION_METHOD_NAME, PROVENANCE_SERIALIZER

Constructor Summary

Constructors

Constructor	Description
CosineDistance()	Constructs a Cosine distance function.

Method Summary

Modifier and Type	Method	Description
double	computeDistance(SGDVector first, SGDVector second)	Computes the distance between the two vectors.
static CosineDistance	deserializeFromProto(int version, String className, com.google.protobuf.Any message)	Deserialization factory.
boolean	equals(Object o)
com.oracle.labs.mlrg.olcut.provenance.ConfiguredObjectProvenance	getProvenance()
int	hashCode()
org.tribuo.math.protos.DistanceProto	serialize()	Serializes this object to a protobuf.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.oracle.labs.mlrg.olcut.config.Configurable

postConfig

Field Details

CURRENT_VERSION

public static final int CURRENT_VERSION

Protobuf serialization version.

See Also:

• Constant Field Values

Constructor Details

CosineDistance

public CosineDistance()

Constructs a Cosine distance function.

Method Details

deserializeFromProto

public static CosineDistance deserializeFromProto(int version,
 String className,
 com.google.protobuf.Any message)

Deserialization factory.

Parameters:

version - The serialized object version.

className - The class name.

message - The serialized data.

Returns:

The deserialized object.

serialize

public org.tribuo.math.protos.DistanceProto serialize()

Description copied from interface: ProtoSerializable

Serializes this object to a protobuf.

Specified by:

serialize in interface ProtoSerializable<org.tribuo.math.protos.DistanceProto>

Returns:

The protobuf.

computeDistance

public double computeDistance(SGDVector first,
 SGDVector second)

Description copied from interface: Distance

Computes the distance between the two vectors.

Specified by:

computeDistance in interface Distance

Parameters:

first - The first vector.

second - The second vector.

Returns:

The distance between them.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

getProvenance

public com.oracle.labs.mlrg.olcut.provenance.ConfiguredObjectProvenance getProvenance()

Specified by:

getProvenance in interface com.oracle.labs.mlrg.olcut.provenance.Provenancable<com.oracle.labs.mlrg.olcut.provenance.ConfiguredObjectProvenance>