Developer Reference for Intel® oneAPI Math Kernel Library for C

ID 766684
Date 7/13/2023
Public

A newer version of this document is available. Customers should click here to go to the newest version.

Document Table of Contents

df?SearchCells1D/df?SearchCellsEx1D

Searches sub-intervals containing interpolation sites.

Syntax

status = dfsSearchCells1D(task, method, nsite, site, sitehint, datahint, cell)

status = dfdSearchCells1D(task, method, nsite, site, sitehint, datahint, cell)

status = dfsSearchCellsEx1D(task, method, nsite, site, sitehint, datahint, cell, search_cb, search_params)

status = dfdSearchCellsEx1D(task, method, nsite, site, sitehint, datahint, cell, search_cb, search_params)

Include Files

  • mkl.h

Input Parameters

Name

Type

Description

task

DFTaskPtr

Descriptor of the task.

method

const MKL_INT

Search method. The supported value is DF_METHOD_STD.

nsite

const MKL_INT*

Number of interpolation sites.

site

const float* for dfsSearchCells1D/dfsSearchCellsEx1D

const double* for dfdSearchCells1D/dfdSearchCellsEx1D

Array of interpolation sites of size nsite. The structure of the array is defined by the sitehint parameter:

  • If the sites form a non-uniform partition, the array should contain nsite values.

  • If the sites form a uniform partition, the array should contain two entries that represent the left-most and the right-most interpolation sites. The first entry of the array contains the left-most interpolation point. The second entry of the array contains the right-most interpolation point.

sitehint

const MKL_INT

A flag describing the structure of the interpolation sites. For the list of possible values of sitehint, see table "Hint Values for Interpolation Sites". If you set the flag to DF_NO_HINT, the library interprets the site-defined partition as non-uniform.

datahint

const float* for dfsSearchCells1D/dfsSearchCellsEx1D

const double* for dfdSearchCells1D/dfdSearchCellsEx1D

Array that contains additional information about the structure of the partition and interpolation sites. This data helps to speed up the computation. If you provide a NULL pointer, the routine uses the default settings for computations. For details on the datahint array, see table "Structure of the datahint Array".

search_cb

constdfsSearchCellsCallBack for dfsSearchCellsEx1D

constdfdSearchCellsCallBack for dfdSearchCellsEx1D

User-defined callback function for computing indices of cells that can contain interpolation sites.

Set to NULL if you are not supplying a callback function.

search_params

const void*

Pointer to additional user-defined parameters passed by the library to the search_cb function.

Set to NULL if there are no additional parameters or if you are not supplying a callback function.

Output Parameters

Name

Type

Description

status

int

Status of the routine:

  • DF_STATUS_OK if the routine execution completed successfully.
  • Non-zero error code if the routine execution failed. See "Task Status and Error Reporting" for error code definitions.

cell

MKL_INT*

Array of cell indices in the partition that contain the interpolation sites.

Description

The df?SearchCells1D/df?SearchCellsEx1D routines return array cell of indices of sub-intervals (cells) in the partition that contain interpolation sites available in array site. For details on the cell indexing scheme, see the description of the df?Interpolate1D/df?InterpolateEx1D computation routines.

Use the datahint parameter to provide additional information about the structure of the partition and/or interpolation sites. The definition of the datahint parameter is availalbe in the description of the df?Interpolate1D/df?InterpolateEx1D computation routines.

For description of the user-defined callback for computation of cell indices, see df?SearchCellsCallBack.