A high-performance general-purpose compute library

Scan an array (generalized) over a given dimension. More...

Functions

AFAPI array scan (const array &in, const int dim=0, binaryOp op=AF_BINARY_ADD, bool inclusive_scan=true)
 C++ Interface to scan an array (generalized) over a given dimension. More...
 
AFAPI af_err af_scan (af_array *out, const af_array in, const int dim, af_binary_op op, bool inclusive_scan)
 C Interface to scan an array (generalized) over a given dimension. More...
 

Detailed Description

Scan an array (generalized) over a given dimension.

Perform inclusive or exclusive scan using a given binary operation along a given dimension.

Binary operations can be add, mul, min, max as defined by af_binary_op.

Function Documentation

◆ af_scan()

AFAPI af_err af_scan ( af_array out,
const af_array  in,
const int  dim,
af_binary_op  op,
bool  inclusive_scan 
)

C Interface to scan an array (generalized) over a given dimension.

Parameters
[out]outscan
[in]ininput array
[in]dimdimension along which the scan occurs
[in]optype of binary operation used
[in]inclusive_scanflag specifying whether the scan is inclusive
Returns
AF_SUCCESS, if function returns successfully, else an af_err code is given

◆ scan()

AFAPI array scan ( const array in,
const int  dim = 0,
binaryOp  op = AF_BINARY_ADD,
bool  inclusive_scan = true 
)

C++ Interface to scan an array (generalized) over a given dimension.

Parameters
[in]ininput array
[in]dimdimension along which the scan occurs, 0 denotes the first non-singleton dimension
[in]optype of binary operation used
[in]inclusive_scanflag specifying whether the scan is inclusive
Returns
scan
Examples
helloworld/helloworld.cpp.