dfiEditVal

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-72AB178A-8F3C-4604-9768-ED13B648FF9D

View Details

dfiEditVal

Modifies a parameter value in a Data Fitting task descriptor.

Syntax

status = dfiEditVal(task, val_attr, val)

Include Files

mkl.h

Input Parameters

Name	Type	Description
task	DFTaskPtr	Descriptor of the task.
val_attr	const MKL_INT	The parameter to change. See table "Parameters Supported by the dfiEditVal Task Editor".
val	const MKL_INT	A new parameter value. See table "Parameters Supported by the dfiEditVal 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 dfiEditVal task editor replaces the parameter of type val_attr stored in a Data Fitting task descriptor with a new value val. The table below describes valid types of parameter val_attr supported by the editor:

Parameters Supported by the dfiEditVal Task Editor
Parameter Attribute	Purpose
DF_NX	Number of breakpoints
DF_XHINT	A flag describing the structure of partition. See table "Hint Values for Partition x" for the list of available values.
DF_NY	Dimension of the vector-valued function
DF_YHINT	A flag describing the structure of the vector-valued function. See table "Hint Values for Vector Function y" for the list of available values.
DF_SPLINE_ORDER	Spline order. See table "Spline Orders Supported by Data Fitting Functions" for the list of available values.
DF_SPLINE_TYPE	Spline type. See table "Spline Types Supported by Data Fitting Functions" for the list of available values.
DF_BC_TYPE	Type of boundary conditions used in spline construction. See table "Boundary Conditions Supported by Data Fitting Functions" for the list of available values.
DF_IC_TYPE	Type of internal conditions used in spline construction. See table "Internal Conditions Supported by Data Fitting Functions" for the list of available values.
DF_PP_COEFF_HINT	A flag describing the structure of spline coefficients. See table "Hint Values for Spline Coefficients" for the list of available values.
DF_CHECK_FLAG	A flag which controls checking of Data Fitting parameters. See table "Possible Values for the DF_CHECK_FLAG Parameter" for the list of available values.

If you pass a zero value for the parameter describing the size of the arrays that hold coefficients for a partition, a vector-valued function, or a spline, the parameter held in the Data fitting task remains unchanged and the routine returns an error code. For the predefined error codes, see "Task Status and Error Reporting".

Possible Values for the DF_CHECK_FLAG Parameter
Value	Description
DF_ENABLE_CHECK_FLAG	Checks the correctness of parameters of Data Fitting computational routines (default mode).
DF_DISABLE_CHECK_FLAG	Disables checking of the correctness of parameters of Data Fitting computational routines.

Use DF_CHECK_FLAG for val_attr in order to control validation of parameters of Data Fitting computational routines such as df?Construct1D, df?Interpolate1D/df?InterpolateEx1D, and df?SearchCells1D/df?SearchCellsEx1D, which can perform better with a small number of interpolation sites or integration limits (fewer than one dozen). The default mode, with checking of parameters enabled, should be used as you develop a Data Fitting-based application. After you complete development you can disable parameter checking in order to improve the performance of your application.

If you modify the parameter describing dimensions of the arrays that hold the vector-valued function or spline coefficients in contiguous memory, you should call the df?EditPtr task editor with the corresponding pointers to the vector-valued function or spline coefficients even when this pointer remains unchanged. Call the df?EditIdxPtr editor if those arrays are stored in non-contiguous memory locations.

You must call the dfiEditVal task editor to edit the structure of the partition DF_XHINT every time you modify a partition using df?EditPtr, even if the structure of the partition remains the same.

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

dfiEditVal

Syntax

Include Files

Input Parameters

Output Parameters

Description