serialize_matrixT_serialize_matrixSerializeMatrixSerializeMatrixserialize_matrix (Operator)

Name

serialize_matrixT_serialize_matrixSerializeMatrixSerializeMatrixserialize_matrix — Serialize a matrix.

Signature

serialize_matrix( : : MatrixID : SerializedItemHandle)

Herror T_serialize_matrix(const Htuple MatrixID, Htuple* SerializedItemHandle)

void SerializeMatrix(const HTuple& MatrixID, HTuple* SerializedItemHandle)

HSerializedItem HMatrix::SerializeMatrix() const

static void HOperatorSet.SerializeMatrix(HTuple matrixID, out HTuple serializedItemHandle)

HSerializedItem HMatrix.SerializeMatrix()

def serialize_matrix(matrix_id: HHandle) -> HHandle

Description

serialize_matrixserialize_matrixSerializeMatrixSerializeMatrixSerializeMatrixserialize_matrix serializes the data of a matrix (see fwrite_serialized_itemfwrite_serialized_itemFwriteSerializedItemFwriteSerializedItemFwriteSerializedItemfwrite_serialized_item for an introduction of the basic principle of serialization). The same data that is written in a file by write_matrixwrite_matrixWriteMatrixWriteMatrixWriteMatrixwrite_matrix is converted to a serialized item. The matrix is defined by the handle MatrixIDMatrixIDMatrixIDMatrixIDmatrixIDmatrix_id. The serialized matrix is returned by the handle SerializedItemHandleSerializedItemHandleSerializedItemHandleSerializedItemHandleserializedItemHandleserialized_item_handle and can be deserialized by deserialize_matrixdeserialize_matrixDeserializeMatrixDeserializeMatrixDeserializeMatrixdeserialize_matrix.

Execution Information

Parameters

MatrixIDMatrixIDMatrixIDMatrixIDmatrixIDmatrix_id (input_control)  matrix HMatrix, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Matrix handle.

SerializedItemHandleSerializedItemHandleSerializedItemHandleSerializedItemHandleserializedItemHandleserialized_item_handle (output_control)  serialized_item HSerializedItem, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Handle of the serialized item.

Result

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

Possible Predecessors

create_matrixcreate_matrixCreateMatrixCreateMatrixCreateMatrixcreate_matrix

Possible Successors

fwrite_serialized_itemfwrite_serialized_itemFwriteSerializedItemFwriteSerializedItemFwriteSerializedItemfwrite_serialized_item, send_serialized_itemsend_serialized_itemSendSerializedItemSendSerializedItemSendSerializedItemsend_serialized_item, deserialize_matrixdeserialize_matrixDeserializeMatrixDeserializeMatrixDeserializeMatrixdeserialize_matrix

Module

Foundation