Skip to content

deserialize_matrixDeserializeMatrixDeserializeMatrixdeserialize_matrixT_deserialize_matrix🔗

Short description🔗

deserialize_matrixDeserializeMatrixDeserializeMatrixdeserialize_matrixT_deserialize_matrix — Deserialize a serialized matrix.

Signature🔗

deserialize_matrix( serialized_item SerializedItemHandle, out matrix MatrixID )void DeserializeMatrix( const HTuple& SerializedItemHandle, HTuple* MatrixID )static void HOperatorSet.DeserializeMatrix( HTuple serializedItemHandle, out HTuple matrixID )def deserialize_matrix( serialized_item_handle: HHandle ) -> HHandle

Herror T_deserialize_matrix( const Htuple SerializedItemHandle, Htuple* MatrixID )

void HMatrix::DeserializeMatrix( const HSerializedItem& SerializedItemHandle )

void HMatrix.DeserializeMatrix( HSerializedItem serializedItemHandle )

Description🔗

deserialize_matrixDeserializeMatrix deserializes a matrix, that was serialized by serialize_matrixSerializeMatrix (see fwrite_serialized_itemFwriteSerializedItem for an introduction of the basic principle of serialization). The serialized matrix is defined by the handle SerializedItemHandleserializedItemHandleserialized_item_handle. The deserialized values are stored in an automatically created matrix with the handle MatrixIDmatrixIDmatrix_id. Access to the elements of the matrix is possible e.g., with the operator get_full_matrixGetFullMatrix.

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🔗

SerializedItemHandleserializedItemHandleserialized_item_handle (input_control) serialized_item → (handle)HTuple (HHandle)HSerializedItem, HTuple (IntPtr)HHandleHtuple (handle)

Handle of the serialized item.

MatrixIDmatrixIDmatrix_id (output_control) matrix → (handle)HTuple (HHandle)HMatrix, HTuple (IntPtr)HHandleHtuple (handle)

Matrix handle.

Result🔗

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

Combinations with other operators🔗

Combinations

Possible predecessors

fread_serialized_itemFreadSerializedItem, receive_serialized_itemReceiveSerializedItem, serialize_matrixSerializeMatrix

Possible successors

get_full_matrixGetFullMatrix

Module🔗

Foundation