Skip to content

README.md

Latest commit

 

History

History
188 lines (116 loc) · 5.38 KB

README.md

File metadata and controls

188 lines (116 loc) · 5.38 KB

gconjoin

Return a string created by joining strided array elements into a human-readable list using a conjunction.

Usage

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

gconjoin( N, prefix, suffix, conjunction, oxfordComma, x, strideX )

Returns a string created by joining strided array elements into a human-readable list using a conjunction.

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

var str = gconjoin( x.length, '', '', 'and', true, x, 1 );
// returns '1, 2, 3, and 4'

The function has the following parameters:

  • N: number of indexed elements.
  • prefix: string to prepend.
  • suffix: string to append.
  • conjunction: conjunction before the last element.
  • oxfordComma: boolean specifying whether to include an Oxford comma.
  • x: input array.
  • strideX: stride length.

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

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

var str = gconjoin( 3, '', '', 'and', true, x, 2 );
// returns '1, 3, and 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 str = gconjoin( 3, '', '', 'and', true, x1, 2 );
// returns '2, 4, and 6'

gconjoin.ndarray( N, prefix, suffix, conjunction, oxfordComma, x, strideX, offsetX )

Returns a string created by joining strided array elements into a human-readable list using a conjunction and alternative indexing semantics.

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

var str = gconjoin.ndarray( x.length, '', '', 'and', true, x, 1, 0 );
// returns '1, 2, 3, and 4'

The function has the following additional parameters:

  • offsetX: starting index.

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

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

var str = gconjoin.ndarray( 3, '', '', 'and', true, x, 1, x.length-3 );
// returns '4, 5, and 6'

Notes

  • If N <= 0, both functions return the prefix followed by the suffix.
  • If N < 2, the conjunction parameter is ignored.
  • If N < 3, the oxfordComma parameter has no effect.
  • If an array element is either null or undefined, both functions will 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 gconjoin = require( '@stdlib/blas/ext/base/gconjoin' );

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

var out = gconjoin( x.length, '', '', 'and', true, x, 1 );
console.log( out );