Operator Reference

HALCON Operator Reference / Tuple / Selection

• HDevelop
• .NET
• Python
• C++
• C

ClassesClasses | | Operators

tuple_first_ntuple_first_nTupleFirstNTupleFirstNtuple_first_n (Operator)

tuple_first_ntuple_first_nTupleFirstNTupleFirstNtuple_first_n — Select the first elements of a tuple up to the index “n”.

Signature

tuple_first_n( : : Tuple, Index : Selected)

Herror tuple_first_n(const Hlong Tuple, const Hlong Index, Hlong* Selected)

Herror T_tuple_first_n(const Htuple Tuple, const Htuple Index, Htuple* Selected)

void TupleFirstN(const HTuple& Tuple, const HTuple& Index, HTuple* Selected)

HTuple HTuple::TupleFirstN(const HTuple& Index) const

static void HOperatorSet.TupleFirstN(HTuple tuple, HTuple index, out HTuple selected)

HTuple HTuple.TupleFirstN(HTuple index)

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_nTupleFirstNTupleFirstNtuple_first_n selects the first elements of TupleTupleTupletupletuple up to the index IndexIndexIndexindexindex and returns them in SelectedSelectedSelectedselectedselected. Indices of tuple elements start at 0, that means, the first tuple element has got the index 0. In total, IndexIndexIndexindexindex+1 elements are returned.

IndexIndexIndexindexindex must contain a single integer value (or a floating point number that represents an integer value without fraction).

Exception: Empty input tuple

If TupleTupleTupletupletuple is empty, an exception is raised.

HDevelop In-line Operation

HDevelop provides an in-line operation for tuple_first_ntuple_first_nTupleFirstNTupleFirstNtuple_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

TupleTupleTupletupletuple (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.

IndexIndexIndexindexindex (input_control)  integer → HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Index of the last element to select.

SelectedSelectedSelectedselectedselected (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_nTupleLastNTupleLastNtuple_last_n, tuple_selecttuple_selectTupleSelectTupleSelecttuple_select, tuple_str_bit_selecttuple_str_bit_selectTupleStrBitSelectTupleStrBitSelecttuple_str_bit_select, tuple_concattuple_concatTupleConcatTupleConcattuple_concat, tuple_select_masktuple_select_maskTupleSelectMaskTupleSelectMasktuple_select_mask

See also

tuple_removetuple_removeTupleRemoveTupleRemovetuple_remove

Module

Foundation

---

ClassesClasses | | Operators