ClassesClassesClassesClasses | | | | Operators

tuple_first_ntuple_first_nTupleFirstNtuple_first_nTupleFirstNTupleFirstN (Operator)

Name

tuple_first_ntuple_first_nTupleFirstNtuple_first_nTupleFirstNTupleFirstN — 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)

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

Herror 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

void HOperatorSetX.TupleFirstN(
[in] VARIANT Tuple, [in] VARIANT Index, [out] VARIANT* Selected)

VARIANT HTupleX.TupleFirstN(
[in] VARIANT Tuple, [in] VARIANT Index)

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

HTuple HTuple.TupleFirstN(HTuple index)

Description

tuple_first_ntuple_first_nTupleFirstNtuple_first_nTupleFirstNTupleFirstN 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_nTupleFirstNtuple_first_nTupleFirstNTupleFirstN, which can be used in an expression in the following syntax:

Selected := firstn(Tuple, Index)

Parallelization

Parameters

TupleTupleTupleTupleTupletuple (input_control)  number(-array) HTupleHTupleHTupleVARIANTHtuple (integer / real / string) (int / long / double / string) (Hlong / double / HString) (Hlong / double / char*) (Hlong / double / BSTR) (Hlong / double / char*)

Input tuple.

IndexIndexIndexIndexIndexindex (input_control)  number HTupleHTupleHTupleVARIANTHtuple (integer / real) (int / long / double) (Hlong / double) (Hlong / double) (Hlong / double) (Hlong / double)

Index of the last element to select.

SelectedSelectedSelectedSelectedSelectedselected (output_control)  number(-array) HTupleHTupleHTupleVARIANTHtuple (integer / real / string) (int / long / double / string) (Hlong / double / HString) (Hlong / double / char*) (Hlong / double / BSTR) (Hlong / double / char*)

Selected tuple elements.

Alternatives

tuple_last_ntuple_last_nTupleLastNtuple_last_nTupleLastNTupleLastN, tuple_selecttuple_selectTupleSelecttuple_selectTupleSelectTupleSelect, tuple_str_bit_selecttuple_str_bit_selectTupleStrBitSelecttuple_str_bit_selectTupleStrBitSelectTupleStrBitSelect, tuple_concattuple_concatTupleConcattuple_concatTupleConcatTupleConcat, tuple_select_masktuple_select_maskTupleSelectMasktuple_select_maskTupleSelectMaskTupleSelectMask

See also

tuple_removetuple_removeTupleRemovetuple_removeTupleRemoveTupleRemove

Module

Foundation


ClassesClassesClassesClasses | | | | Operators