bypass - 2024.1 English

AI Engine Kernel and Graph Programming Guide (UG1079)

Document ID
Release Date
2024.1 English

This class is a control flow encapsulator with data bypass. It wraps around an individual node or subgraph to create a bypass data path based on a dynamic control condition. The dynamic control is coded as a runtime parameter port bp (with integer value 0 or 1) that controls whether the input buffer (or stream) data will flow into the kernel encapsulated by the bypass (bp=0) or whether it will be directly bypassed into the output buffer (or stream) (bp=1).


bypass objects can be declared in class scope as member variables in a user-defined graph type (i.e., inside a class that inherits from graph).

bypass objects must be initialized by assignment in the graph constructor.

Member Functions

static bypass & create( kernel );

The static create method creates a bypass object around a given kernel object. The number of inputs and outputs of the bypass are inferred automatically from the corresponding ports of the kernel.