df?EditPtr

Developer Reference for Intel® oneAPI Math Kernel Library for C

Download PDF

ID 766684

Date 11/07/2023

Version

Public

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

Visible to Intel only — GUID: GUID-1F88CF20-5111-4F67-894F-3BE3D73F3422

View Details

df?EditPtr

Modifies a pointer to an array held in a Data Fitting task descriptor.

Syntax

status = dfsEditPtr(task, ptr_attr, ptr)

status = dfdEditPtr(task, ptr_attr, ptr)

Include Files

mkl.h

Input Parameters

Name	Type	Description
task	DFTaskPtr	Descriptor of the task.
ptr_attr	const MKL_INT	The parameter to change. For details, see the Pointer Attribute column in table "Pointers Supported by the df?EditPtr Task Editor".
ptr	const float* for dfsEditPtr const double* for dfdEditPtr	New pointer. For details, see the Purpose column in table "Pointers Supported by the df?EditPtr Task Editor".

Name

Type

Description

task

DFTaskPtr

Descriptor of the task.

ptr_attr

const MKL_INT

The parameter to change. For details, see the Pointer Attribute column in table "Pointers Supported by the df?EditPtr Task Editor".

ptr

const float* for dfsEditPtr

const double* for dfdEditPtr

New pointer. For details, see the Purpose column in table "Pointers Supported by the df?EditPtr Task Editor".

Output Parameters

Name	Type	Description
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

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 df?EditPtr editor replaces the pointer of type ptr_attr stored in a Data Fitting task descriptor with a new pointer ptr. The table below describes types of pointers supported by the editor:

Pointers Supported by the df?EditPtr Task Editor
Pointer Attribute	Purpose
DF_X	Partition x of the interpolation interval, an array of strictly sorted breakpoints. CAUTION: The array must be strictly sorted. If it is unordered, the results of data fitting routines are not correct.
DF_Y	Vector-valued function y
DF_IC	Internal conditions for spline construction. For details, see table "Internal Conditions Supported by Data Fitting Functions".
DF_BC	Boundary conditions for spline construction. For details, see table "Boundary Conditions Supported by Data Fitting Functions".
DF_PP_SCOEFF	Spline coefficients

You can use df?EditPtr to modify different types of pointers including pointers to the vector-valued function and spline coefficients stored in contiguous memory. Use the df?EditIdxPtr editor if you need to modify pointers to coordinates of the vector-valued function or spline coefficients stored at non-contiguous memory locations.

If you modify a partition of the interpolation interval, then you should call the dfiEditVal task editor with the corresponding value of DF_XHINT, even if the structure of the partition remains the same.

If you pass a NULL pointer to the df?EditPtr task editor, the task remains unchanged and the routine returns an error code. For the predefined error codes, please see "Task Status and Error Reporting".

NOTE:

You must preserve the arrays x (breakpoints), y (vector-valued functions), bc (boundary conditions), ic (internal conditions), and scoeff (spline coefficients) through the entire workflow of the Data Fitting computations which use those arrays, as the task stores the addresses of the arrays for spline-based computations.

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?EditPtr

Syntax

Include Files

Input Parameters

Output Parameters

Description