tuple_subtuple_subTupleSubTupleSubtuple_sub (Operator)

Name

tuple_subtuple_subTupleSubTupleSubtuple_sub — Subtract two tuples.

Signature

tuple_sub( : : D1, D2 : Diff)

Herror tuple_sub(double D1, double D2, double* Diff)

Herror T_tuple_sub(const Htuple D1, const Htuple D2, Htuple* Diff)

void TupleSub(const HTuple& D1, const HTuple& D2, HTuple* Diff)

HTuple HTuple::TupleSub(const HTuple& D2) const

static void HOperatorSet.TupleSub(HTuple d1, HTuple d2, out HTuple diff)

HTuple HTuple.TupleSub(HTuple d2)

def tuple_sub(d1: MaybeSequence[Union[float, int]], d2: MaybeSequence[Union[float, int]]) -> Sequence[Union[float, int]]

def tuple_sub_s(d1: MaybeSequence[Union[float, int]], d2: MaybeSequence[Union[float, int]]) -> Union[float, int]

Description

tuple_subtuple_subTupleSubTupleSubtuple_sub computes the difference of the input tuples D1D1D1d1d1 and D2D2D2d2d2. If both tuples have the same length the corresponding elements of both tuples are subtracted. Otherwise, either D1D1D1d1d1 or D2D2D2d2d2 must have length 1. In this case, the subtraction is performed for each element of the longer tuple with the single element of the other tuple. If two integer numbers are subtracted, the result is again an integer number. If one of the operands is a floating point number, the result is a floating point number. The subtraction 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_subtuple_subTupleSubTupleSubtuple_sub, which can be used in an expression in the following syntax:

Diff := D1 - D2

Execution Information

Parameters

D1D1D1d1d1 (input_control)  number(-array) HTupleMaybeSequence[Union[float, int]]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)

Input tuple 1.

D2D2D2d2d2 (input_control)  number(-array) HTupleMaybeSequence[Union[float, int]]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)

Input tuple 2.

DiffDiffDiffdiffdiff (output_control)  number(-array) HTupleSequence[Union[float, int]]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)

Difference of the input tuples.

Alternatives

tuple_addtuple_addTupleAddTupleAddtuple_add

Module

Foundation