About stdlib...

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

gjoinBetween

Return a string by joining strided array elements using a specified separator for each pair of consecutive elements.

Installation

npm install @stdlib/blas-ext-base-gjoin-between

Alternatively,

• To load the package in a website via a script tag without installation and bundlers, use the ES Module available on the esm branch (see README).
• If you are using Deno, visit the deno branch (see README for usage intructions).
• For use in Observable, or in browser/node environments, use the Universal Module Definition (UMD) build available on the umd branch (see README).

The branches.md file summarizes the available branches and displays a diagram illustrating their relationships.

To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.

Usage

var gjoinBetween = require( '@stdlib/blas-ext-base-gjoin-between' );

gjoinBetween( N, prefix, suffix, x, strideX, separators, strideS )

Returns a string by joining strided array elements using a specified separator for each pair of consecutive elements.

var x = [ 1, 2, 3, 4 ];
var sep = [ ' + ', ' - ', ' != ' ];

var str = gjoinBetween( x.length, 'op: ', '', x, 1, sep, 1 );
// returns 'op: 1 + 2 - 3 != 4'

The function has the following parameters:

• N: number of indexed elements.
• prefix: string to prepend to the output string.
• suffix: string to append to the output string.
• x: input array.
• strideX: stride length for x.
• separators: separators array.
• strideS: stride length for separators.

The N and stride parameters determine which elements in the strided arrays are accessed at runtime. For example, to join every other element:

var x = [ 1, 2, 3, 4, 5, 6 ];
var sep = [ ',', '-' ];

var str = gjoinBetween( 3, '', '', x, 2, sep, 1 );
// returns '1,3-5'

Note that indexing is relative to the first index. To introduce an offset, use typed array views.

var Float64Array = require( '@stdlib/array-float64' );

// Initial array:
var x0 = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );

// Create an offset view:
var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element

// Join elements:
var sep = [ ' | ', ' | ' ];
var str = gjoinBetween( 3, '[', ']', x1, 2, sep, 1 );
// returns '[2 | 4 | 6]'

gjoinBetween.ndarray( N, prefix, suffix, x, strideX, offsetX, separators, strideS, offsetS )

Returns a string by joining strided array elements using a specified separator for each pair of consecutive elements and alternative indexing semantics.

var x = [ 1, 2, 3, 4 ];
var sep = [ ' + ', ' - ', ' != ' ];

var str = gjoinBetween.ndarray( x.length, 'op: ', '', x, 1, 0, sep, 1, 0 );
// returns 'op: 1 + 2 - 3 != 4'

The function has the following additional parameters:

• offsetX: starting index for x.
• offsetS: starting index for separators.

While typed array views mandate a view offset based on the underlying buffer, the offset parameters support indexing semantics based on starting indices. For example, to access only the last three elements of the input strided array:

var x = [ 1, 2, 3, 4, 5, 6 ];
var sep = [ ' | ', ' | ' ];

var str = gjoinBetween.ndarray( 3, '[ ', ' ]', x, 1, x.length-3, sep, 1, 0 );
// returns '[ 4 | 5 | 6 ]'

Notes

• If N <= 0, both functions return the prefix and suffix joined together.
• The separators array is assumed to have at least N-1 indexed elements (i.e., equal to the number of "gaps" between consecutive elements).
• If an array element is either null or undefined, both functions serialize the element as an empty string.
• Both functions support array-like objects having getter and setter accessors for array element access (e.g., @stdlib/array-base/accessor).

Examples

var discreteUniform = require( '@stdlib/random-array-discrete-uniform' );
var filled = require( '@stdlib/array-base-filled' );
var gjoinBetween = require( '@stdlib/blas-ext-base-gjoin-between' );

var x = discreteUniform( 10, -100, 100, {
    'dtype': 'generic'
});
console.log( x );

var sep = filled( ' | ', x.length - 1 );
var out = gjoinBetween( x.length, '[ ', ' ]', x, 1, sep, 1 );
console.log( out );

---

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

---

License

See LICENSE.

Copyright

Copyright © 2016-2026. The Stdlib Authors.