tuple_selecttuple_selectTupleSelectTupleSelect (Operator)

Name

tuple_selecttuple_selectTupleSelectTupleSelect — Select single elements of a tuple.

Signature

tuple_select( : : Tuple, Index : Selected)

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

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

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

HTuple HTuple::TupleSelect(const HTuple& Index) const

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

HTuple HTuple.TupleSelect(HTuple index)

Description

tuple_selecttuple_selectTupleSelectTupleSelectTupleSelect selects one or more single elements of the tuple TupleTupleTupleTupletuple and returns them with SelectedSelectedSelectedSelectedselected. At this, IndexIndexIndexIndexindex determines the indices of the elements to select. Thus, IndexIndexIndexIndexindex may only contain integer values (any floating point number within IndexIndexIndexIndexindex 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.

Exception: Empty input tuples

If TupleTupleTupleTupletuple is empty, an exception is raised.

HDevelop In-line Operation

HDevelop provides an in-line operation for tuple_selecttuple_selectTupleSelectTupleSelectTupleSelect, which can be used in an expression in the following syntax:

Selected := Tuple[Index]

Selected := subset(Tuple, Index)

Execution Information

Parameters

TupleTupleTupleTupletuple (input_control)  tuple(-array) HTupleHTupleHtuple (integer / real / string) (int / long / double / string) (Hlong / double / HString) (Hlong / double / char*)

Input tuple.

IndexIndexIndexIndexindex (input_control)  integer(-array) HTupleHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Indices of the elements to select.

SelectedSelectedSelectedSelectedselected (output_control)  tuple(-array) HTupleHTupleHtuple (integer / real / string) (int / long / double / string) (Hlong / double / HString) (Hlong / double / char*)

Selected tuple element.

Alternatives

tuple_first_ntuple_first_nTupleFirstNTupleFirstNTupleFirstN, tuple_last_ntuple_last_nTupleLastNTupleLastNTupleLastN, tuple_str_bit_selecttuple_str_bit_selectTupleStrBitSelectTupleStrBitSelectTupleStrBitSelect, tuple_concattuple_concatTupleConcatTupleConcatTupleConcat, tuple_select_rangetuple_select_rangeTupleSelectRangeTupleSelectRangeTupleSelectRange, tuple_select_ranktuple_select_rankTupleSelectRankTupleSelectRankTupleSelectRank

See also

tuple_removetuple_removeTupleRemoveTupleRemoveTupleRemove

Module

Foundation