/*
* @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.
*/

// TypeScript Version: 4.1

/// <reference types="@stdlib/types"/>

import { ArrayLike } from '@stdlib/types/array';
import { typedndarray } from '@stdlib/types/ndarray';

/**
* Interface describing `vconcat`.
*/
interface Vconcat {
	/**
	* Concatenates a list of ndarrays along the second-to-last dimension.
	*
	* ## Notes
	*
	* -   Input ndarrays must have more than one dimension.
	*
	* @param arrays - array-like object containing input ndarrays
	* @returns output ndarray
	*
	* @example
	* var array = require( './../../../array' );
	*
	* var x = array( [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] );
	* // returns <ndarray>[ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]
	*
	* var y = array( [ [ 5.0, 6.0 ], [ 7.0, 8.0 ], [ 9.0, 10.0 ] ] );
	* // returns <ndarray>[ [ 5.0, 6.0 ], [ 7.0, 8.0 ], [ 9.0, 10.0 ] ]
	*
	* var out = vconcat( [ x, y ] );
	* // returns <ndarray>[ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ], [ 7.0, 8.0 ], [ 9.0, 10.0 ] ]
	*/
	<T = unknown>( arrays: ArrayLike<typedndarray<T>> ): typedndarray<T>;

	/**
	* Concatenates a list of ndarrays along the second-to-last dimension and assigns results to a provided output ndarray.
	*
	* ## Notes
	*
	* -   Input ndarrays must have more than one dimension.
	*
	* @param arrays - array-like object containing input ndarrays
	* @param out - output ndarray
	* @returns output ndarray
	*
	* @example
	* var array = require( './../../../array' );
	* var zeros = require( './../../../zeros' );
	*
	* var x = array( [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] );
	* // returns <ndarray>[ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]
	*
	* var y = array( [ [ 5.0, 6.0 ], [ 7.0, 8.0 ], [ 9.0, 10.0 ] ] );
	* // returns <ndarray>[ [ 5.0, 6.0 ], [ 7.0, 8.0 ], [ 9.0, 10.0 ] ]
	*
	* var z = zeros( [ 5, 2 ] );
	* // returns <ndarray>[ [ 0.0, 0.0 ], [ 0.0, 0.0 ], [ 0.0, 0.0 ], [ 0.0, 0.0 ], [ 0.0, 0.0 ] ]
	*
	* var out = vconcat.assign( [ x, y ], z );
	* // returns <ndarray>[ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ], [ 7.0, 8.0 ], [ 9.0, 10.0 ] ]
	*
	* var bool = ( out === z );
	* // returns true
	*/
	assign<T = unknown, U = unknown, V extends typedndarray<U> = typedndarray<U>>( arrays: ArrayLike<typedndarray<T>>, out: V ): V;
}

/**
* Concatenates a list of ndarrays along the second-to-last dimension.
*
* ## Notes
*
* -   Input ndarrays must have more than one dimension.
*
* @param arrays - array-like object containing input ndarrays
* @returns output ndarray
*
* @example
* var array = require( '@stdlib/ndarray/array' );
*
* var x = array( [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] );
* // returns <ndarray>[ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]
*
* var y = array( [ [ 5.0, 6.0 ], [ 7.0, 8.0 ], [ 9.0, 10.0 ] ] );
* // returns <ndarray>[ [ 5.0, 6.0 ], [ 7.0, 8.0 ], [ 9.0, 10.0 ] ]
*
* var out = vconcat( [ x, y ] );
* // returns <ndarray>[ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ], [ 7.0, 8.0 ], [ 9.0, 10.0 ] ]
*
* @example
* var array = require( '@stdlib/ndarray/array' );
* var zeros = require( '@stdlib/ndarray/zeros' );
*
* var x = array( [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] );
* // returns <ndarray>[ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]
*
* var y = array( [ [ 5.0, 6.0 ], [ 7.0, 8.0 ], [ 9.0, 10.0 ] ] );
* // returns <ndarray>[ [ 5.0, 6.0 ], [ 7.0, 8.0 ], [ 9.0, 10.0 ] ]
*
* var z = zeros( [ 5, 2 ] );
* // returns <ndarray>[ [ 0.0, 0.0 ], [ 0.0, 0.0 ], [ 0.0, 0.0 ], [ 0.0, 0.0 ], [ 0.0, 0.0 ] ]
*
* var out = vconcat.assign( [ x, y ], z );
* // returns <ndarray>[ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ], [ 7.0, 8.0 ], [ 9.0, 10.0 ] ]
*
* var bool = ( out === z );
* // returns true
*/
declare var vconcat: Vconcat;


// EXPORTS //

export = vconcat;