Developer Reference for Intel® oneAPI Math Kernel Library for Fortran

ID 766686
Date 3/22/2024
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_df.f90

Input Parameters

Name

Type

Description

task

TYPE(DF_TASK)

Descriptor of the task.

method

INTEGER

Search method. The supported value is DF_METHOD_STD.

nsite

INTEGER

Number of interpolation sites.

site

REAL(KIND=4) DIMENSION(*) for dfssearchcells1d/dfssearchcellsex1d

REAL(KIND=8) DIMENSION(*) 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

INTEGER

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

REAL(KIND=4) DIMENSION(*) for dfssearchcells1d/dfssearchcellsex1d

REAL(KIND=8) DIMENSION(*) 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

INTEGER

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

INTEGER DIMENSION(*)

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

INTEGER

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

INTEGER DIMENSION(*)

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.