TensorRT  8.0.2
nvinfer1::ILoop Class Reference

#include <NvInfer.h>

Inheritance diagram for nvinfer1::ILoop:
nvinfer1::INoCopy

Public Member Functions

IRecurrenceLayeraddRecurrence (ITensor &initialValue) noexcept
 Create a recurrence layer for this loop with initialValue as its first input. More...
 
ITripLimitLayeraddTripLimit (ITensor &tensor, TripLimit limit) noexcept
 Add a trip-count limiter, based on the given tensor. More...
 
IIteratorLayeraddIterator (ITensor &tensor, int32_t axis=0, bool reverse=false) noexcept
 Return layer that subscripts tensor by loop iteration. More...
 
ILoopOutputLayeraddLoopOutput (ITensor &tensor, LoopOutput outputKind, int32_t axis=0) noexcept
 Make an output for this loop, based on the given tensor. More...
 
void setName (const char *name) noexcept
 Set the name of the loop. More...
 
const char * getName () const noexcept
 Return the name of the loop. More...
 

Protected Attributes

apiv::VLoopmImpl
 

Additional Inherited Members

- Protected Member Functions inherited from nvinfer1::INoCopy
 INoCopy (const INoCopy &other)=delete
 
INoCopyoperator= (const INoCopy &other)=delete
 
 INoCopy (INoCopy &&other)=delete
 
INoCopyoperator= (INoCopy &&other)=delete
 

Detailed Description

Helper for creating a recurrent subgraph.

An ILoop cannot be added to an INetworkDefinition where hasImplicitBatchDimensions() returns true.

Member Function Documentation

◆ addIterator()

IIteratorLayer* nvinfer1::ILoop::addIterator ( ITensor tensor,
int32_t  axis = 0,
bool  reverse = false 
)
inlinenoexcept

Return layer that subscripts tensor by loop iteration.

For reverse=false, this is equivalent to addGather(tensor, I, 0) where I is a scalar tensor containing the loop iteration number. For reverse=true, this is equivalent to addGather(tensor, M-1-I, 0) where M is the trip count computed from TripLimits of kind kCOUNT.

◆ addLoopOutput()

ILoopOutputLayer* nvinfer1::ILoop::addLoopOutput ( ITensor tensor,
LoopOutput  outputKind,
int32_t  axis = 0 
)
inlinenoexcept

Make an output for this loop, based on the given tensor.

axis is the axis for concatenation (if using outputKind of kCONCATENATE or kREVERSE).

If outputKind is kCONCATENATE or kREVERSE, a second input specifying the concatenation dimension must be added via method ILoopOutputLayer::setInput.

◆ addRecurrence()

IRecurrenceLayer* nvinfer1::ILoop::addRecurrence ( ITensor initialValue)
inlinenoexcept

Create a recurrence layer for this loop with initialValue as its first input.

IRecurrenceLayer requires exactly two inputs. The 2nd input must be added, via method IRecurrenceLayer::setInput(1,...) before an Engine can be built.

◆ addTripLimit()

ITripLimitLayer* nvinfer1::ILoop::addTripLimit ( ITensor tensor,
TripLimit  limit 
)
inlinenoexcept

Add a trip-count limiter, based on the given tensor.

There may be at most one kCOUNT and one kWHILE limiter for a loop. When both trip limits exist, the loop exits when the count is reached or condition is falsified. It is an error to not add at least one trip limiter.

For kCOUNT, the input tensor must be available before the loop starts.

For kWHILE, the input tensor must be the output of a subgraph that contains only layers that are not ITripLimitLayer, IIteratorLayer or ILoopOutputLayer. Any IRecurrenceLayers in the subgraph must belong to the same loop as the ITripLimitLayer. A trivial example of this rule is that the input to the kWHILE is the output of an IRecurrenceLayer for the same loop.

◆ getName()

const char* nvinfer1::ILoop::getName ( ) const
inlinenoexcept

Return the name of the loop.

See also
setName()

◆ setName()

void nvinfer1::ILoop::setName ( const char *  name)
inlinenoexcept

Set the name of the loop.

The name is used in error diagnostics. This method copies the name string.

See also
getName()

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