tuple_rshtuple_rshTupleRshTupleRsh (Operator)

Name

tuple_rshtuple_rshTupleRshTupleRsh — Shift a tuple bitwise to the right.

Signature

tuple_rsh( : : T, Shift : Rsh)

Herror tuple_rsh(const Hlong T, const Hlong Shift, Hlong* Rsh)

Herror T_tuple_rsh(const Htuple T, const Htuple Shift, Htuple* Rsh)

void TupleRsh(const HTuple& T, const HTuple& Shift, HTuple* Rsh)

HTuple HTuple::TupleRsh(const HTuple& Shift) const

static void HOperatorSet.TupleRsh(HTuple t, HTuple shift, out HTuple rsh)

HTuple HTuple.TupleRsh(HTuple shift)

Description

tuple_rshtuple_rshTupleRshTupleRshTupleRsh shifts the tuple TTTTt bitwise to the right by ShiftShiftShiftShiftshift places. This operation is equivalent to a division by 2^{ShiftShiftShiftShiftshift}. If TTTTt is negative, the result depends on the hardware. If ShiftShiftShiftShiftshift is negative or larger than 32, the result is undefined. If both tuples have the same length the corresponding elements of both tuples are shifted. Otherwise, either TTTTt or ShiftShiftShiftShiftshift must have length 1. In this case, the operation is performed for each element of the longer tuple with the single element of the other tuple. The input tuples must contain only integer numbers.

Exception: Empty input tuple

If any of the input tuples is empty, the operator returns an empty tuple.

HDevelop In-line Operation

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

Rsh := rsh(T, Shift)

Execution Information

Parameters

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

Input tuple.

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

Number of places to shift the input tuple.

RshRshRshRshrsh (output_control)  integer(-array) HTupleHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Shifted input tuple.

Alternatives

tuple_divtuple_divTupleDivTupleDivTupleDiv

See also

tuple_lshtuple_lshTupleLshTupleLshTupleLsh

Module

Foundation