A high-performance general-purpose compute library

Join up to 4 arrays along specified dimension. More...

Functions

AFAPI array join (const int dim, const array &first, const array &second)
 Join 2 arrays along dim.
 
AFAPI array join (const int dim, const array &first, const array &second, const array &third)
 Join 3 arrays along dim.
 
AFAPI array join (const int dim, const array &first, const array &second, const array &third, const array &fourth)
 Join 4 arrays along dim.
 
AFAPI af_err af_join (af_array *out, const int dim, const af_array first, const af_array second)
 Join 2 arrays along dim.
 
AFAPI af_err af_join_many (af_array *out, const int dim, const unsigned n_arrays, const af_array *inputs)
 Join many arrays along dim.
 

Detailed Description

Join up to 4 arrays along specified dimension.

Requires that all dimensions except the join dimension must be the same for all arrays.


Function Documentation

◆ af_join()

AFAPI af_err af_join ( af_array out,
const int  dim,
const af_array  first,
const af_array  second 
)

Join 2 arrays along dim.

Parameters
[out]outis the generated array
[in]dimis the dimension along which join occurs
[in]firstis the first input array
[in]secondis the second input array
Note
empty arrays will be ignored

◆ af_join_many()

AFAPI af_err af_join_many ( af_array out,
const int  dim,
const unsigned  n_arrays,
const af_array inputs 
)

Join many arrays along dim.

Current limit is set to 10 arrays.

Parameters
[out]outis the generated array
[in]dimis the dimension along which join occurs
[in]n_arraysnumber of arrays to join
[in]inputsis an array of af_arrays containing handles to the arrays to be joined
Note
empty arrays will be ignored

◆ join() [1/3]

AFAPI array join ( const int  dim,
const array first,
const array second 
)

Join 2 arrays along dim.

Parameters
[in]dimis the dimension along which join occurs
[in]firstis the first input array
[in]secondis the second input array
Returns
the array that joins input arrays along the given dimension
Note
empty arrays will be ignored

◆ join() [2/3]

AFAPI array join ( const int  dim,
const array first,
const array second,
const array third 
)

Join 3 arrays along dim.

Parameters
[in]dimis the dimension along which join occurs
[in]firstis the first input array
[in]secondis the second input array
[in]thirdis the third input array
Returns
the array that joins input arrays along the given dimension
Note
empty arrays will be ignored

◆ join() [3/3]

AFAPI array join ( const int  dim,
const array first,
const array second,
const array third,
const array fourth 
)

Join 4 arrays along dim.

Parameters
[in]dimis the dimension along which join occurs
[in]firstis the first input array
[in]secondis the second input array
[in]thirdis the third input array
[in]fourthis the fourth input array
Returns
the array that joins input arrays along the given dimension
Note
empty arrays will be ignored