df?QueryIdxPtr

Developer Reference for Intel® oneAPI Math Kernel Library for C

Download PDF

ID 766684

Date 10/31/2024

Version

Public

Visible to Intel only — GUID: GUID-80C3EDE8-D40A-48D2-A3E4-908622A6E88A

View Details

df?QueryIdxPtr

Reads a pointer to the memory representing a coordinate of the data stored in matrix format.

Syntax

status = dfsQueryIdxPtr(task, ptr_attr, idx, ptr)

status = dfdQueryIdxPtr(task, ptr_attr, idx, ptr)

Include Files

mkl.h

Input Parameters

Name	Type	Description
task	DFTaskPtr	Descriptor of the task.
ptr_attr	const MKL_INT	Pointer attribute to query. The parameter takes one of the attributes described in "Data Attributes Supported by the df?EditIdxPtr Task Editor".
idx	const MKL_INT	Index of the coordinate of the pointer to query.

Output Parameters

Name	Type	Description
ptr	float* for dfsQueryIdxPtr double* for dfdQueryIdxPtr	Pointer to the data that holds values of coordinate idx returned. For details, see table "Data Attributes Supported by the df?EditIdxPtr Task Editor".
status	int	Status of the routine: DF_STATUS_OK if the routine execution completed successfully. Non-zero error code otherwise. See "Task Status and Error Reporting" for error code definitions.

Name

Type

Description

ptr

float* for dfsQueryIdxPtr

double* for dfdQueryIdxPtr

Pointer to the data that holds values of coordinate idx returned. For details, see table "Data Attributes Supported by the df?EditIdxPtr Task Editor".

status

int

Status of the routine:

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

Description

The routine returns a pointer to the array that holds the idx coordinate of vector-valued function y or the pointer to the array of spline coefficients corresponding to the given coordinate.

You can use the query routine if you need the pointer to coordinates of the vector-valued function or spline coefficients held at non-contiguous memory locations or at a contiguous memory location in row-major format (the default storage format for spline coefficients).

Before calling this query routine, make sure that you have created and initialized the task using a task creation function or a relevant editor such as the generic or specific df?EditPPSpline1D editor.

When using df?QueryIdxPtr, you might receive an error code in the following cases:

You passed an unsupported parameter value into the editor.
The value of the index exceeds the predefined value that equals the dimension ny of the vector-valued function.
You request the pointer to the idx coordinate of the vector-valued function you provided to contiguous memory in column-major format.

Parent topic: Task Configuration Routines

Select Your Language

Using Intel.com Search

Quick Links

Recent Searches

Advanced Search

Only search in

Developer Reference for Intel® oneAPI Math Kernel Library for C

df?QueryIdxPtr

Syntax

Include Files

Input Parameters

Output Parameters

Description