get_y_value_funct_1dT_get_y_value_funct_1dGetYValueFunct1dGetYValueFunct1dget_y_value_funct_1d (Operator)
Name
get_y_value_funct_1dT_get_y_value_funct_1dGetYValueFunct1dGetYValueFunct1dget_y_value_funct_1d — Return the value of a function at an arbitrary position.
Signature
Herror T_get_y_value_funct_1d(const Htuple Function, const Htuple X, const Htuple Border, Htuple* Y)
def get_y_value_funct_1d(function: Sequence[Union[float, int]], x: MaybeSequence[float], border: str) -> Sequence[float]
def get_y_value_funct_1d_s(function: Sequence[Union[float, int]], x: MaybeSequence[float], border: str) -> float
Description
get_y_value_funct_1dget_y_value_funct_1dGetYValueFunct1dGetYValueFunct1dGetYValueFunct1dget_y_value_funct_1d returns the y value of the function
FunctionFunctionFunctionFunctionfunctionfunction at the x coordinates specified by XXXXxx.
To obtain the y values, the input function is
interpolated linearly. The parameter BorderBorderBorderBorderborderborder determines the
values of the function FunctionFunctionFunctionFunctionfunctionfunction outside of its domain.
For BorderBorderBorderBorderborderborder='zero'"zero""zero""zero""zero""zero" these values are set to 0, for
BorderBorderBorderBorderborderborder='constant'"constant""constant""constant""constant""constant" they are set to the
corresponding value at the border, for
BorderBorderBorderBorderborderborder='mirror'"mirror""mirror""mirror""mirror""mirror" they are mirrored at the border,
for BorderBorderBorderBorderborderborder='cyclic'"cyclic""cyclic""cyclic""cyclic""cyclic" they are continued
cyclically, and for BorderBorderBorderBorderborderborder='error'"error""error""error""error""error" an
exception is raised.
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
FunctionFunctionFunctionFunctionfunctionfunction (input_control) function_1d → HFunction1D, HTupleSequence[Union[float, int]]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)
Input function.
XXXXxx (input_control) number(-array) → HTupleMaybeSequence[float]HTupleHtuple (real) (double) (double) (double)
X coordinate at which the function should be
evaluated.
BorderBorderBorderBorderborderborder (input_control) string → HTuplestrHTupleHtuple (string) (string) (HString) (char*)
Border treatment for the input function.
Default value:
'constant'
"constant"
"constant"
"constant"
"constant"
"constant"
List of values: 'constant'"constant""constant""constant""constant""constant", 'cyclic'"cyclic""cyclic""cyclic""cyclic""cyclic", 'error'"error""error""error""error""error", 'mirror'"mirror""mirror""mirror""mirror""mirror", 'zero'"zero""zero""zero""zero""zero"
YYYYyy (output_control) number(-array) → HTupleSequence[float]HTupleHtuple (real) (double) (double) (double)
Y value at the given x value.
Possible Predecessors
create_funct_1d_pairscreate_funct_1d_pairsCreateFunct1dPairsCreateFunct1dPairsCreateFunct1dPairscreate_funct_1d_pairs,
create_funct_1d_arraycreate_funct_1d_arrayCreateFunct1dArrayCreateFunct1dArrayCreateFunct1dArraycreate_funct_1d_array
Module
Foundation