<!--

@license Apache-2.0

Copyright (c) 2026 The Stdlib Authors.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

-->

# gconjoin

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

<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->

<section class="intro">

</section>

<!-- /.intro -->

<!-- Package usage documentation. -->

<section class="usage">

## Usage

```javascript
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.

```javascript
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:

```javascript
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`][mdn-typed-array] views.

```javascript
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'
```

<!-- lint disable maximum-heading-length -->

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

<!-- lint enable maximum-heading-length -->

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

```javascript
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`][mdn-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:

```javascript
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'
```

</section>

<!-- /.usage -->

<!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->

<section class="notes">

## 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`][@stdlib/array/base/accessor]).

</section>

<!-- /.notes -->

<!-- Package usage examples. -->

<section class="examples">

## Examples

<!-- eslint no-undef: "error" -->

```javascript
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 );
```

</section>

<!-- /.examples -->

<!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->

<section class="references">

</section>

<!-- /.references -->

<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->

<section class="related">

</section>

<!-- /.related -->

<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->

<section class="links">

[mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray

[@stdlib/array/base/accessor]: https://www.npmjs.com/package/@stdlib/array-base-accessor

</section>

<!-- /.links -->
