tuple_select_rangetuple_select_rangeTupleSelectRangeTupleSelectRangetuple_select_range (Operator)
Name
tuple_select_rangetuple_select_rangeTupleSelectRangeTupleSelectRangetuple_select_range — Select several elements of a tuple.
Signature
def tuple_select_range(tuple: MaybeSequence[Union[float, int, str]], leftindex: MaybeSequence[int], rightindex: MaybeSequence[int]) -> Sequence[Union[float, int, str]]
def tuple_select_range_s(tuple: MaybeSequence[Union[float, int, str]], leftindex: MaybeSequence[int], rightindex: MaybeSequence[int]) -> Union[float, int, str]
Description
tuple_select_rangetuple_select_rangeTupleSelectRangeTupleSelectRangeTupleSelectRangetuple_select_range selects several consecutive elements of the
input tuple TupleTupleTupleTupletupletuple and returns them with SelectedSelectedSelectedSelectedselectedselected.
At this, LeftindexLeftindexLeftindexLeftindexleftindexleftindex determines the index of the first element
and RightindexRightindexRightindexRightindexrightindexrightindex determines the index of the last element to select.
Thus, both parameters LeftindexLeftindexLeftindexLeftindexleftindexleftindex and RightindexRightindexRightindexRightindexrightindexrightindex must
contain a single integer value (any floating point number must
represent an integer value without fraction). Indices of tuple elements
start at 0, that means, the first tuple element has got the index 0.
The result tuple SelectedSelectedSelectedSelectedselectedselected contains every element from the
tuple TupleTupleTupleTupletupletuple that has got an index between LeftindexLeftindexLeftindexLeftindexleftindexleftindex
and RightindexRightindexRightindexRightindexrightindexrightindex (including the elements at position
LeftindexLeftindexLeftindexLeftindexleftindexleftindex and RightindexRightindexRightindexRightindexrightindexrightindex). If the indices are equal,
only one element is selected.
In addition, it is possible that the right index is LeftindexLeftindexLeftindexLeftindexleftindexleftindex - 1.
In this case and if the left or right index are valid an empty tuple
is returned. Hence, the index RightindexRightindexRightindexRightindexrightindexrightindex must be greater or
equal to LeftindexLeftindexLeftindexLeftindexleftindexleftindex - 1.
Exception: Empty input tuples
If LeftindexLeftindexLeftindexLeftindexleftindexleftindex and RightindexRightindexRightindexRightindexrightindexrightindex are empty tuples, the operator
returns an empty tuple. If only one of those parameters or TupleTupleTupleTupletupletuple
is an empty tuple, an exception is raised.
HDevelop In-line Operation
HDevelop provides an in-line operation for tuple_select_rangetuple_select_rangeTupleSelectRangeTupleSelectRangeTupleSelectRangetuple_select_range,
which can be used in an expression in the following syntax:
Selected := Tuple[Leftindex:Rightindex]
Execution Information
- Multithreading type: independent (runs in parallel even with exclusive operators).
- Multithreading scope: global (may be called from any thread).
- Processed without parallelization.
Parameters
TupleTupleTupleTupletupletuple (input_control) tuple(-array) → HTupleMaybeSequence[Union[float, int, str]]HTupleHtuple (integer / real / string) (int / long / double / string) (Hlong / double / HString) (Hlong / double / char*)
Input tuple.
LeftindexLeftindexLeftindexLeftindexleftindexleftindex (input_control) integer(-array) → HTupleMaybeSequence[int]HTupleHtuple (integer) (int / long) (Hlong) (Hlong)
Index of first element to select.
RightindexRightindexRightindexRightindexrightindexrightindex (input_control) integer(-array) → HTupleMaybeSequence[int]HTupleHtuple (integer) (int / long) (Hlong) (Hlong)
Index of last element to select.
SelectedSelectedSelectedSelectedselectedselected (output_control) tuple(-array) → HTupleSequence[Union[float, int, str]]HTupleHtuple (integer / real / string) (int / long / double / string) (Hlong / double / HString) (Hlong / double / char*)
Selected tuple elements.
Alternatives
tuple_selecttuple_selectTupleSelectTupleSelectTupleSelecttuple_select,
tuple_first_ntuple_first_nTupleFirstNTupleFirstNTupleFirstNtuple_first_n,
tuple_last_ntuple_last_nTupleLastNTupleLastNTupleLastNtuple_last_n,
tuple_select_masktuple_select_maskTupleSelectMaskTupleSelectMaskTupleSelectMasktuple_select_mask,
tuple_str_bit_selecttuple_str_bit_selectTupleStrBitSelectTupleStrBitSelectTupleStrBitSelecttuple_str_bit_select,
tuple_concattuple_concatTupleConcatTupleConcatTupleConcattuple_concat,
tuple_select_ranktuple_select_rankTupleSelectRankTupleSelectRankTupleSelectRanktuple_select_rank
See also
tuple_removetuple_removeTupleRemoveTupleRemoveTupleRemovetuple_remove
Module
Foundation