Package com.yahoo.tensor.functions

Class Join

java.lang.Object

com.yahoo.tensor.functions.TensorFunction

com.yahoo.tensor.functions.PrimitiveTensorFunction

com.yahoo.tensor.functions.Join

public class Join
extends PrimitiveTensorFunction

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 argumentA, TensorFunction argumentB, java.util.function.DoubleBinaryOperator combinator)

Method Summary

Modifier and Type	Method	Description
java.util.List<TensorFunction>	arguments()	Returns the function arguments of this node in the order they are applied
java.util.function.DoubleBinaryOperator	combinator()
<NAMETYPE extends TypeContext.Name> 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	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.
<NAMETYPE extends TypeContext.Name> TensorType	type(TypeContext<NAMETYPE> context)	Returns the type of the tensor this produces given the input types in the context
TensorFunction	withArguments(java.util.List<TensorFunction> 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 argumentA,
            TensorFunction 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> 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

withArguments

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

toPrimitive

public PrimitiveTensorFunction 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

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

Parameters:

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

type

public <NAMETYPE extends TypeContext.Name> 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

Parameters:

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

evaluate

public <NAMETYPE extends TypeContext.Name> Tensor evaluate(EvaluationContext<NAMETYPE> context)

Description copied from class: TensorFunction

Evaluates this tensor.

Specified by:

evaluate in class TensorFunction

Parameters:

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