Forum
Login
Register

Welcome to our Support Center
UpdatedOctober 29, 2025

OptionalGetElement

Description

If the input is a tensor or sequence type, it returns the input. If the input is an optional type, it outputs the element in the input. It is an error if the input is an empty optional-type (i.e. does not have an element) and the behavior is undefined in this case.

 

Input parameters

 

specified_outputs_name :Β array, this parameter lets you manually assign custom names to the output tensors of a node.
Β input (optional, heterogeneous) – O : object, the optional input.

Β Parameters :Β cluster,

Β training?Β :Β boolean, whether the layer is in training mode (can store data for backward).
Default value β€œTrue”.
Β lda coeff :Β float, defines the coefficient by which the loss derivative will be multiplied before being sent to the previous layer (since during the backward run we go backwards).
Default value β€œ1”.

Β name (optional) :Β string, name of the node.

Output parameters

 

Β output (heterogeneous) – V : object, output element in the optional input.

Type Constraints

O in (optional(seq(tensor(bool))),Β optional(seq(tensor(complex128))),Β optional(seq(tensor(complex64))),
optional(seq(tensor(double))),Β optional(seq(tensor(float))),Β optional(seq(tensor(float16))),Β optional(seq(tensor(int16))),Β optional(seq(tensor(int32))),Β optional(seq(tensor(int64))),Β optional(seq(tensor(int8))),Β optional(seq(tensor(string))),Β optional(seq(tensor(uint16))),Β optional(seq(tensor(uint32))),Β optional(seq(tensor(uint64))),Β optional(seq(tensor(uint8))),Β optional(tensor(bool)),Β optional(tensor(complex128)),Β optional(tensor(complex64)),Β optional(tensor(double)),Β optional(tensor(float)),Β optional(tensor(float16)),Β optional(tensor(int16)),Β optional(tensor(int32)),Β optional(tensor(int64)),Β optional(tensor(int8)),Β optional(tensor(string)),Β optional(tensor(uint16)),Β optional(tensor(uint32)),Β optional(tensor(uint64)),Β optional(tensor(uint8)),Β seq(tensor(bool)),Β seq(tensor(complex128)),Β seq(tensor(complex64)),Β seq(tensor(double)),Β seq(tensor(float)),Β seq(tensor(float16)),Β seq(tensor(int16)),Β seq(tensor(int32)),Β seq(tensor(int64)),Β seq(tensor(int8)),Β seq(tensor(string)),Β seq(tensor(uint16)),Β seq(tensor(uint32)),Β seq(tensor(uint64)),Β seq(tensor(uint8)),Β tensor(bool),Β tensor(complex128),Β tensor(complex64),Β tensor(double),Β tensor(float),Β tensor(float16),Β tensor(int16),Β tensor(int32),Β tensor(int64),Β tensor(int8),Β tensor(string),Β tensor(uint16),Β tensor(uint32),Β tensor(uint64),Β tensor(uint8)) : Constrain input type to optional tensor and optional sequence types.

V in (seq(tensor(bool)),Β seq(tensor(complex128)),Β seq(tensor(complex64)),Β seq(tensor(double)),Β seq(tensor(float)),
seq(tensor(float16)),Β seq(tensor(int16)),Β seq(tensor(int32)),Β seq(tensor(int64)),Β seq(tensor(int8)),Β seq(tensor(string)),Β seq(tensor(uint16)),Β seq(tensor(uint32)),Β seq(tensor(uint64)),Β seq(tensor(uint8)),Β tensor(bool),Β tensor(complex128),Β tensor(complex64),Β tensor(double),Β tensor(float),Β tensor(float16),Β tensor(int16),Β tensor(int32),Β tensor(int64),Β tensor(int8),Β tensor(string),Β tensor(uint16),Β tensor(uint32),Β tensor(uint64),Β tensor(uint8)) : Constrain output type to all tensor or sequence types.

Example

All these exemples are snippets PNG, you can drop these Snippet onto the block diagram and get the depicted code added to your VI (Do not forget to install Deep Learning library to run it).
Table of Contents