tuple_first_ntuple_first_nTupleFirstNTupleFirstNtuple_first_n (Operator)
Name
tuple_first_ntuple_first_nTupleFirstNTupleFirstNtuple_first_n — Select the first elements of a tuple up to the index “n”.
Signature
def tuple_first_n(tuple: MaybeSequence[Union[float, int, str]], index: int) -> Sequence[Union[float, int, str]]
def tuple_first_n_s(tuple: MaybeSequence[Union[float, int, str]], index: int) -> Union[float, int, str]
Description
tuple_first_ntuple_first_nTupleFirstNTupleFirstNTupleFirstNtuple_first_n selects the first elements of TupleTupleTupleTupletupletuple
up to the index IndexIndexIndexIndexindexindex and returns them in SelectedSelectedSelectedSelectedselectedselected.
Indices of tuple elements start at 0,
that means, the first tuple element has got the index 0. In total,
IndexIndexIndexIndexindexindex+1 elements are returned.
IndexIndexIndexIndexindexindex must contain a single integer value (or a floating point
number that represents an integer value without fraction).
Exception: Empty input tuple
If TupleTupleTupleTupletupletuple is empty, an exception is raised.
HDevelop In-line Operation
HDevelop provides an in-line operation for tuple_first_ntuple_first_nTupleFirstNTupleFirstNTupleFirstNtuple_first_n,
which can be used in an expression in the following syntax:
Selected := firstn(Tuple, Index)
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.
IndexIndexIndexIndexindexindex (input_control) integer → HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)
Index of the 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_last_ntuple_last_nTupleLastNTupleLastNTupleLastNtuple_last_n,
tuple_selecttuple_selectTupleSelectTupleSelectTupleSelecttuple_select,
tuple_str_bit_selecttuple_str_bit_selectTupleStrBitSelectTupleStrBitSelectTupleStrBitSelecttuple_str_bit_select,
tuple_concattuple_concatTupleConcatTupleConcatTupleConcattuple_concat,
tuple_select_masktuple_select_maskTupleSelectMaskTupleSelectMaskTupleSelectMasktuple_select_mask
See also
tuple_removetuple_removeTupleRemoveTupleRemoveTupleRemovetuple_remove
Module
Foundation