README.md

gjoin

Return a string created by joining one-dimensional ndarray elements using a specified separator.

Usage

var gjoin = require( '@stdlib/blas/ext/base/ndarray/gjoin' );

gjoin( arrays )

Returns a string created by joining one-dimensional ndarray elements using a specified separator.

var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
var ndarray = require( '@stdlib/ndarray/base/ctor' );

var xbuf = [ 1.0, 3.0, 4.0, 2.0 ];
var x = new ndarray( 'generic', xbuf, [ 4 ], [ 1 ], 0, 'row-major' );

var separator = scalar2ndarray( ',', {
    'dtype': 'generic'
});

var out = gjoin( [ x, separator ] );
// returns '1,3,4,2'

The function has the following parameters:

• arrays: array-like object containing the following ndarrays:

  • a one-dimensional input ndarray.
  • a zero-dimensional ndarray containing the separator.

Examples

var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
var ndarray = require( '@stdlib/ndarray/base/ctor' );
var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
var ndarray2array = require( '@stdlib/ndarray/to-array' );
var ndarraylike2scalar = require( '@stdlib/ndarray/base/ndarraylike2scalar' );
var gjoin = require( '@stdlib/blas/ext/base/ndarray/gjoin' );

var xbuf = discreteUniform( 10, -100, 100, {
    'dtype': 'generic'
});
var x = new ndarray( 'generic', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' );
console.log( ndarray2array( x ) );

var separator = scalar2ndarray( ',', {
    'dtype': 'generic'
});
console.log( 'Separator:', ndarraylike2scalar( separator ) );

var out = gjoin( [ x, separator ] );
console.log( out );