convert_vector_to_tupleT_convert_vector_to_tupleConvertVectorToTupleConvertVectorToTuple (Operator)

Name

convert_vector_to_tupleT_convert_vector_to_tupleConvertVectorToTupleConvertVectorToTuple — Concatenate the elements of a vector to a single tuple.

Signature

convert_vector_to_tuple( : : InputVector : ResultTuple)

convert_vector_to_tupleconvert_vector_to_tupleConvertVectorToTupleConvertVectorToTupleConvertVectorToTuple transforms a vector into a tuple. The elements of the input vector InputVectorInputVectorInputVectorInputVectorinputVector get concatenated and stored in the output tuple ResultTupleResultTupleResultTupleResultTupleresultTuple. If InputVectorInputVectorInputVectorInputVectorinputVector has a dimension of 2 or greater its elements are collected in a depth-first search. E.g., the input vector '{{{1},{2}},{{3},{4}}}'"{{{1},{2}},{{3},{4}}}""{{{1},{2}},{{3},{4}}}""{{{1},{2}},{{3},{4}}}""{{{1},{2}},{{3},{4}}}" will be turned into the result tuple [1,2,3,4].

Parameters

InputVectorInputVectorInputVectorInputVectorinputVector (input_control) number-vector → (real / integer / string)

Input vector.

ResultTupleResultTupleResultTupleResultTupleresultTuple (output_control) real(-array) → (real / integer / string)

Output tuple.

Result

If the values of the specified parameters are correct, convert_vector_to_tupleconvert_vector_to_tupleConvertVectorToTupleConvertVectorToTupleConvertVectorToTuple returns 2 (H_MSG_TRUE). Otherwise an exception is raised and an error code returned.

Module

Foundation