Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "iter/to-array-view-right/docs/types/index.d"

Index

Type aliases

Binary

Binary: (value: any, index: number) => any

Map function invoked for each iterated value.

param

iterated value

param

iterated value index

returns

iterator value

Type declaration

    • (value: any, index: number): any
    • Parameters

      • value: any
      • index: number

      Returns any

Iterator

Iterator: Iter | IterableIterator

MapFunction

MapFunction: Nullary | Unary | Binary | Ternary

Map function invoked for each iterated value.

param

iterated value

param

iterated value index

param

source array-like object

returns

iterator value

Nullary

Nullary: () => any

Map function invoked for each iterated value.

returns

iterator value

Type declaration

    • (): any
    • Returns any

Ternary

Ternary: (value: any, index: number, src: ArrayLike<any>) => any

Map function invoked for each iterated value.

param

iterated value

param

iterated value index

param

source array-like object

returns

iterator value

Type declaration

    • (value: any, index: number, src: ArrayLike<any>): any
    • Parameters

      • value: any
      • index: number
      • src: ArrayLike<any>

      Returns any

Unary

Unary: (value: any) => any

Map function invoked for each iterated value.

param

iterated value

returns

iterator value

Type declaration

    • (value: any): any
    • Parameters

      • value: any

      Returns any

Functions

Export assignment iterator2arrayviewRight

  • Fills an array-like object view from right to left with values returned from an iterator.

    throws

    third argument must be an integer (starting index) or a callback function

    Parameters

    • iterator: Iterator

      source iterator

    • out: Collection

      output array

    • Optional mapFcn: MapFunction

      function to invoke for each iterated value

    • Optional thisArg: any

      execution context

    Returns Collection

    output array

    Example

    var randu = require( `@stdlib/random/iter/randu` );
    var Float64Array = require( `@stdlib/array/float64` );
    
    var iter = randu({
        'iter': 10
    });
    
    var arr = iterator2arrayviewRight( iter, new Float64Array( 20 ) );
    // returns <Float64Array>
  • Fills an array-like object view from right to left with values returned from an iterator.

    throws

    third argument must be an integer (starting index) or a callback function

    Parameters

    • iterator: Iterator

      source iterator

    • out: Collection

      output array

    • begin: number

      starting index (inclusive) (default: 0)

    • Optional mapFcn: MapFunction

      function to invoke for each iterated value

    • Optional thisArg: any

      execution context

    Returns Collection

    output array

    Example

    var randu = require( `@stdlib/random/iter/randu` );
    var Float64Array = require( `@stdlib/array/float64` );
    
    var iter = randu({
        'iter': 10
    });
    
    var arr = iterator2arrayviewRight( iter, new Float64Array( 20 ), 5 );
    // returns <Float64Array>
  • Fills an array-like object view from right to left with values returned from an iterator.

    throws

    third argument must be an integer (starting index) or a callback function

    throws

    fourth argument must be an integer (ending index) or a callback function

    Parameters

    • iterator: Iterator

      source iterator

    • out: Collection

      output array

    • begin: number

      starting index (inclusive) (default: 0)

    • end: number

      ending index (non-inclusive) (default: out.length)

    • Optional mapFcn: MapFunction

      function to invoke for each iterated value

    • Optional thisArg: any

      execution context

    Returns Collection

    output array

    Example

    var randu = require( `@stdlib/random/iter/randu` );
    var Float64Array = require( `@stdlib/array/float64` );
    
    var iter = randu({
        'iter': 10
    });
    
    var arr = iterator2arrayviewRight( iter, new Float64Array( 20 ), 5, 8 );
    // returns <Float64Array>