convert_tuple_to_vector_1dconvert_tuple_to_vector_1dConvertTupleToVector1dConvertTupleToVector1dconvert_tuple_to_vector_1d (Operator)
Name
convert_tuple_to_vector_1dconvert_tuple_to_vector_1dConvertTupleToVector1dConvertTupleToVector1dconvert_tuple_to_vector_1d — Distribute the elements of a tuple to a vector.
Signature
def convert_tuple_to_vector_1d(input_tuple: MaybeSequence[Union[int, float, str]], sub_tuple_length: int) -> Sequence[Union[int, float, str]]
def convert_tuple_to_vector_1d_s(input_tuple: MaybeSequence[Union[int, float, str]], sub_tuple_length: int) -> Union[int, float, str]
Description
convert_tuple_to_vector_1dconvert_tuple_to_vector_1dConvertTupleToVector1dConvertTupleToVector1dConvertTupleToVector1dconvert_tuple_to_vector_1d transforms a tuple into
a vector variable. The input tuple InputTupleInputTupleInputTupleInputTupleinputTupleinput_tuple is split into
sub-tuples each comprising of SubTupleLengthSubTupleLengthSubTupleLengthSubTupleLengthsubTupleLengthsub_tuple_length elements. The
sub-tuples are stored in the output vector ResultVectorResultVectorResultVectorResultVectorresultVectorresult_vector.
Parameters
InputTupleInputTupleInputTupleInputTupleinputTupleinput_tuple (input_control) number(-array) → HTupleMaybeSequence[Union[int, float, str]]HTupleHtuple (real / integer / string) (double / int / long / string) (double / Hlong / HString) (double / Hlong / char*)
Input tuple.
SubTupleLengthSubTupleLengthSubTupleLengthSubTupleLengthsubTupleLengthsub_tuple_length (input_control) number → HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)
Desired length of the resulting tuples in the output
vector.
Default:
1
ResultVectorResultVectorResultVectorResultVectorresultVectorresult_vector (output_control) number-vector{1} → HTupleSequence[Union[int, float, str]]HTupleHtuple (real / integer / string) (double / int / long / string) (double / Hlong / HString) (double / Hlong / char*)
Output vector.
Result
If the values of the specified parameters are correct,
convert_tuple_to_vector_1dconvert_tuple_to_vector_1dConvertTupleToVector1dConvertTupleToVector1dConvertTupleToVector1dconvert_tuple_to_vector_1d returns 2 (
H_MSG_TRUE)
. Otherwise, an
exception is raised and an error code returned.
See also
convert_vector_to_tupleconvert_vector_to_tupleConvertVectorToTupleConvertVectorToTupleConvertVectorToTupleconvert_vector_to_tuple
Module
Foundation