Package com.yahoo.document.datatypes

Class TensorFieldValue

java.lang.Object

com.yahoo.vespa.objects.Selectable

com.yahoo.vespa.objects.Identifiable

com.yahoo.document.datatypes.FieldValue

com.yahoo.document.datatypes.TensorFieldValue

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Comparable<FieldValue>

public class TensorFieldValue
extends FieldValue

Field value class that wraps a tensor.

Author:

geirst

Field Summary

Fields inherited from class com.yahoo.document.datatypes.FieldValue

classId

Constructor Summary

Constructors

Constructor	Description
TensorFieldValue()	Create an empty tensor field value where the tensor type is not yet known.
TensorFieldValue(com.yahoo.tensor.Tensor tensor)	Create a tensor field value containing the given tensor
TensorFieldValue(com.yahoo.tensor.TensorType type)	Create an empty tensor field value for the given tensor type

Method Summary

Modifier and Type	Method	Description
void	assign(java.lang.Object o)	Assign this non-fieldvalue value to this field value.
void	assignSerializedTensor(byte[] data)
void	assignTensor(java.util.Optional<com.yahoo.tensor.Tensor> tensor)	Assigns the given tensor to this field value.
void	clear()
void	deserialize(Field field, FieldReader reader)	Read a field value from the specified reader
boolean	equals(java.lang.Object o)
TensorDataType	getDataType()
java.util.Optional<byte[]>	getSerializedTensor()
java.util.Optional<com.yahoo.tensor.Tensor>	getTensor()
java.util.Optional<com.yahoo.tensor.TensorType>	getTensorType()
java.lang.Object	getWrappedValue()	Used to retrieve wrapped type for simple types, such that you can use get methods to retrieve ints and floats directly instead of Int/Float field values.
void	printXml(XmlStream xml)
void	serialize(Field field, FieldWriter writer)	Write out field value to the specified writer
java.lang.String	toString()

Methods inherited from class com.yahoo.document.datatypes.FieldValue

clone, compareTo, create, deserialize, getRecursiveValue, getRecursiveValue, onDeserialize, onSerialize, serialize, toXml

Methods inherited from class com.yahoo.vespa.objects.Identifiable

create, createFromId, deserialize, deserializeOptional, deserializeWithId, equals, getClassId, getUtf8, hashCode, onGetClassId, putUtf8, registerClass, serialize, serializeOptional, serializeWithId, visitMembers

Methods inherited from class com.yahoo.vespa.objects.Selectable

select, select, selectMembers

Methods inherited from class java.lang.Object

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

Constructor Detail

TensorFieldValue

public TensorFieldValue()

Create an empty tensor field value where the tensor type is not yet known. The tensor (and tensor type) can later be assigned with assignTensor().

TensorFieldValue

public TensorFieldValue(com.yahoo.tensor.TensorType type)

Create an empty tensor field value for the given tensor type

TensorFieldValue

public TensorFieldValue(com.yahoo.tensor.Tensor tensor)

Create a tensor field value containing the given tensor

Method Detail

getTensor

public java.util.Optional<com.yahoo.tensor.Tensor> getTensor()

getTensorType

public java.util.Optional<com.yahoo.tensor.TensorType> getTensorType()

getDataType

public TensorDataType getDataType()

Specified by:

getDataType in class FieldValue

toString

public java.lang.String toString()

Overrides:

toString in class com.yahoo.vespa.objects.Identifiable

printXml

public void printXml(XmlStream xml)

Specified by:

printXml in class FieldValue

clear

public void clear()

Specified by:

clear in class FieldValue

assign

public void assign(java.lang.Object o)

Description copied from class: FieldValue

Assign this non-fieldvalue value to this field value. This is used to be able to assign ints to Integer field values and List to Array field values and such.

Override to accept the specific types that should be legal.

Specified by:

assign in class FieldValue

assignSerializedTensor

public void assignSerializedTensor(byte[] data)

getSerializedTensor

public java.util.Optional<byte[]> getSerializedTensor()

assignTensor

public void assignTensor(java.util.Optional<com.yahoo.tensor.Tensor> tensor)

Assigns the given tensor to this field value. The tensor type is also set from the given tensor if it was not set before.

serialize

public void serialize(Field field,
                      FieldWriter writer)

Description copied from class: FieldValue

Write out field value to the specified writer

Specified by:

serialize in class FieldValue

deserialize

public void deserialize(Field field,
                        FieldReader reader)

Description copied from class: FieldValue

Read a field value from the specified reader

Specified by:

deserialize in class FieldValue

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class com.yahoo.vespa.objects.Identifiable

getWrappedValue

public java.lang.Object getWrappedValue()

Description copied from class: FieldValue

Used to retrieve wrapped type for simple types, such that you can use get methods to retrieve ints and floats directly instead of Int/Float field values. Complex types that can't be specified by simple java types just return themself.

Overrides:

getWrappedValue in class FieldValue