convert_tuple_to_vector_1dconvert_tuple_to_vector_1dConvertTupleToVector1dconvert_tuple_to_vector_1dConvertTupleToVector1dConvertTupleToVector1d (Operator)

Name

convert_tuple_to_vector_1dconvert_tuple_to_vector_1dConvertTupleToVector1dconvert_tuple_to_vector_1dConvertTupleToVector1dConvertTupleToVector1d — Distribute the elements of a tuple to a vector.

Signature

convert_tuple_to_vector_1d( : : InputTuple, SubTupleLength : ResultVector)

Description

convert_tuple_to_vector_1dconvert_tuple_to_vector_1dConvertTupleToVector1dconvert_tuple_to_vector_1dConvertTupleToVector1dConvertTupleToVector1d transforms a tuple into a vector variable. The input tuple InputTupleInputTupleInputTupleInputTupleInputTupleinputTuple is split into sub-tuples each comprising of SubTupleLengthSubTupleLengthSubTupleLengthSubTupleLengthSubTupleLengthsubTupleLength elements. The sub-tuples are stored in the output vector ResultVectorResultVectorResultVectorResultVectorResultVectorresultVector.

Parameters

InputTupleInputTupleInputTupleInputTupleInputTupleinputTuple (input_control) number(-array) → (real / integer / string)

Input tuple.

SubTupleLengthSubTupleLengthSubTupleLengthSubTupleLengthSubTupleLengthsubTupleLength (input_control) number → (integer)

Desired length of the resulting tuples in the output vector.

Default value: 1

ResultVectorResultVectorResultVectorResultVectorResultVectorresultVector (output_control) number-vector{1} → (real / integer / string)

Output vector.

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

Module

Foundation