insert ( : : Input, Value, Index : Result )

Assignment of a value into a tuple.

insert assigns a single value into an tuple. If the first input parameter and the first output parameter are identical, the call:

   insert (Areas, Area, Radius-1, Areas)
is not presented in the program text as an operator call, but in the more intuitive form as:
   Areas[Radius-1] := Area
.


Parameters

Input (input_control)
real(-array) -> real / integer / string
Tuple, where the new value has to be inserted.
Default value: '[]'

Value (input_control)
real -> real / integer / string
Value that has to be inserted.
Default value: 1
Typical range of values: 0 <= Value <= 1000000

Index (input_control)
integer -> integer
Index position for new value.
Default value: 0
Suggested values: 0, 1, 2, 3, 4, 5, 6
Minimum increment: 1

Result (output_control)
real(-array) -> real / integer / string
Result tuple with inserted values.


Result

insert returns 2 (H_MSG_TRUE) if the evaluation of the expression yields no error.


Parallelization Information

insert is reentrant, local, and processed without parallelization.


Alternatives

assign


Module

Foundation



Copyright © 1996-2008 MVTec Software GmbH