/*
* @license Apache-2.0
*
* Copyright (c) 2025 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 { typedndarray } from '@stdlib/types/ndarray';

/**
* Interface describing `unshift`.
*/
interface Unshift {
	/**
	* Returns a one-dimensional ndarray formed by prepending provided scalar values to a one-dimensional input ndarray.
	*
	* @param x - input ndarray
	* @param values - scalar values
	* @returns output ndarray
	*
	* @example
	* var array = require( './../../../array' );
	*
	* var x = array( [ 1.0, 2.0, 3.0, 4.0 ] );
	*
	* var out = unshift( x, -2.0, -1.0, 0.0 );
	* // returns <ndarray>[ -2.0, -1.0, 0.0, 1.0, 2.0, 3.0, 4.0 ]
	*/
	<T = unknown>( x: typedndarray<T>, ...values: Array<T> ): typedndarray<T>;

	/**
	* Prepends provided scalar values to a one-dimensional input ndarray and assigns the result to a provided one-dimensional output ndarray.
	*
	* @param x - input ndarray
	* @param arg0 - first scalar value
	* @param out - output ndarray
	* @returns output ndarray
	*
	* @example
	* var array = require( './../../../array' );
	* var empty = require( './../../../empty' );
	*
	* var x = array( [ 1.0, 2.0, 3.0, 4.0 ] );
	* var y = empty( [ 5 ] );
	*
	* var out = unshift.assign( x, -2.0, y );
	* // returns <ndarray>[ -2.0, 1.0, 2.0, 3.0, 4.0 ]
	*
	* var bool = ( out === y );
	* // returns true
	*/
	assign<T = unknown, U extends typedndarray<T> = typedndarray<T>>( x: typedndarray<T>, arg0: T, out: U ): U;

	/**
	* Prepends provided scalar values to a one-dimensional input ndarray and assigns the result to a provided one-dimensional output ndarray.
	*
	* @param x - input ndarray
	* @param arg0 - first scalar value
	* @param arg1 - second scalar value
	* @param out - output ndarray
	* @returns output ndarray
	*
	* @example
	* var array = require( './../../../array' );
	* var empty = require( './../../../empty' );
	*
	* var x = array( [ 1.0, 2.0, 3.0, 4.0 ] );
	* var y = empty( [ 6 ] );
	*
	* var out = unshift.assign( x, -1.0, 0.0, y );
	* // returns <ndarray>[ -1.0, 0.0, 1.0, 2.0, 3.0, 4.0 ]
	*
	* var bool = ( out === y );
	* // returns true
	*/
	assign<T = unknown, U extends typedndarray<T> = typedndarray<T>>( x: typedndarray<T>, arg0: T, arg1: T, out: U ): U;

	/**
	* Prepends provided scalar values to a one-dimensional input ndarray and assigns the result to a provided one-dimensional output ndarray.
	*
	* @param x - input ndarray
	* @param arg0 - first scalar value
	* @param arg1 - second scalar value
	* @param arg2 - third scalar value
	* @param out - output ndarray
	* @returns output ndarray
	*
	* @example
	* var array = require( './../../../array' );
	* var empty = require( './../../../empty' );
	*
	* var x = array( [ 1.0, 2.0, 3.0, 4.0 ] );
	* var y = empty( [ 7 ] );
	*
	* var out = unshift.assign( x, -2.0, -1.0, 0.0, y );
	* // returns <ndarray>[ -2.0, -1.0, 0.0, 1.0, 2.0, 3.0, 4.0 ]
	*
	* var bool = ( out === y );
	* // returns true
	*/
	assign<T = unknown, U extends typedndarray<T> = typedndarray<T>>( x: typedndarray<T>, arg0: T, arg1: T, arg2: T, out: U ): U;

	/**
	* Prepends provided scalar values to a one-dimensional input ndarray and assigns the result to a provided one-dimensional output ndarray.
	*
	* @param x - input ndarray
	* @param arg0 - first scalar value
	* @param arg1 - second scalar value
	* @param arg2 - third scalar value
	* @param arg3 - fourth scalar value
	* @param out - output ndarray
	* @returns output ndarray
	*
	* @example
	* var array = require( './../../../array' );
	* var empty = require( './../../../empty' );
	*
	* var x = array( [ 1.0, 2.0, 3.0, 4.0 ] );
	* var y = empty( [ 8 ] );
	*
	* var out = unshift.assign( x, -3.0, -2.0, -1.0, 0.0, y );
	* // returns <ndarray>[ -3.0, -2.0, -1.0, 0.0, 1.0, 2.0, 3.0, 4.0 ]
	*
	* var bool = ( out === y );
	* // returns true
	*/
	assign<T = unknown, U extends typedndarray<T> = typedndarray<T>>( x: typedndarray<T>, arg0: T, arg1: T, arg2: T, arg3: T, out: U ): U;

	/**
	* Prepends provided scalar values to a one-dimensional input ndarray and assigns the result to a provided one-dimensional output ndarray.
	*
	* @param x - input ndarray
	* @param arg0 - first scalar value
	* @param arg1 - second scalar value
	* @param arg2 - third scalar value
	* @param arg3 - fourth scalar value
	* @param arg4 - fifth scalar value
	* @param out - output ndarray
	* @returns output ndarray
	*
	* @example
	* var array = require( './../../../array' );
	* var empty = require( './../../../empty' );
	*
	* var x = array( [ 1.0, 2.0, 3.0, 4.0 ] );
	* var y = empty( [ 9 ] );
	*
	* var out = unshift.assign( x, -4.0, -3.0, -2.0, -1.0, 0.0, y );
	* // returns <ndarray>[ -4.0, -3.0, -2.0, -1.0, 0.0, 1.0, 2.0, 3.0, 4.0 ]
	*
	* var bool = ( out === y );
	* // returns true
	*/
	assign<T = unknown, U extends typedndarray<T> = typedndarray<T>>( x: typedndarray<T>, arg0: T, arg1: T, arg2: T, arg3: T, arg4: T, out: U ): U;

	/**
	* Prepends provided scalar values to a one-dimensional input ndarray and assigns the result to a provided one-dimensional output ndarray.
	*
	* @param x - input ndarray
	* @param arg0 - first scalar value
	* @param arg1 - second scalar value
	* @param arg2 - third scalar value
	* @param arg3 - fourth scalar value
	* @param arg4 - fifth scalar value
	* @param args - additional scalar values and an output ndarray
	* @param out - output ndarray
	* @returns output ndarray
	*
	* @example
	* var array = require( './../../../array' );
	* var empty = require( './../../../empty' );
	*
	* var x = array( [ 1.0, 2.0, 3.0, 4.0 ] );
	* var y = empty( [ 10 ] );
	*
	* var out = unshift.assign( x, -5.0, -4.0, -3.0, -2.0, -1.0, 0.0, y );
	* // returns <ndarray>[ -5.0, -4.0, -3.0, -2.0, -1.0, 0.0, 1.0, 2.0, 3.0, 4.0 ]
	*
	* var bool = ( out === y );
	* // returns true
	*/
	assign<T = unknown, U extends typedndarray<T> = typedndarray<T>>( x: typedndarray<T>, arg0: T, arg1: T, arg2: T, arg3: T, arg4: T, ...args: Array<T | U> ): U;
}

/**
* Returns a one-dimensional ndarray formed by prepending provided scalar values to a one-dimensional input ndarray.
*
* @param x - input ndarray
* @param values - scalar values
* @returns output ndarray
*
* @example
* var array = require( '@stdlib/ndarray/array' );
*
* var x = array( [ 1.0, 2.0, 3.0, 4.0 ] );
*
* var out = unshift( x, -2.0, -1.0, 0.0 );
* // returns <ndarray>[ -2.0, -1.0, 0.0, 1.0, 2.0, 3.0, 4.0 ]
*
* @example
* var array = require( '@stdlib/ndarray/array' );
* var empty = require( '@stdlib/ndarray/empty' );
*
* var x = array( [ 1.0, 2.0, 3.0, 4.0 ] );
* var y = empty( [ 7 ] );
*
* var out = unshift.assign( x, -2.0, -1.0, 0.0, y );
* // returns <ndarray>[ -2.0, -1.0, 0.0, 1.0, 2.0, 3.0, 4.0 ]
*
* var bool = ( out === y );
* // returns true
*/
declare var unshift: Unshift;


// EXPORTS //

export = unshift;