Operator Reference

tuple_modtuple_modTupleModTupleModtuple_mod (Operator)

tuple_modtuple_modTupleModTupleModtuple_mod — Calculate the remainder of the integer division of two tuples.

Signature

tuple_mod( : : T1, T2 : Mod)

Herror tuple_mod(const Hlong T1, const Hlong T2, Hlong* Mod)

Herror T_tuple_mod(const Htuple T1, const Htuple T2, Htuple* Mod)

void TupleMod(const HTuple& T1, const HTuple& T2, HTuple* Mod)

HTuple HTuple::TupleMod(const HTuple& T2) const

static void HOperatorSet.TupleMod(HTuple t1, HTuple t2, out HTuple mod)

HTuple HTuple.TupleMod(HTuple t2)

def tuple_mod(t1: MaybeSequence[int], t2: MaybeSequence[int]) -> Sequence[int]

def tuple_mod_s(t1: MaybeSequence[int], t2: MaybeSequence[int]) -> int

Description

tuple_modtuple_modTupleModTupleModtuple_mod returns the remainder of the integer division of the input tuples T1T1T1t1t1/T2T2T2t2t2 in the output tuple ModModModmodmod. If both tuples have the same length the division is performed for the corresponding elements of both tuples. Otherwise, either T1T1T1t1t1 or T2T2T2t2t2 must have length 1. In this case, the division is performed for each element of the longer tuple with the single element of the other tuple. The result is always an integer number. The division of strings is not allowed.

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

Mod := T1 % T2

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

T1T1T1t1t1 (input_control)  number(-array) HTupleMaybeSequence[int]HTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Input tuple 1.

T2T2T2t2t2 (input_control)  number(-array) HTupleMaybeSequence[int]HTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Input tuple 2.

Restriction: T2 != 0

ModModModmodmod (output_control)  number(-array) HTupleSequence[int]HTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Remainder of the division of the input tuples.

See also

tuple_fmodtuple_fmodTupleFmodTupleFmodtuple_fmod, tuple_divtuple_divTupleDivTupleDivtuple_div

Module

Foundation