convert_vector_to_tupleT_convert_vector_to_tupleConvertVectorToTupleConvertVectorToTupleconvert_vector_to_tuple (Operator)
Name
convert_vector_to_tupleT_convert_vector_to_tupleConvertVectorToTupleConvertVectorToTupleconvert_vector_to_tuple — Concatenate the elements of a vector to a single tuple.
Signature
def convert_vector_to_tuple(input_vector: MaybeSequence[Union[int, float, str]]) -> Sequence[Union[int, float, str]]
def convert_vector_to_tuple_s(input_vector: MaybeSequence[Union[int, float, str]]) -> Union[int, float, str]
Description
convert_vector_to_tupleconvert_vector_to_tupleConvertVectorToTupleConvertVectorToTupleConvertVectorToTupleconvert_vector_to_tuple transforms a vector into
a tuple. The elements of the input vector InputVectorInputVectorInputVectorInputVectorinputVectorinput_vector get
concatenated and stored in the output tuple ResultTupleResultTupleResultTupleResultTupleresultTupleresult_tuple. If
InputVectorInputVectorInputVectorInputVectorinputVectorinput_vector 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}}}""{{{1},{2}},{{3},{4}}}" will be turned into the result tuple
[1,2,3,4].
Parameters
InputVectorInputVectorInputVectorInputVectorinputVectorinput_vector (input_control) number-vector → HTupleMaybeSequence[Union[int, float, str]]HTupleHtuple (real / integer / string) (double / int / long / string) (double / Hlong / HString) (double / Hlong / char*)
Input vector.
ResultTupleResultTupleResultTupleResultTupleresultTupleresult_tuple (output_control) real(-array) → HTupleSequence[Union[int, float, str]]HTupleHtuple (real / integer / string) (double / int / long / string) (double / Hlong / HString) (double / Hlong / char*)
Output tuple.
Result
If the values of the specified parameters are correct,
convert_vector_to_tupleconvert_vector_to_tupleConvertVectorToTupleConvertVectorToTupleConvertVectorToTupleconvert_vector_to_tuple returns 2 (
H_MSG_TRUE)
. Otherwise, an
exception is raised and an error code returned.
See also
convert_tuple_to_vector_1dconvert_tuple_to_vector_1dConvertTupleToVector1dConvertTupleToVector1dConvertTupleToVector1dconvert_tuple_to_vector_1d
Module
Foundation