Package com.yahoo.tensor.functions

Class CosineSimilarity<NAMETYPE extends Name>

java.lang.Object

com.yahoo.tensor.functions.TensorFunction<NAMETYPE>

com.yahoo.tensor.functions.CosineSimilarity<NAMETYPE>

public class CosineSimilarity<NAMETYPE extends Name>
extends TensorFunction<NAMETYPE>

Convenience for cosine similarity between vectors. cosine_similarity(a, b, mydim) == sum(a*b, mydim) / sqrt(sum(a*a, mydim) * sum(b*b, mydim))

Author:

arnej

Constructor Summary

Constructors

Constructor	Description
CosineSimilarity(TensorFunction<NAMETYPE> argument1, TensorFunction<NAMETYPE> argument2, String dimension)

Method Summary

Modifier and Type	Method	Description
List<TensorFunction<NAMETYPE>>	arguments()	Returns the function arguments of this node in the order they are applied
Tensor	evaluate(EvaluationContext<NAMETYPE> context)	Evaluates this by first converting it to a primitive function
int	hashCode()	Returns a hashcode computed from the data in this
PrimitiveTensorFunction<NAMETYPE>	toPrimitive()	Translate this function - and all of its arguments recursively - to a tree of primitive functions only.
String	toString(ToStringContext<NAMETYPE> context)	Return a string representation of this context.
TensorType	type(TypeContext<NAMETYPE> context)	Returns the type of the tensor this produces given the input types in the context
TensorFunction<NAMETYPE>	withArguments(List<TensorFunction<NAMETYPE>> arguments)	Returns a copy of this tensor function with the arguments replaced by the given list of arguments.

Methods inherited from class com.yahoo.tensor.functions.TensorFunction

asScalarFunction, evaluate, toString, withTransformedFunctions

Methods inherited from class java.lang.Object

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

Constructor Details

CosineSimilarity

public CosineSimilarity(TensorFunction<NAMETYPE> argument1,
 TensorFunction<NAMETYPE> argument2,
 String dimension)

Method Details

arguments

public List<TensorFunction<NAMETYPE>> arguments()

Description copied from class: TensorFunction

Returns the function arguments of this node in the order they are applied

Specified by:

arguments in class TensorFunction<NAMETYPE extends Name>

withArguments

public TensorFunction<NAMETYPE> withArguments(List<TensorFunction<NAMETYPE>> arguments)

Description copied from class: TensorFunction

Returns a copy of this tensor function with the arguments replaced by the given list of arguments.

Specified by:

withArguments in class TensorFunction<NAMETYPE extends Name>

type

public TensorType type(TypeContext<NAMETYPE> context)

Description copied from class: TensorFunction

Returns the type of the tensor this produces given the input types in the context

Specified by:

type in class TensorFunction<NAMETYPE extends Name>

Parameters:

context - a context which must be passed to all nexted functions when evaluating

evaluate

public Tensor evaluate(EvaluationContext<NAMETYPE> context)

Evaluates this by first converting it to a primitive function

Specified by:

evaluate in class TensorFunction<NAMETYPE extends Name>

Parameters:

context - a context which must be passed to all nested functions when evaluating

toPrimitive

public PrimitiveTensorFunction<NAMETYPE> toPrimitive()

Description copied from class: TensorFunction

Translate this function - and all of its arguments recursively - to a tree of primitive functions only.

Specified by:

toPrimitive in class TensorFunction<NAMETYPE extends Name>

Returns:

a tree of primitive functions implementing this

toString

public String toString(ToStringContext<NAMETYPE> context)

Description copied from class: TensorFunction

Return a string representation of this context.

Specified by:

toString in class TensorFunction<NAMETYPE extends Name>

Parameters:

context - a context which must be passed to all nested functions when requesting the string value

hashCode

public int hashCode()

Description copied from class: TensorFunction

Returns a hashcode computed from the data in this

Specified by:

hashCode in class TensorFunction<NAMETYPE extends Name>