Navigation:  ThinBASIC Modules > Core (thinBasic Core Engine) > Array functions >

ARRAY SHIFT

Previous pageReturn to chapter overviewNext page

 

Description

 

Shift left or right all array elements by nTimes position.

 

Syntax

 

ARRAY SHIFT ArrayVariable() [FOR nTimes] [FILL WITH NewValue]

 

Returns

 

None

 

Parameters

 

Name

Type

Optional

Meaning

ArrayVariable


No

Name of a declared and already dimensioned array.

nTimes

Number

Yes

Number of position to shift array elements. If omitted, 1 is assumed

 

If > 0, array elements will be shifted right by nTimes positions. Left most nTimes positions will be filled with NewValue (or zero if NewValue is omitted).

If < 0, array elements will be shifted left by nTimes positions Right most nTimes positions will be filled with NewValue (or zero if NewValue is omitted).

NewValue

Number

Yes

Value used to fill moved element positions. If omitted, zero will be used.

 

Remarks

 

Restrictions

 

Array MUST be numeric [any type].

 

See also

 

Examples