Package com.yahoo.tensor.functions

Class Join<NAMETYPE extends Name>

java.lang.Object

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

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

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

public class Join<NAMETYPE extends Name>
extends PrimitiveTensorFunction<NAMETYPE>

The join tensor operation produces a tensor from the argument tensors containing the set of cells given by the cross product of the cells of the given tensors, having as values the value produced by applying the given combinator function on the values from the two source cells.

Author:

bratseth

Constructor Summary

Constructors

Constructor	Description
Join(TensorFunction<NAMETYPE> argumentA, TensorFunction<NAMETYPE> argumentB, java.util.function.DoubleBinaryOperator combinator)

Method Summary

Modifier and Type	Method	Description
java.util.List<TensorFunction<NAMETYPE>>	arguments()	Returns the function arguments of this node in the order they are applied
java.util.function.DoubleBinaryOperator	combinator()
Tensor	evaluate(EvaluationContext<NAMETYPE> context)	Evaluates this tensor.
static TensorType	outputType(TensorType a, TensorType b)	Returns the type resulting from applying Join to the two given types
PrimitiveTensorFunction<NAMETYPE>	toPrimitive()	Translate this function - and all of its arguments recursively - to a tree of primitive functions only.
java.lang.String	toString(ToStringContext 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(java.util.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

evaluate, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

Join

public Join(TensorFunction<NAMETYPE> argumentA,
            TensorFunction<NAMETYPE> argumentB,
            java.util.function.DoubleBinaryOperator combinator)

Method Detail

outputType

public static TensorType outputType(TensorType a,
                                    TensorType b)

Returns the type resulting from applying Join to the two given types

combinator

public java.util.function.DoubleBinaryOperator combinator()

arguments

public java.util.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(java.util.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>

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 java.lang.String toString(ToStringContext 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

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)

Description copied from class: TensorFunction

Evaluates this tensor.

Specified by:

evaluate in class TensorFunction<NAMETYPE extends Name>

Parameters:

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