TensorRT  7.2.2.3
nvinfer1::IShuffleLayer Class Referenceabstract

Layer type for shuffling data. More...

#include <NvInfer.h>

Inheritance diagram for nvinfer1::IShuffleLayer:
nvinfer1::ILayer

Public Member Functions

virtual void setFirstTranspose (Permutation permutation)=0
 Set the permutation applied by the first transpose operation. More...
 
virtual Permutation getFirstTranspose () const =0
 Get the permutation applied by the first transpose operation. More...
 
virtual void setReshapeDimensions (Dims dimensions)=0
 Set the reshaped dimensions. More...
 
virtual Dims getReshapeDimensions () const =0
 Get the reshaped dimensions. More...
 
void setInput (int32_t index, ITensor &tensor) _TENSORRT_OVERRIDE=0
 Append or replace an input of this layer with a specific tensor. More...
 
virtual void setSecondTranspose (Permutation permutation)=0
 Set the permutation applied by the second transpose operation. More...
 
virtual Permutation getSecondTranspose () const =0
 Get the permutation applied by the second transpose operation. More...
 
virtual void setZeroIsPlaceholder (bool zeroIsPlaceholder)=0
 Set meaning of 0 in reshape dimensions. More...
 
virtual bool getZeroIsPlaceholder () const =0
 Get meaning of 0 in reshape dimensions. More...
 
- Public Member Functions inherited from nvinfer1::ILayer
virtual LayerType getType () const =0
 Return the type of a layer. More...
 
virtual void setName (const char *name)=0
 Set the name of a layer. More...
 
virtual const char * getName () const =0
 Return the name of a layer. More...
 
virtual int32_t getNbInputs () const =0
 Get the number of inputs of a layer.
 
virtual ITensorgetInput (int32_t index) const =0
 Get the layer input corresponding to the given index. More...
 
virtual int32_t getNbOutputs () const =0
 Get the number of outputs of a layer.
 
virtual ITensorgetOutput (int32_t index) const =0
 Get the layer output corresponding to the given index. More...
 
virtual void setPrecision (DataType dataType)=0
 Set the computational precision of this layer. More...
 
virtual DataType getPrecision () const =0
 get the computational precision of this layer More...
 
virtual bool precisionIsSet () const =0
 whether the computational precision has been set for this layer More...
 
virtual void resetPrecision ()=0
 reset the computational precision for this layer More...
 
virtual void setOutputType (int32_t index, DataType dataType)=0
 Set the output type of this layer. More...
 
virtual DataType getOutputType (int32_t index) const =0
 get the output type of this layer More...
 
virtual bool outputTypeIsSet (int32_t index) const =0
 whether the output type has been set for this layer More...
 
virtual void resetOutputType (int32_t index)=0
 reset the output type for this layer More...
 

Detailed Description

Layer type for shuffling data.

This class shuffles data by applying in sequence: a transpose operation, a reshape operation and a second transpose operation. The dimension types of the output are those of the reshape dimension.

The layer has an optional second input. If present, it must be a 1D Int32 shape tensor, and the reshape dimensions are taken from it.

Warning
Do not inherit from this class, as doing so will break forward-compatibility of the API and ABI.

Member Function Documentation

◆ getFirstTranspose()

virtual Permutation nvinfer1::IShuffleLayer::getFirstTranspose ( ) const
pure virtual

Get the permutation applied by the first transpose operation.

Returns
The dimension permutation applied before the reshape.
See also
setFirstTranspose

◆ getReshapeDimensions()

virtual Dims nvinfer1::IShuffleLayer::getReshapeDimensions ( ) const
pure virtual

Get the reshaped dimensions.

Returns
The reshaped dimensions.

If a second input is present and non-null, or setReshapeDimensions has not yet been called, this function returns Dims with nbDims == -1.

◆ getSecondTranspose()

virtual Permutation nvinfer1::IShuffleLayer::getSecondTranspose ( ) const
pure virtual

Get the permutation applied by the second transpose operation.

Returns
The dimension permutation applied after the reshape.
See also
setSecondTranspose

◆ getZeroIsPlaceholder()

virtual bool nvinfer1::IShuffleLayer::getZeroIsPlaceholder ( ) const
pure virtual

Get meaning of 0 in reshape dimensions.

Returns
true if 0 is placeholder for corresponding input dimension, false if 0 denotes a zero-length dimension.
See also
setZeroIsPlaceholder

◆ setFirstTranspose()

virtual void nvinfer1::IShuffleLayer::setFirstTranspose ( Permutation  permutation)
pure virtual

Set the permutation applied by the first transpose operation.

Parameters
permutationThe dimension permutation applied before the reshape.

The default is the identity permutation.

See also
getFirstTranspose

◆ setInput()

void nvinfer1::IShuffleLayer::setInput ( int32_t  index,
ITensor tensor 
)
pure virtual

Append or replace an input of this layer with a specific tensor.

Parameters
indexthe index of the input to modify.
tensorthe new input tensor Sets the input tensor for the given index. The index must be 0 for a static shuffle layer. A static shuffle layer is converted to a dynamic shuffle layer by calling setInput with an index 1. A dynamic shuffle layer cannot be converted back to a static shuffle layer.

For a dynamic shuffle layer, the values 0 and 1 are valid. The indices in the dynamic case are as follows:

  • 0: Data or Shape tensor to be shuffled.
  • 1: The dimensions for the reshape operation, as a 1D Int32 shape tensor.

If this function is called with a value 1, then the function getNbInputs() changes from returning 1 to 2.

Implements nvinfer1::ILayer.

◆ setReshapeDimensions()

virtual void nvinfer1::IShuffleLayer::setReshapeDimensions ( Dims  dimensions)
pure virtual

Set the reshaped dimensions.

Parameters
dimensionsThe reshaped dimensions.

Two special values can be used as dimensions.

Value 0 copies the corresponding dimension from input. This special value can be used more than once in the dimensions. If number of reshape dimensions is less than input, 0s are resolved by aligning the most significant dimensions of input.

Value -1 infers that particular dimension by looking at input and rest of the reshape dimensions. Note that only a maximum of one dimension is permitted to be specified as -1.

The product of the new dimensions must be equal to the product of the old.

If the second input is set, it is reset to null.

◆ setSecondTranspose()

virtual void nvinfer1::IShuffleLayer::setSecondTranspose ( Permutation  permutation)
pure virtual

Set the permutation applied by the second transpose operation.

Parameters
permutationThe dimension permutation applied after the reshape.

The default is the identity permutation.

The permutation is applied as outputDimensionIndex = permutation.order[inputDimensionIndex], so to permute from CHW order to HWC order, the required permutation is [1, 2, 0].

See also
getSecondTranspose

◆ setZeroIsPlaceholder()

virtual void nvinfer1::IShuffleLayer::setZeroIsPlaceholder ( bool  zeroIsPlaceholder)
pure virtual

Set meaning of 0 in reshape dimensions.

If true, then a 0 in the reshape dimensions denotes copying the corresponding dimension from the first input tensor. If false, then a 0 in the reshape dimensions denotes a zero-length dimension.

Default: true

See also
getZeroIsPlaceholder();

The documentation for this class was generated from the following file: