get_y_value_funct_1dget_y_value_funct_1dGetYValueFunct1dGetYValueFunct1dget_y_value_funct_1dT_get_y_value_funct_1d
Short description
get_y_value_funct_1dget_y_value_funct_1dGetYValueFunct1dGetYValueFunct1dget_y_value_funct_1dT_get_y_value_funct_1d — Return the value of a function at an arbitrary position.
Signature
get_y_value_funct_1d( function_1d Function, number X, string Border, out number Y )get_y_value_funct_1d( : : Function, X, Border : Y )void GetYValueFunct1d( const HTuple& Function, const HTuple& X, const HTuple& Border, HTuple* Y )static void HOperatorSet.GetYValueFunct1d( HTuple function, HTuple x, HTuple border, out 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 ) -> floatHerror T_get_y_value_funct_1d( const Htuple Function, const Htuple X, const Htuple Border, Htuple* Y )
HTuple HFunction1D::GetYValueFunct1d( const HTuple& X, const HString& Border ) const
double HFunction1D::GetYValueFunct1d( double X, const HString& Border ) const
double HFunction1D::GetYValueFunct1d( double X, const char* Border ) const
double HFunction1D::GetYValueFunct1d( double X, const wchar_t* Border ) const (Windows only)
HTuple HFunction1D.GetYValueFunct1d( HTuple x, string border )
double HFunction1D.GetYValueFunct1d( double x, string border )
Description
get_y_value_funct_1dGetYValueFunct1d returns the y value of the function
Functionfunctionfunction at the x coordinates specified by Xxx.
To obtain the y values, the input function is
interpolated linearly. The parameter Borderborderborder determines the
values of the function Functionfunctionfunction outside of its domain.
For Borderborderborder='zero'"zero" these values are set to 0, for
Borderborderborder='constant'"constant" they are set to the
corresponding value at the border, for
Borderborderborder='mirror'"mirror" they are mirrored at the border,
for Borderborderborder='cyclic'"cyclic" they are continued
cyclically, and for Borderborderborder='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
Functionfunctionfunction (input_control) function_1d → (real / integer)(real / integer)HTuple (double / Hlong)HFunction1D, HTuple (double / int / long)Sequence[Union[float, int]]Htuple (double / Hlong)
Input function.
Xxx (input_control) number(-array) → (real)(real)HTuple (double)HTuple (double)MaybeSequence[float]Htuple (double)
X coordinate at which the function should be
evaluated.
Borderborderborder (input_control) string → (string)(string)HTuple (HString)HTuple (string)strHtuple (char*)
Border treatment for the input function.
Default: 'constant'"constant"
List of values: 'constant', 'cyclic', 'error', 'mirror', 'zero'"constant", "cyclic", "error", "mirror", "zero"
Yyy (output_control) number(-array) → (real)(real)HTuple (double)HTuple (double)Sequence[float]Htuple (double)
Y value at the given x value.
Combinations with other operators
Combinations
Possible predecessors
create_funct_1d_pairsCreateFunct1dPairs, create_funct_1d_arrayCreateFunct1dArray
Module
Foundation