gov.nih.nlm.nls.tc.Api
Class SimilarityApi

java.lang.Object
  gov.nih.nlm.nls.tc.Api.SimilarityApi

public class SimilarityApi
extends java.lang.Object

This class provides APIs for calculate similarity value for JD vectors and ST vectors.

History:

Version:

V-2011

Author:

NLM Lexical Systems Group Design Document

Constructor Summary

SimilarityApi()
Creates an SimilarityApi object.

Method Summary

static float	GetSimilarity(java.util.Vector<Count1f> vec1, java.util.Vector<Count1f> vec2, JournalDescriptors jds) Get similarity in float for two JD vectors.
static float	GetSimilarity(java.util.Vector<Count1f> vec1, java.util.Vector<Count1f> vec2, SemanticTypes sts) Get similarity in float for two ST vectors.
static Count2f	GetSimilarity(java.util.Vector<Count2f> vec1, java.util.Vector<Count2f> vec2, SemanticTypes sts) Get similarity in float for two ST vectors.
static Count1f	GetSimilarityObj(java.util.Vector<Count1f> vec1, java.util.Vector<Count1f> vec2, JournalDescriptors jds) Get similarity in float for two JD vectors.
static Count1f	GetSimilarityObj(java.util.Vector<Count1f> vec1, java.util.Vector<Count1f> vec2, SemanticTypes sts) Get similarity in float for two ST vectors.
static Count2f	GetSimilarityObj(java.util.Vector<Count2f> vec1, java.util.Vector<Count2f> vec2, JournalDescriptors jds) Get similarity in float for two JD vectors.

Methods inherited from class java.lang.Object

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

Constructor Detail

SimilarityApi

public SimilarityApi()

Creates an SimilarityApi object.

Method Detail

GetSimilarityObj

public static Count1f GetSimilarityObj(java.util.Vector<Count1f> vec1,
                                       java.util.Vector<Count1f> vec2,
                                       JournalDescriptors jds)

Get similarity in float for two JD vectors. The name of JD vector must be Jdid.

Parameters:

vec1 - input JD vector 1

vec2 - input JD Vector 2

jds - common JD list

Returns:

similarity value in Count1f object

GetSimilarityObj

public static Count1f GetSimilarityObj(java.util.Vector<Count1f> vec1,
                                       java.util.Vector<Count1f> vec2,
                                       SemanticTypes sts)

Get similarity in float for two ST vectors. The name of ST vector must be TUI.

Parameters:

vec1 - input ST vector 1

vec2 - input ST Vector 2

sts - common ST list

Returns:

similarity value in Count1f object

GetSimilarity

public static float GetSimilarity(java.util.Vector<Count1f> vec1,
                                  java.util.Vector<Count1f> vec2,
                                  JournalDescriptors jds)

Get similarity in float for two JD vectors. The name of JD vector must be Jdid.

Parameters:

vec1 - input JD vector 1

vec2 - input JD Vector 2

jds - common JD list

Returns:

similarity value in float

GetSimilarity

public static float GetSimilarity(java.util.Vector<Count1f> vec1,
                                  java.util.Vector<Count1f> vec2,
                                  SemanticTypes sts)

Get similarity in float for two ST vectors. The name of ST vector must be TUI.

Parameters:

vec1 - input ST vector 1

vec2 - input ST Vector 2

sts - common ST list

Returns:

similarity value in float

GetSimilarityObj

public static Count2f GetSimilarityObj(java.util.Vector<Count2f> vec1,
                                       java.util.Vector<Count2f> vec2,
                                       JournalDescriptors jds)

Get similarity in float for two JD vectors. The name of JD vector must be Jdid.

Parameters:

vec1 - input JD vector 1

vec2 - input JD Vector 2

jds - common JD list

Returns:

similarity value in Count2f object

GetSimilarity

public static Count2f GetSimilarity(java.util.Vector<Count2f> vec1,
                                    java.util.Vector<Count2f> vec2,
                                    SemanticTypes sts)

Get similarity in float for two ST vectors. The name of ST vector must be TUI.

Parameters:

vec1 - input ST vector 1

vec2 - input ST Vector 2

sts - common ST list

Returns:

similarity value in Count2f object