tuple_lshtuple_lshTupleLshTupleLsh (Operator)

Name

tuple_lshtuple_lshTupleLshTupleLsh — Shift a tuple bitwise to the left.

Signature

tuple_lsh( : : T, Shift : Lsh)

Herror tuple_lsh(const Hlong T, const Hlong Shift, Hlong* Lsh)

Herror T_tuple_lsh(const Htuple T, const Htuple Shift, Htuple* Lsh)

void TupleLsh(const HTuple& T, const HTuple& Shift, HTuple* Lsh)

HTuple HTuple::TupleLsh(const HTuple& Shift) const

static void HOperatorSet.TupleLsh(HTuple t, HTuple shift, out HTuple lsh)

HTuple HTuple.TupleLsh(HTuple shift)

Description

tuple_lshtuple_lshTupleLshTupleLshTupleLsh shifts the tuple TTTTt bitwise to the left by ShiftShiftShiftShiftshift places. If no overflow occurs, this operation is equivalent to a multiplication 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 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_lshtuple_lshTupleLshTupleLshTupleLsh, which can be used in an expression in the following syntax:

Lsh := lsh(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.

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

Shifted input tuple.

Alternatives

tuple_multtuple_multTupleMultTupleMultTupleMult

See also

tuple_rshtuple_rshTupleRshTupleRshTupleRsh

Module

Foundation