Utility functions to create objects of type af_index_t. More...

Functions

AFAPI af_err af_create_indexers (af_index_t **indexers)
 Create an quadruple of af_index_t array. More...
 
AFAPI af_err af_set_array_indexer (af_index_t *indexer, const af_array idx, const dim_t dim)
 set dim to given indexer af_array idx More...
 
AFAPI af_err af_set_seq_indexer (af_index_t *indexer, const af_seq *idx, const dim_t dim, const bool is_batch)
 set dim to given indexer af_array idx More...
 
AFAPI af_err af_set_seq_param_indexer (af_index_t *indexer, const double begin, const double end, const double step, const dim_t dim, const bool is_batch)
 set dim to given indexer af_array idx More...
 
AFAPI af_err af_release_indexers (af_index_t *indexers)
 Release's the memory resource used by the quadruple af_index_t array. More...
 

Detailed Description

Utility functions to create objects of type af_index_t.

Function Documentation

AFAPI af_err af_create_indexers ( af_index_t **  indexers)

Create an quadruple of af_index_t array.

Parameters
[out]indexerspointer to location where quadruple af_index_t array is created
Returns
af_err error code
AFAPI af_err af_release_indexers ( af_index_t indexers)

Release's the memory resource used by the quadruple af_index_t array.

Parameters
[in]indexersis pointer to location where quadruple af_index_t array is created
AFAPI af_err af_set_array_indexer ( af_index_t indexer,
const af_array  idx,
const dim_t  dim 
)

set dim to given indexer af_array idx

Parameters
[in]indexerpointer to location where quadruple af_index_t array was created
[in]idxis the af_array indexer for given dimension dim
[in]dimis the dimension to be indexed
Returns
af_err error code
AFAPI af_err af_set_seq_indexer ( af_index_t indexer,
const af_seq idx,
const dim_t  dim,
const bool  is_batch 
)

set dim to given indexer af_array idx

Parameters
[in]indexerpointer to location where quadruple af_index_t array was created
[in]idxis the af_seq indexer for given dimension dim
[in]dimis the dimension to be indexed
[in]is_batchindicates if the sequence based indexing is inside a batch operation
AFAPI af_err af_set_seq_param_indexer ( af_index_t indexer,
const double  begin,
const double  end,
const double  step,
const dim_t  dim,
const bool  is_batch 
)

set dim to given indexer af_array idx

Parameters
[in]indexerpointer to location where quadruple af_index_t array was created
[in]beginis the beginning index of along dimension dim
[in]endis the beginning index of along dimension dim
[in]stepsize along dimension dim
[in]dimis the dimension to be indexed
[in]is_batchindicates if the sequence based indexing is inside a batch operation
Returns
af_err error code