Skip to content

serialize_matrixSerializeMatrixSerializeMatrixserialize_matrixT_serialize_matrix🔗

Short description🔗

serialize_matrixSerializeMatrixSerializeMatrixserialize_matrixT_serialize_matrix — Serialize a matrix.

Signature🔗

serialize_matrix( matrix MatrixID, out serialized_item SerializedItemHandle )void SerializeMatrix( const HTuple& MatrixID, HTuple* SerializedItemHandle )static void HOperatorSet.SerializeMatrix( HTuple matrixID, out HTuple serializedItemHandle )def serialize_matrix( matrix_id: HHandle ) -> HHandle

Herror T_serialize_matrix( const Htuple MatrixID, Htuple* SerializedItemHandle )

HSerializedItem HMatrix::SerializeMatrix( ) const

HSerializedItem HMatrix.SerializeMatrix( )

Description🔗

serialize_matrixSerializeMatrix serializes the data of a matrix (see fwrite_serialized_itemFwriteSerializedItem for an introduction of the basic principle of serialization). The same data that is written in a file by write_matrixWriteMatrix is converted to a serialized item. The matrix is defined by the handle MatrixIDmatrixIDmatrix_id. The serialized matrix is returned by the handle SerializedItemHandleserializedItemHandleserialized_item_handle and can be deserialized by deserialize_matrixDeserializeMatrix.

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🔗

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

Matrix handle.

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

Handle of the serialized item.

Result🔗

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

Combinations with other operators🔗

Combinations

Possible predecessors

create_matrixCreateMatrix

Possible successors

fwrite_serialized_itemFwriteSerializedItem, send_serialized_itemSendSerializedItem, deserialize_matrixDeserializeMatrix

Module🔗

Foundation