tuple_find_firsttuple_find_firstTupleFindFirstTupleFindFirst (Operator)

Name

tuple_find_firsttuple_find_firstTupleFindFirstTupleFindFirst — Return the index of the first occurrence of a tuple within another tuple.

Signature

tuple_find_first( : : Tuple, ToFind : Index)

Herror tuple_find_first(const Hlong Tuple, const Hlong ToFind, Hlong* Index)

Herror T_tuple_find_first(const Htuple Tuple, const Htuple ToFind, Htuple* Index)

void TupleFindFirst(const HTuple& Tuple, const HTuple& ToFind, HTuple* Index)

HTuple HTuple::TupleFindFirst(const HTuple& ToFind) const

static void HOperatorSet.TupleFindFirst(HTuple tuple, HTuple toFind, out HTuple index)

HTuple HTuple.TupleFindFirst(HTuple toFind)

Description

tuple_find_firsttuple_find_firstTupleFindFirstTupleFindFirstTupleFindFirst searches forward through TupleTupleTupleTupletuple for the first occurrence of the values of the second tuple ToFindToFindToFindToFindtoFind and returns the IndexIndexIndexIndexindex (in relation to the first input tuple TupleTupleTupleTupletuple). For example, if TupleTupleTupleTupletuple contains the values [3,4,5,6,1,2,3,4,0] and ToFindToFindToFindToFindtoFind contains the values [3,4], the output IndexIndexIndexIndexindex is 0. If the first tuple does not contain the second tuple as a subtuple, tuple_find_firsttuple_find_firstTupleFindFirstTupleFindFirstTupleFindFirst returns -1 in IndexIndexIndexIndexindex. It is allowed to mix strings and numbers in the input tuples.

Exception: Empty input tuples

If either or both of the input tuples are empty, the operator returns an empty tuple.

HDevelop In-line Operation

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

Index := find_first(Tuple, ToFind)

Execution Information

Parameters

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

Input tuple to examine.

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

Input tuple with values to find.

IndexIndexIndexIndexindex (output_control)  integer HTupleHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Index of the first occurrence of the values to find.

Alternatives

tuple_findtuple_findTupleFindTupleFindTupleFind, tuple_find_lasttuple_find_lastTupleFindLastTupleFindLastTupleFindLast, tuple_sorttuple_sortTupleSortTupleSortTupleSort, tuple_equal_elemtuple_equal_elemTupleEqualElemTupleEqualElemTupleEqualElem

Module

Foundation