first

Return the first element of an array-like object.

Usage

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

first( x )

Returns the first element of an array-like object.

var x = [ 1, 2, 3 ];

var out = first( x );
// returns 1

Examples

var Complex64Array = require( '@stdlib/array/complex64' );
var realf = require( '@stdlib/complex/float32/real' );
var imagf = require( '@stdlib/complex/float32/imag' );
var first = require( '@stdlib/array/base/first' );

// Create a complex number array:
var arr = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );

// Return the first element:
var out = first( arr );
// returns <Complex64>

var re = realf( out );
// returns 1.0

var im = imagf( out );
// returns 2.0

console.log( '%d + %di', re, im );
// => '1 + 2i'