Skip to content

clear_scattered_data_interpolatorClearScatteredDataInterpolatorClearScatteredDataInterpolatorclear_scattered_data_interpolatorT_clear_scattered_data_interpolator🔗

Short description🔗

clear_scattered_data_interpolatorClearScatteredDataInterpolatorClearScatteredDataInterpolatorclear_scattered_data_interpolatorT_clear_scattered_data_interpolator — Clear a scattered data interpolator.

Signature🔗

clear_scattered_data_interpolator( scattered_data_interpolator ScatteredDataInterpolatorHandle )void ClearScatteredDataInterpolator( const HTuple& ScatteredDataInterpolatorHandle )static void HOperatorSet.ClearScatteredDataInterpolator( HTuple scatteredDataInterpolatorHandle )def clear_scattered_data_interpolator( scattered_data_interpolator_handle: MaybeSequence[HHandle] ) -> None

Herror T_clear_scattered_data_interpolator( const Htuple ScatteredDataInterpolatorHandle )

static void HScatteredDataInterpolator::ClearScatteredDataInterpolator( const HScatteredDataInterpolatorArray& ScatteredDataInterpolatorHandle )

void HScatteredDataInterpolator::ClearScatteredDataInterpolator( ) const

static void HScatteredDataInterpolator.ClearScatteredDataInterpolator( HScatteredDataInterpolator[] scatteredDataInterpolatorHandle )

void HScatteredDataInterpolator.ClearScatteredDataInterpolator( )

Description🔗

clear_scattered_data_interpolatorClearScatteredDataInterpolator clears the scattered data interpolator given by ScatteredDataInterpolatorHandlescatteredDataInterpolatorHandlescattered_data_interpolator_handle and frees all memory required for the interpolator. After calling clear_scattered_data_interpolatorClearScatteredDataInterpolator, the scattered data interpolator can no longer be used. The handle ScatteredDataInterpolatorHandlescatteredDataInterpolatorHandlescattered_data_interpolator_handle becomes invalid.

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.

This operator modifies the state of the following input parameter:

During execution of this operator, access to the value of this parameter must be synchronized if it is used across multiple threads.

Parameters🔗

ScatteredDataInterpolatorHandlescatteredDataInterpolatorHandlescattered_data_interpolator_handle (input_control, state is modified) scattered_data_interpolator(-array) → (handle)HTuple (HHandle)HScatteredDataInterpolator, HTuple (IntPtr)MaybeSequence[HHandle]Htuple (handle)

Handle of the scattered data interpolator

Result🔗

If the parameters are valid, the operator clear_scattered_data_interpolatorClearScatteredDataInterpolator returns the value 2 (H_MSG_TRUE). If necessary, an exception is raised.

Combinations with other operators🔗

Combinations

Possible predecessors

create_scattered_data_interpolatorCreateScatteredDataInterpolator, interpolate_scattered_dataInterpolateScatteredData

Module🔗

Foundation