sample_funct_1dT_sample_funct_1dSampleFunct1dSampleFunct1d (Operator)
Name
sample_funct_1dT_sample_funct_1dSampleFunct1dSampleFunct1d — Sample a function equidistantly in an interval.
Signature
void SampleFunct1d(const HTuple& Function, const HTuple& XMin, const HTuple& XMax, const HTuple& XDist, const HTuple& Border, HTuple* SampledFunction)
HFunction1D HFunction1D::SampleFunct1d(const HTuple& XMin, const HTuple& XMax, const HTuple& XDist, const HString& Border) const
HFunction1D HFunction1D::SampleFunct1d(double XMin, double XMax, double XDist, const HString& Border) const
HFunction1D HFunction1D::SampleFunct1d(double XMin, double XMax, double XDist, const char* Border) const
HFunction1D HFunction1D::SampleFunct1d(double XMin, double XMax, double XDist, const wchar_t* Border) const
(Windows only)
static void HOperatorSet.SampleFunct1d(HTuple function, HTuple XMin, HTuple XMax, HTuple XDist, HTuple border, out HTuple sampledFunction)
HFunction1D HFunction1D.SampleFunct1d(HTuple XMin, HTuple XMax, HTuple XDist, string border)
HFunction1D HFunction1D.SampleFunct1d(double XMin, double XMax, double XDist, string border)
Description
sample_funct_1dsample_funct_1dSampleFunct1dSampleFunct1dSampleFunct1d samples the input function FunctionFunctionFunctionFunctionfunction
in the interval [XMinXMinXMinXMinXMin,XMaxXMaxXMaxXMaxXMax] at equidistant points
with the distance XDistXDistXDistXDistXDist. The last point lies in the
interval if XMaxXMaxXMaxXMaxXMax-XMinXMinXMinXMinXMin is not an integer multiple
of XDistXDistXDistXDistXDist. To obtain the samples, the input function is
interpolated linearly. The parameter BorderBorderBorderBorderborder determines the
values of the function FunctionFunctionFunctionFunctionfunction outside of its domain.
For BorderBorderBorderBorderborder='zero'"zero""zero""zero""zero" these values are set to 0, for
BorderBorderBorderBorderborder='constant'"constant""constant""constant""constant" they are set to the
corresponding value at the border, for
BorderBorderBorderBorderborder='mirror'"mirror""mirror""mirror""mirror" they are mirrored at the border,
and for BorderBorderBorderBorderborder='cyclic'"cyclic""cyclic""cyclic""cyclic" they are continued
cyclically.
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
FunctionFunctionFunctionFunctionfunction (input_control) function_1d → HFunction1D, HTupleHTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)
Input function.
XMinXMinXMinXMinXMin (input_control) number → HTupleHTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)
Minimum x value of the output function.
XMaxXMaxXMaxXMaxXMax (input_control) number → HTupleHTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)
Maximum x value of the output function.
Restriction: XMax > XMin
XDistXDistXDistXDistXDist (input_control) number → HTupleHTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)
Distance of the samples.
Restriction: XDist > 0
BorderBorderBorderBorderborder (input_control) string → HTupleHTupleHtuple (string) (string) (HString) (char*)
Border treatment for the input function.
Default value:
'constant'
"constant"
"constant"
"constant"
"constant"
List of values: 'constant'"constant""constant""constant""constant", 'cyclic'"cyclic""cyclic""cyclic""cyclic", 'mirror'"mirror""mirror""mirror""mirror", 'zero'"zero""zero""zero""zero"
SampledFunctionSampledFunctionSampledFunctionSampledFunctionsampledFunction (output_control) function_1d → HFunction1D, HTupleHTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)
Sampled function.
Possible Predecessors
transform_funct_1dtransform_funct_1dTransformFunct1dTransformFunct1dTransformFunct1d,
create_funct_1d_arraycreate_funct_1d_arrayCreateFunct1dArrayCreateFunct1dArrayCreateFunct1dArray,
create_funct_1d_pairscreate_funct_1d_pairsCreateFunct1dPairsCreateFunct1dPairsCreateFunct1dPairs
Module
Foundation