deserialize_matrixT_deserialize_matrixDeserializeMatrixDeserializeMatrixdeserialize_matrix (Operator)

Name

deserialize_matrixT_deserialize_matrixDeserializeMatrixDeserializeMatrixdeserialize_matrix — Deserialize a serialized matrix.

Signature

deserialize_matrix( : : SerializedItemHandle : MatrixID)

Description

deserialize_matrixdeserialize_matrixDeserializeMatrixDeserializeMatrixDeserializeMatrixdeserialize_matrix deserializes a matrix, that was serialized by serialize_matrixserialize_matrixSerializeMatrixSerializeMatrixSerializeMatrixserialize_matrix (see fwrite_serialized_itemfwrite_serialized_itemFwriteSerializedItemFwriteSerializedItemFwriteSerializedItemfwrite_serialized_item for an introduction of the basic principle of serialization). The serialized matrix is defined by the handle SerializedItemHandleSerializedItemHandleSerializedItemHandleSerializedItemHandleserializedItemHandleserialized_item_handle. The deserialized values are stored in an automatically created matrix with the handle MatrixIDMatrixIDMatrixIDMatrixIDmatrixIDmatrix_id. Access to the elements of the matrix is possible e.g. with the operator get_full_matrixget_full_matrixGetFullMatrixGetFullMatrixGetFullMatrixget_full_matrix.

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

SerializedItemHandleSerializedItemHandleSerializedItemHandleSerializedItemHandleserializedItemHandleserialized_item_handle (input_control) serialized_item → (handle)

Handle of the serialized item.

MatrixIDMatrixIDMatrixIDMatrixIDmatrixIDmatrix_id (output_control) matrix → (handle)

Matrix handle.

Result

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

Possible Predecessors

fread_serialized_itemfread_serialized_itemFreadSerializedItemFreadSerializedItemFreadSerializedItemfread_serialized_item, receive_serialized_itemreceive_serialized_itemReceiveSerializedItemReceiveSerializedItemReceiveSerializedItemreceive_serialized_item, serialize_matrixserialize_matrixSerializeMatrixSerializeMatrixSerializeMatrixserialize_matrix

Possible Successors

get_full_matrixget_full_matrixGetFullMatrixGetFullMatrixGetFullMatrixget_full_matrix

Module

Foundation

Operators