repl.txt

{{alias}}( [out,] shape, idx[, options] )
    Converts a linear index to an array of subscripts.

    Parameters
    ----------
    out: Array|TypedArray|Object (optional)
        Output array.

    shape: ArrayLike
        Array shape.

    idx: integer
        Linear index.

    options: Object (optional)
        Options.

    options.order: string (optional)
        Specifies whether an array is row-major (C-style) or column-major
        (Fortran style). Default: 'row-major'.

    options.mode: string (optional)
        Specifies how to handle a linear index which exceeds array dimensions.
        If equal to 'throw', the function throws an error when a linear index
        exceeds array dimensions. If equal to 'wrap', the function wraps around
        a linear index exceeding array dimensions using modulo arithmetic. If
        equal to 'clamp', the function sets a linear index exceeding array
        dimensions to either `0` (minimum linear index) or the maximum linear
        index. Default: 'throw'.

    Returns
    -------
    out: Array<integer>
        Subscripts.

    Examples
    --------
    > var d = [ 3, 3, 3 ];
    > var s = {{alias}}( d, 17 )
    [ 1, 2, 2 ]

    // Provide an output array:
    > var out = new Array( d.length );
    > s = {{alias}}( out, d, 17 )
    [ 1, 2, 2 ]
    > var bool = ( s === out )
    true

    See Also
    --------