Back to FabImage Library websiteYou are here:
Start »
Function Reference »
Array Basics »
SkipShortArray
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: | fil |
If the input array has enough elements, then it is copied to the output; otherwise Nil is returned.
Syntax
void fil::SkipShortArray
(
const ftl::Array<Type>& inArray,
int inMinSize,
ftl::Conditional<ftl::Array<Type> >& outBigEnoughArray,
bool& outIsBigEnough
)
Parameters
|
Name |
Type |
Range |
Default |
Description |
 |
inArray |
const Array<Type>& |
|
|
Array that may have too few elements |
 |
inMinSize |
int |
0 -  |
2 |
Minimum number of elements |
 |
outBigEnoughArray |
Conditional<Array<Type> >& |
|
|
Array with at least inMinSize elements, or Nil |
 |
outIsBigEnough |
bool& |
|
|
|
Errors
List of possible exceptions:
Error type |
Description |
DomainError |
inMinSize must be greater or equal 0 in SkipShortArray. |