org.bytedeco.tensorrt.nvinfer

Class IGatherLayer

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.tensorrt.nvinfer.INoCopy

org.bytedeco.tensorrt.nvinfer.ILayer

org.bytedeco.tensorrt.nvinfer.IGatherLayer

All Implemented Interfaces:

AutoCloseable

@Namespace(value="nvinfer1")
 @NoOffset
 @Properties(inherit=nvinfer.class)
public class IGatherLayer
extends ILayer

\class IGatherLayer \brief A Gather layer in a network definition. Supports several kinds of gathering. The Gather layer has two input tensors, Data and Indices, and an output tensor Output. Additionally, there are three parameters: mode, nbElementwiseDims, and axis that control how the indices are interpreted. * Data is a tensor of rank r >= 1 that stores the values to be gathered in Output. * Indices is a tensor of rank q that determines which locations in Data to gather. * GatherMode::kDEFAULT: q >= 0 * GatherMode::kND: q >= 1 and the last dimension of Indices must be a build time constant. * GatherMode::kELEMENT: q = r * Output stores the gathered results. Its rank s depends on the mode: * GatherMode::kDEFAULT: s = q + r - 1 - nbElementwiseDims * GatherMode::kND: s = q + r - indices.d[q-1] - 1 - nbElementwiseDims * GatherMode::kELEMENT: s = q = r. The output can be a shape tensor only if the mode is GatherMode::kDEFAULT. The dimensions of the output likewise depends on the mode: GatherMode::kDEFAULT: First nbElementwiseDims of output are computed by applying broadcast rules to first nbElementwiseDims of indices and data. Note that nbElementwiseDims <= 1. Rest of dimensions are computed by copying dimensions of Data, and replacing the dimension for axis gatherAxis with the dimensions of indices. GatherMode::kND: If indices.d[q-1] = r - nbElementwiseDims output.d = [indices.d[0], ... , indices.d[q-2]] Else if indices.d[q-1] < r - nbElementWiseDims output.d = [indices.d[0], ... , indices.d[q-1], data.d[nbElementwiseDims + indices.d[q-1] + q], data.d[r-1]] Else This is build time error GatherMode::kELEMENT: The output dimensions match the dimensions of the indices tensor. The types of Data and Output must be the same, and Indices shall be DataType::kINT32. How the elements of Data are gathered depends on the mode: GatherMode::kDEFAULT: Each index in indices is used to index Data along axis gatherAxis. GatherMode::kND: Indices is a rank q integer tensor, best thought of as a rank (q-1) tensor of indices into data, where each element defines a slice of data The operation can be formulated as output[i_1, ..., i_{q-1}] = data[indices[i_1, ..., i_{q-1}]] GatherMode::kELEMENT: Here "axis" denotes the result of getGatherAxis(). For each element X of indices: Let J denote a sequence for the subscripts of X Let K = sequence J with element [axis] replaced by X output[J] = data[K] The handling of nbElementWiseDims depends on the mode: * GatherMode::kDEFAULT: nbElementWiseDims <= 1. Broadcast is supported across the elementwise dimension if present. * GatherMode::kND: 0 <= nbElementWiseDims < rank(Data)-1. Broadcast is not supported across the elementwise dimensions. * GatherMode::kELEMENT: nbElementWiseDims = 0 Notes: * For modes GatherMode::kND and GatherMode::kELEMENT, the first nbElementWiseDims dimensions of data and index must be equal. If not, an error will be reported at build time or run time. * Only mode GatherMode::kDEFAULT supports an implicit batch dimensions or broadcast on the elementwise dimensions. * If an axis of Data has dynamic length, using a negative index for it has undefined behavior. * No DLA support * Zero will be stored for OOB access \warning Do not inherit from this class, as doing so will break forward-compatibility of the API and ABI.

Nested Class Summary

Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator, Pointer.ReferenceCounter

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
IGatherLayer(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
int	getGatherAxis() \brief Get the axis to gather on.
nvinfer.GatherMode	getMode() \brief Get the gather mode.
int	getNbElementWiseDims() \brief Get the number of leading dimensions of indices tensor to be handled elementwise.
void	setGatherAxis(int axis) \brief Set the axis used by GatherMode::kELEMENTS and GatherMode::kDEFAULT The axis must be less than the number of dimensions in the data input.
void	setMode(int mode)
void	setMode(nvinfer.GatherMode mode) \brief Set the gather mode.
void	setNbElementWiseDims(int elementWiseDims) \brief Set the number of leading dimensions of indices tensor to be handled elementwise.

Methods inherited from class org.bytedeco.tensorrt.nvinfer.ILayer

getInput, getMetadata, getName, getNbInputs, getNbOutputs, getOutput, getOutputType, getPrecision, getType, outputTypeIsSet, precisionIsSet, resetOutputType, resetPrecision, setInput, setMetadata, setMetadata, setName, setName, setOutputType, setOutputType, setPrecision, setPrecision

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asBuffer, asByteBuffer, availablePhysicalBytes, calloc, capacity, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, formatBytes, free, getDirectBufferAddress, getPointer, getPointer, getPointer, getPointer, hashCode, interruptDeallocatorThread, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetAddress, offsetof, offsetof, parseBytes, physicalBytes, physicalBytesInaccurate, position, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, sizeof, toString, totalBytes, totalCount, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

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

Constructor Detail

IGatherLayer

public IGatherLayer(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

Method Detail

setGatherAxis

@NoException(value=true)
public void setGatherAxis(int axis)

\brief Set the axis used by GatherMode::kELEMENTS and GatherMode::kDEFAULT The axis must be less than the number of dimensions in the data input. The axis defaults to 0. \warning Undefined behavior when used with GatherMode::kND.

See Also:

getGatherAxis()

getGatherAxis

@NoException(value=true)
public int getGatherAxis()

\brief Get the axis to gather on. \warning Undefined behavior when used with GatherMode::kND.

See Also:

setGatherAxis()

setNbElementWiseDims

@NoException(value=true)
public void setNbElementWiseDims(int elementWiseDims)

\brief Set the number of leading dimensions of indices tensor to be handled elementwise. The gathering of indexing starts from the dimension of data[NbElementWiseDims:]. The NbElementWiseDims must be less than the Rank of the data input.

Parameters:

elementWiseDims - number of dims to be handled as elementwise. Default: 0 The value of nbElementWiseDims and GatherMode are checked during network validation: GatherMode::kDEFAULT: nbElementWiseDims must be 0 if there is an implicit batch dimension. It can be 0 or 1 if there is not an implicit batch dimension. GatherMode::kND: nbElementWiseDims can be between 0 and one less than rank(data). GatherMode::kELEMENT: nbElementWiseDims must be 0

See Also:

getNbElementWiseDims()

getNbElementWiseDims

@NoException(value=true)
public int getNbElementWiseDims()

\brief Get the number of leading dimensions of indices tensor to be handled elementwise.

See Also:

setNbElementWiseDims()

setMode

@NoException(value=true)
public void setMode(nvinfer.GatherMode mode)

\brief Set the gather mode.

See Also:

getMode()

setMode

@NoException(value=true)
public void setMode(@Cast(value="nvinfer1::GatherMode")
                                             int mode)

getMode

@NoException(value=true)
public nvinfer.GatherMode getMode()

\brief Get the gather mode.

See Also:

setMode()