Documentation:Reference:TDI R - MdsWiki
Navigation
Personal tools

From MdsWiki

Jump to: navigation, search

RADIX (X)

F90 Inquiry. The base of the model representing numbers of the
same type as the argument.

Argument. X is numeric scalar or array.

Signals. None.
Units... None.
Form.... Integer scalar.

Result.. The base of the real or integer model.

Examples. RADIX(1.0) is 2 and RADIX(123) is 2 on the VAX.

RAMP ([SHAPE],[MOLD])

Transformation. Generate an ascending array.

Arguments Optional: SHAPE, MOLD.
SHAPE integer vector.
MOLD numeric.

Signals. None.
Units... None.
Form.... Type of MOLD and shape (dimensions) is SHAPE. If SHAPE
is absent, the result is a scalar. If MOLD is absent,
the result will be longs.

Result.. Successive integral values starting at zero.

Example. _X = RAMP([2,3,4],1d0) makes an array of double
precision floating point numbers of shape [2,3,4].
The values are _X[0,0,0]=0d0, _X[1,0,0]=1d0, ...
_X[1,2,3]=23d0.

See also. ARRAY, RANDOM, and ZERO.

RANDOM ([SHAPE],[MOLD])

F90 Modified Transformation. Generate an array of pseudorandom
numbers.

Arguments Optional: SHAPE, MOLD.
SHAPE integer vector.
MOLD numeric.

Signals. None.
Units... None.
Form.... Type of MOLD and shape (dimensions) is SHAPE. If SHAPE
is absent, the result is a scalar. If MOLD is absent,
the result will be floats.

Result.. The result will be different with each call unless
RANDOMSEED is used. Integers are on the full range,
floating numbers are from 0 to 1.

Example. _X = RANDOM(2,1d0) makes a vector of double precision
numbers with value
[.7043401852374758D0,.6857676661043094D0].

See also. ARRAY, RAMP, and ZERO.

random_seed ([PUT])

F90 Modified Miscellaneous. Initializes or restarts the pseudorandom
number generator.

Argument. Optional: PUT.
PUT integer array to set seed value.

Result.. Previous value of the seed.
Example. ??

RANGE (X)

F90 Inquiry. The decimal exponent range in the model representing the
type of the argument.

Argument. X must be real or complex, scalar or array.

Signals. None.
Units... None.
Form.... Integer scalar.
Result.. INT(MIN(LOG10(HUGE(X)),-LOG10(TINY(X)))).

Example. RANGE(1.0) is 38 on VAX.

RANK (X)

Inquiry. Number of dimensions, zero for scalar.

Argument. X is any VMS data type.

Signals. None.
Units... None.
Form.... Integer scalar.

Result.. The number of dimensions of an array, zero fo a scalar.

Examples. RANK(3) is 0. RANK(RAMP([3,4])) is 2.

RAW_OF (A)

MDS Operation. Get the raw field.

Argument. Descriptor as below.

Result.. A is searched for this:
DSC$K_DTYPE_SIGNAL, the raw field.
All others DATA(A).

Example. RAW_OF(BUILD_SIGNAL(6*$VALUE,42)) is 42.

See also. $VALUE and $THIS for use of this within a signal.

rc_droop (ARRAY,[DIM],RC)

Transformation. Correct for integrator droop along one dimension.

Arguments Optional: DIM.
ARRAY real array.
DIM integer scalar from 0 to n-1, where n is rank of ARRAY.
RC real scalar.

Signals. Same as ARRAY.
Units... Same as ARRAY.
Form.... Same as ARRAY.

Result.. The droop-corrected array. The correction formula is
X += integral from time=0 to t of X(t)*dt/RC,
where t is dimension DIM and X is the value along it.

Example. ??

read ([UNIT],fmt|*,[arg]...)

IO. Input from a file.??

REAL (A,[KIND])

Conversion Elemental. Convert to real.

Arguments Optional: KIND.
A numeric.
KIND scalar integer type number, for example, KIND(1d0).

Signals. Same as A.
Units... Same as A.
Form.... If KIND present, the type KIND; otherwise, the real
type with the same length. To get F, D, G, or H floating
result use F_FLOAT, etc.

Result.. Immediate at compilation.
(i) A is integer or real, the result is the truncated
approximation.
(ii) A is complex, the result is the approximation to the
real part.

Examples. REAL(-3) is -3.0. REAL(Z,Z) is real part of the complex.
This is done in TDISHR as REAL(Z). In F90, REAL(Z) sets
the default floating point size.

rebin (ARRAY,SIZE1,[SIZE2])

Transformation. Linearly expands or shrinks array.

Arguments
ARRAY vector or matrix.
SIZE1 integer scalar.
SIZE2 integer scalar, required for matrix, absent for vector.

Signals. Same as ARRAY.
Units... Same as ARRAY.
Form.... Vector of SIZE1 elements or
MATRIX of shape [SIZE1,SIZE2].

Result.. Linearly or bi-linearly interpolated values.

Example. ??

REM ([COMMENT],...)

Store a comment in an expression. No action is taken on the arguments.
REM(" ...") is a null operation that can retain a
comment; it must be where a null expression is valid.

Arguments Optional: COMMENT.
COMMENT,... any type.

Result.. None.

Example. REM("addition example"),2+3 is 5.

REPEAT (STRING,NCOPIES)

F90 Character Elemental. Concatenate several copies of a string.

Arguments
STRING character.
NCOPIES integer scalar, not negative.

Signals. Same as STRING.
Units... Same as STRING.
Form.... Character of length NCOPIES times that of STRING.

Result.. The concatenation of NCOPIES copies of STRING.
Examples. REPEAT('H',2) is "HH".
REPEAT('XYZ',0) is "".

REPLICATE (ARRAY,DIM,NCOPIES)

Transformation. Replicates an array by increasing a
dimension.

Arguments
ARRAY any type.
DIM integer scalar from 0 to n-1, where n is rank of ARRAY.
NCOPIES integer scalar.
Signals. Same as ARRAY except DIM-th dimension is removed.
Units... Same as ARRAY.
Form.... Same type and rank as array with shape [E[0:DIM-1],
MIN(NCOPIES,0)*E[DIM],E[DIM+1:n]] where E is the shape
of ARRAY.

Result.. NCOPIES replications of the values of ARRAY.

Example. REPLICATE([2 4],1,3) is [2 4 2 4 2 4].
[3 5] [3 5 3 5 3 5]
Written as an expression the array is
Set_Range(2,2,[2,3,3,4]) and gives
Set_Range(2,6,[2,3,4,5, 2,3,4,5, 2,3,4,5]).
For DIM=0 it gives
Set_Range(6,2,[2,3, 2,3, 2,3, 4,5, 4,5, 4,5]).

See Also. REPEAT to concatenate copies of a string.
SPREAD to increase the number of dimensions.

RESET_PRIVATE ()

Variables. Frees all private variables of all levels and their memory.

Arguments None.

Result.. None.

Side Effect. All private variables are freed and forgotton.

Example. RESET_PRIVATE().

RESET_PUBLIC ()

Variables. Frees all public variables and their memory.

Arguments None.

Result.. None.

Side Effect. All public variables are freed and forgotton.

Example. RESET_PUBLIC().

reshape (SOURCE,SHAPE,[PAD],[ORDER])

F90 Transformation. Change the shape of an array.

Arguments Optional: PAD, ORDER.
SOURCE any type, if PAD absent or size zero then its size must
be at least PRODUCT(SHAPE).
SHAPE integer vector of not more than 8 non-negative elements
PAD same type as SOURCE
ORDER integer of same shape as SHAPE and must be a permutation
of [0:n-1], where n is the size of SHAPE.
Default is [0:n-1].

Signals. Same as SOURCE.
Units... Single or common units of SOURCE and PAD.
Form.... An array of shape SHAPE with the type of SOURCE.

Result.. The elements are those of SOURCE followed by additional
copies of PAD to fill the size. The indexes are permuted
by ORDER.

Example. RESHAPE([1:6],[2,3]) is [1 3 5].
[2 4 6]

RETURN ([X])

CC Modified Statement. Return from a FUN with value.
Required Usual Form. RETURN (X);.
Function Form RETURN(X). May be syntatically invalid.

Argument. Optional: X.
X any. Unlike CC, the parentheses are required.
>>>>>>Note that a null is RETURN(*) or RETURN().

Result.. X.

Example. FUN(_A,_B) {RETURN(A*B);}

rewind (UNIT)

F90 IO. Set file pointer to initial record.??

rms (ARRAY,[DIM],[MASK])

Transformation. Root mean sum of the elements of ARRAY along dimension
DIM corresponding to the true elements of MASK. The rms
value is the square root of the mean of the squares of
the elements.

Arguments Optional: DIM, MASK.
ARRAY floating point array.
DIM integer scalar from 0 to n-1, where n is rank of ARRAY.
MASK logical and conformable to ARRAY.

Signals. Same as ARRAY if DIM-th or all dimensions omitted.
Units... Same as ARRAY.
Form.... Same type as ARRAY. It is a scalar if DIM is absent or
ARRAY is scalar or vector. Otherwise, the result is an
array of rank n-1 and shaped like ARRAY with DIM
subscript omitted.

Result.. The result without DIM is the rms value of the elements
of ARRAY, testing only those with true MASK values and
value not equal to the reserved operand ($ROPRAND). With
DIM, the value of an element of the result is rms of the
ARRAY elements with dimension DIM fixed as the element
number of the result. If no value is found, 0 is given.

Examples. RMS([1,2,3]) is sqrt(13/3.). RMS(_C,,_C GT 0) finds the
rms of positive element of C. If _B=[1 3 5],
[2 4 6]
RMS(_B,0) is sqrt([5,25,61]/2.) and
RMS(_B,1) is sqrt([35,56]/3.).

ROUTINE_OF (A)

MDS Operation. Get the routine field.

Argument. Descriptor as below.

Result.. A is searched for these:
DSC$K_DTYPE_CALL, the routine field.
DSC$K_DTYPE_ROUTINE, the routine field.
Otherwise, an error.

RRSPACING (X)

F90 Numeric Elemental. The reciprocal of the relative spacing of model
numbers near the argument value.

Argument. X must be real. Complex numbers are an error.

Signals. Same as X.
Units... Same as X.
Form.... Same as X.

Result.. Value ABS(X*b^-e)*b^p, where b is the real base, e is
exponent part of X, and p is the number of digits in X.

Example. RRSPACING(-3.0) is 0.75*2^24 on the VAX.