All files base.js

100% Statements 103/103
100% Branches 1/1
100% Functions 0/0
100% Lines 103/103

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 1043x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x  
/**
* @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.
*/
 
'use strict';
 
// MODULES //
 
var dtypes = require( '@stdlib/ndarray/dtypes' );
var gjoinBetween = require( '@stdlib/blas/ext/base/ndarray/gjoin-between' );
var factory = require( '@stdlib/ndarray/base/unary-reduce-strided1d-dispatch-factory' );
 
 
// VARIABLES //
 
var idtypes0 = dtypes( 'all' ); // input ndarray
var idtypes1 = [ 'generic' ];   // prefix ndarray
var idtypes2 = [ 'generic' ];   // suffix ndarray
var idtypes3 = [ 'generic' ];   // separators ndarray
var odtypes = [ 'generic' ];
var policies = {
	'output': 'same', // note: because we always return a "generic" ndarray, this policy is effectively ignored
	'casting': 'none'
};
var table = {
	'default': gjoinBetween
};
 
 
// MAIN //
 
/**
* Returns an ndarray created by joining elements using specified separators for each pair of consecutive elements along one or more ndarray dimensions.
*
* @private
* @name joinBetween
* @type {Function}
* @param {ndarrayLike} x - input ndarray
* @param {ndarrayLike} prefix - prefix
* @param {ndarrayLike} suffix - suffix
* @param {ndarrayLike} separators - separators
* @param {Options} [options] - function options
* @param {IntegerArray} [options.dims] - list of dimensions over which to perform operation
* @param {boolean} [options.keepdims=false] - boolean indicating whether the reduced dimensions should be included in the returned ndarray as singleton dimensions
* @param {*} [options.dtype] - output ndarray data type
* @throws {TypeError} first argument must be an ndarray-like object
* @throws {TypeError} second argument must be an ndarray-like object
* @throws {TypeError} third argument must be an ndarray-like object
* @throws {TypeError} fourth argument must be an ndarray-like object
* @throws {TypeError} options argument must be an object
* @throws {RangeError} dimension indices must not exceed input ndarray bounds
* @throws {RangeError} number of dimension indices must not exceed the number of input ndarray dimensions
* @throws {Error} must provide valid options
* @returns {ndarray} output ndarray
*
* @example
* var array = require( '@stdlib/ndarray/array' );
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
* var ndarray = require( '@stdlib/ndarray/ctor' );
*
* // Create an input ndarray:
* var x = array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
* // returns <ndarray>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]
*
* // Create prefix and suffix ndarrays:
* var prefix = scalar2ndarray( '', {
*     'dtype': 'generic'
* });
* var suffix = scalar2ndarray( '', {
*     'dtype': 'generic'
* });
*
* // Create a separators ndarray:
* var separators = new ndarray( 'generic', [ ',' ], [ 1 ], [ 0 ], 0, 'row-major' );
*
* // Perform operation:
* var out = joinBetween( x, prefix, suffix, separators, {
*     'dtype': 'generic'
* });
* // returns <ndarray>[ '1,2,3,4,5,6' ]
*/
var joinBetween = factory( table, [ idtypes0, idtypes1, idtypes2, idtypes3 ], odtypes, policies ); // eslint-disable-line max-len
 
 
// EXPORTS //
 
module.exports = joinBetween;
 
// exports: { "assign": "joinBetween.assign" }