NVIDIA NvNeural SDK  2022.2
GPU inference framework for NVIDIA Nsight Deep Learning Designer
nvneural::IConcatenationLayer Class Referenceabstract

IConcatenationLayer is an optional interface implemented by layers that marks them as concatenation layers. More...

#include <nvneural/LayerTypes.h>

Inheritance diagram for nvneural::IConcatenationLayer:
nvneural::IRefObject nvneural::IConcatenationLayer2

Public Member Functions

virtual bool inputSupportsElision (size_t inputIndex, std::size_t *pElisionOffsetOut) const noexcept=0
 If this layer supports elision, it calculates the appropriate offset for a given input. More...
 
- Public Member Functions inherited from nvneural::IRefObject
virtual RefCount addRef () const noexcept=0
 Increments the object's reference count. More...
 
virtual const void * queryInterface (TypeId interface) const noexcept=0
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
virtual void * queryInterface (TypeId interface) noexcept=0
 Retrieves a new object interface pointer. More...
 
virtual RefCount release () const noexcept=0
 Decrements the object's reference count and destroy the object if the reference count reaches zero. More...
 

Static Public Attributes

static const IRefObject::TypeId typeID = 0xe4924aa3178a6e9ful
 Interface TypeId for InterfaceOf purposes.
 
- Static Public Attributes inherited from nvneural::IRefObject
static const TypeId typeID = 0x14ecc3f9de638e1dul
 Interface TypeId for InterfaceOf purposes.
 

Additional Inherited Members

- Public Types inherited from nvneural::IRefObject
using RefCount = std::uint32_t
 Typedef used to track the number of active references to an object.
 
using TypeId = std::uint64_t
 Every interface must define a unique TypeId. This should be randomized.
 
- Protected Member Functions inherited from nvneural::IRefObject
virtual ~IRefObject ()=default
 A protected destructor prevents accidental stack-allocation of IRefObjects or use with other smart pointer classes like std::unique_ptr.
 

Detailed Description

IConcatenationLayer is an optional interface implemented by layers that marks them as concatenation layers.

Networks treat concatenation layers as special cases, and may (if the backend supports it) do concatenation "inline" with targeted writes rather than directly evaluating the layer.

Member Function Documentation

◆ inputSupportsElision()

virtual bool nvneural::IConcatenationLayer::inputSupportsElision ( size_t  inputIndex,
std::size_t *  pElisionOffsetOut 
) const
pure virtualnoexcept

If this layer supports elision, it calculates the appropriate offset for a given input.

Parameters
inputIndexInput layer index, same index used in input layer functions (getInputLayers, setInputLayer)
pElisionOffsetOutOutput calculated offset, pass nullptr to ignore offset calculation
Returns
whether the layer can support elision successfully
Deprecated:
The interface is no longer called, and implementations may return false under all circumstances.

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