org.tensorflow.op.core

Class Constant<T>

java.lang.Object

org.tensorflow.op.PrimitiveOp

org.tensorflow.op.core.Constant<T>

All Implemented Interfaces:

Op, Operand<T>

@Operator
public final class Constant<T>
extends PrimitiveOp
implements Operand<T>

An operator producing a constant value.

Field Summary

Fields inherited from class org.tensorflow.op.PrimitiveOp

operation

Method Summary

Modifier and Type	Method and Description
Output<T>	asOutput() Returns the symbolic handle of a tensor.
static <T> Constant<T>	create(Scope scope, Class<T> type, long[] shape, ByteBuffer data) Create a constant with data from the given buffer.
static Constant<Double>	create(Scope scope, long[] shape, DoubleBuffer data) Create a DataType.DOUBLE constant with data from the given buffer.
static Constant<Float>	create(Scope scope, long[] shape, FloatBuffer data) Create a DataType.FLOAT constant with data from the given buffer.
static Constant<Integer>	create(Scope scope, long[] shape, IntBuffer data) Create a DataType.INT32 constant with data from the given buffer.
static Constant<Long>	create(Scope scope, long[] shape, LongBuffer data) Create a DataType.INT64 constant with data from the given buffer.
static <T> Constant<T>	create(Scope scope, Object object, Class<T> type) Create a constant from a Java object.

Methods inherited from class org.tensorflow.op.PrimitiveOp

equals, hashCode, toString

Methods inherited from class java.lang.Object

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

Method Detail

create

public static <T> Constant<T> create(Scope scope,
                                     Object object,
                                     Class<T> type)

Create a constant from a Java object.

The argument object is first converted into a Tensor using Tensor.create(Object), so only Objects supported by this method must be provided. For example:

 Constant.create(scope, 7); // returns a constant scalar tensor 7
 

Parameters:

scope - is a scope used to add the underlying operation.

object - a Java object representing the constant.

See Also:

Tensor.create

create

public static Constant<Integer> create(Scope scope,
                                       long[] shape,
                                       IntBuffer data)

Create a DataType.INT32 constant with data from the given buffer.

Creates a constant with the given shape by copying elements from the buffer (starting from its current position) into the tensor. For example, if shape = {2,3} (which represents a 2x3 matrix) then the buffer must have 6 elements remaining, which will be consumed by this method.

Parameters:

scope - is a scope used to add the underlying operation.

shape - the tensor shape.

data - a buffer containing the tensor data.

Throws:

IllegalArgumentException - If the tensor shape is not compatible with the buffer

create

public static Constant<Float> create(Scope scope,
                                     long[] shape,
                                     FloatBuffer data)

Create a DataType.FLOAT constant with data from the given buffer.

Creates a constant with the given shape by copying elements from the buffer (starting from its current position) into the tensor. For example, if shape = {2,3} (which represents a 2x3 matrix) then the buffer must have 6 elements remaining, which will be consumed by this method.

Parameters:

scope - is a scope used to add the underlying operation.

shape - the tensor shape.

data - a buffer containing the tensor data.

Throws:

IllegalArgumentException - If the tensor shape is not compatible with the buffer

create

public static Constant<Double> create(Scope scope,
                                      long[] shape,
                                      DoubleBuffer data)

Create a DataType.DOUBLE constant with data from the given buffer.

Creates a constant with the given shape by copying elements from the buffer (starting from its current position) into the tensor. For example, if shape = {2,3} (which represents a 2x3 matrix) then the buffer must have 6 elements remaining, which will be consumed by this method.

Parameters:

scope - is a scope used to add the underlying operation.

shape - the tensor shape.

data - a buffer containing the tensor data.

Throws:

IllegalArgumentException - If the tensor shape is not compatible with the buffer

create

public static Constant<Long> create(Scope scope,
                                    long[] shape,
                                    LongBuffer data)

Create a DataType.INT64 constant with data from the given buffer.

Creates a constant with the given shape by copying elements from the buffer (starting from its current position) into the tensor. For example, if shape = {2,3} (which represents a 2x3 matrix) then the buffer must have 6 elements remaining, which will be consumed by this method.

Parameters:

scope - is a scope used to add the underlying operation.

shape - the tensor shape.

data - a buffer containing the tensor data.

Throws:

IllegalArgumentException - If the tensor shape is not compatible with the buffer

create

public static <T> Constant<T> create(Scope scope,
                                     Class<T> type,
                                     long[] shape,
                                     ByteBuffer data)

Create a constant with data from the given buffer.

Creates a Constant with the provided shape of any type where the constant data has been encoded into data as per the specification of the TensorFlow C API.

Parameters:

scope - is a scope used to add the underlying operation.

type - the tensor datatype.

shape - the tensor shape.

data - a buffer containing the tensor data.

Throws:

IllegalArgumentException - If the tensor datatype or shape is not compatible with the buffer

asOutput

public Output<T> asOutput()

Description copied from interface: Operand

Returns the symbolic handle of a tensor.

Inputs to TensorFlow operations are outputs of another TensorFlow operation. This method is used to obtain a symbolic handle that represents the computation of the input.

Specified by:

asOutput in interface Operand<T>

See Also:

OperationBuilder.addInput(Output)