JSPM

@stdlib/array-base-take

0.0.1
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 24
  • Score
    100M100P100Q57538F
  • License Apache-2.0

Take elements from an array.

Package Exports

  • @stdlib/array-base-take
  • @stdlib/array-base-take/lib/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@stdlib/array-base-take) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

take

NPM version Build Status Coverage Status

Take elements from an array.

Installation

npm install @stdlib/array-base-take

Usage

var take = require( '@stdlib/array-base-take' );

take( x, indices )

Takes elements from an array.

var x = [ 1, 2, 3, 4 ];

var y = take( x, [ 1, 3 ] );
// returns [ 2, 4 ]

If indices is an empty array, the function returns an empty array.

var x = [ 1, 2, 3, 4 ];

var y = take( x, [] );
// returns []

Notes

  • The function does not perform bounds checking. If an index is less than zero or greater than the maximum index of x, the value of the corresponding element in the output array is undefined.

Examples

var filledBy = require( '@stdlib/array-base-filled-by' );
var discreteUniform = require( '@stdlib/random-base-discrete-uniform' );
var linspace = require( '@stdlib/array-base-linspace' );
var take = require( '@stdlib/array-base-take' );

// Generate a linearly spaced array:
var x = linspace( 0, 100, 11 );

// Generate an array of random indices:
var N = discreteUniform( 5, 15 );
var indices = filledBy( N, discreteUniform.factory( 0, x.length-1 ) );

// Take a random sample of elements from `x`:
var y = take( x, indices );

console.log( x );
console.log( indices );
console.log( y );

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

Community

Chat


License

See LICENSE.

Copyright © 2016-2023. The Stdlib Authors.