Back to Aurora Vision Library website

You are here: Start » Function Reference » All Functions » Array Basics » SkipEmptyArray

SkipEmptyArray


This is Filter Equivalent. This function may be present in generated code, but should not be used in hand-written code.

Header: STD.h
Namespace: avl
Module: FoundationLite

If the input array is not empty, then it is copied to the output; otherwise Nil is returned.

Applications: Secures against domain errors caused by empty arrays, e.g. just before the GetMaximumElement filter is to be invoked.

Syntax

void avl::SkipEmptyArray
(
	const atl::Array<Type>& inArray,
	atl::Conditional<atl::Array<Type> >& outNotEmptyArray,
	bool& outIsNotEmpty
)

Parameters

Name Type Default Description
Input value inArray const Array<Type>& Array that may be empty or not
Output value outNotEmptyArray Conditional<Array<Type> >& Not empty array or Nil
Output value outIsNotEmpty bool&

Remarks

This filter can be replaced with the following formula: