create_funct_1d_pairsπ
Short descriptionπ
create_funct_1d_pairs β Create a function from a set of (x,y) pairs.
Signatureπ
create_funct_1d_pairs( number XValues, number YValues, out function_1d Function )
Descriptionπ
create_funct_1d_pairs creates a one-dimensional function
from a set of pairs of (x,y) values. The XValues of the
functions have to be passed in ascending order. The resulting
function can then be processed and analyzed with the operators for
1d functions.
The created function is composed like this:
\(\textrm{Function} = [1, x_{1}, y_{1}, x_{2}, y_{2}, ... , x_{n}, y_{n}]\)
where
\(\textrm{Function}[1] = 1\) denotes the function type as a one-dimensional function from a set of pairs and
\([x_{i}, y_{i}]\)
are pairs of (x,y) values passed in XValues and YValues
with \(i \in [1, n]\) .
Alternatively, functions can be created with the operator
create_funct_1d_array. In contrast to this operator,
x values with arbitrary positions can be specified with
create_funct_1d_pairs. Hence, it is the more general
operator. It should be noted, however, that because of this
generality the processing of a function created with
create_funct_1d_pairs cannot be carried out as efficiently
as for equidistant functions. In particular, not all operators
accept such functions. If necessary, a function can be transformed
into an equidistant function with the operator
sample_funct_1d.
Attentionπ
create_funct_1d_pairs examines whether the x values of type
βdoubleβ are ascending. Some other operators apply the same check but use
the type βfloatβ instead of βdoubleβ. If such an operator is called as
successor, it might happen that two consecutive x values seem to be
equal for the βfloatβ variant, although they were ascending in the
βdoubleβ variant. If this happens, an error is thrown.
Execution informationπ
Execution information
-
Multithreading type: reentrant (runs in parallel with non-exclusive operators).
-
Multithreading scope: global (may be called from any thread).
-
Processed without parallelization.
Parametersπ
XValues (input_control) number(-array) β (real / integer)
X value for function points.
YValues (input_control) number(-array) β (real / integer)
Y value for function points.
Function (output_control) function_1d β (real / integer)
Created function.
Combinations with other operatorsπ
Combinations
Possible successors
write_funct_1d, y_range_funct_1d, get_pair_funct_1d
Alternatives
create_funct_1d_array, read_funct_1d
See also
Moduleπ
Foundation