NAME

setsubr - assign a value to a subrange of an array

SYNOPSIS

arr.setsubr(beg₀, end₀, ..., value)

DESCRIPTION

The setsubr() method assign a value to a subrange of the array arr. The arguments are provided in pairs beg_N, end_N, where beg_N is the starting index and end_N is the ending index (inclusive) for the Nth dimension. If nil is provided for beg_N, it defaults to 0. If nil is provided for end_N, it defaults to the last index of that dimension.

The value must conform to the implied shape of the subrange, which is [end₀-beg₀+1,end₁-beg₁+1,...]. A scalar value will be replicated to every element of the subrange.

The setsubr method is equivalent to the subrange assignment operator arr[beg₀:end₀, beg₁:end₁, ...] = value. Note that the setsubr method will be called to overload the subrange assignment operator.

RETURN VALUE

None

ERRORS

TypeCheck if arr is not an object or array.
ArgCheck if an odd number of index arguments is provided.
RangeCheck if an index is out of bounds or if too many index pairs are provided.

EXAMPLE

    a = [10, 20, 30, 40, 50]
    a.setsubr(1, 3, 1000)

    a
10 1000 1000 1000 50

SEE ALSO

subr