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

import zeros = require( './../../../../zeros' );
import diagonal = require( './index' );


// TESTS //

// The function returns an ndarray...
{
	const x = zeros( [ 2, 2 ] );

	diagonal( x, [ 0, 1 ], 0, false ); // $ExpectType float64ndarray
}

// The compiler throws an error if the function is not provided a first argument which is an ndarray...
{
	diagonal( '5', [ 0, 1 ], 0, false ); // $ExpectError
	diagonal( 5, [ 0, 1 ], 0, false ); // $ExpectError
	diagonal( true, [ 0, 1 ], 0, false ); // $ExpectError
	diagonal( false, [ 0, 1 ], 0, false ); // $ExpectError
	diagonal( null, [ 0, 1 ], 0, false ); // $ExpectError
	diagonal( {}, [ 0, 1 ], 0, false ); // $ExpectError
	diagonal( [ '5' ], [ 0, 1 ], 0, false ); // $ExpectError
	diagonal( ( x: number ): number => x, [ 0, 1 ], 0, false ); // $ExpectError
}

// The compiler throws an error if the function is not provided a second argument which is an array-like object containing numbers...
{
	const x = zeros( [ 2, 2 ] );

	diagonal( x, '5', 0, false ); // $ExpectError
	diagonal( x, 5, 0, false ); // $ExpectError
	diagonal( x, true, 0, false ); // $ExpectError
	diagonal( x, false, 0, false ); // $ExpectError
	diagonal( x, null, 0, false ); // $ExpectError
	diagonal( x, {}, 0, false ); // $ExpectError
	diagonal( x, [ '5' ], 0, false ); // $ExpectError
	diagonal( x, ( x: number ): number => x, 0, false ); // $ExpectError
}

// The compiler throws an error if the function is not provided a third argument which is a number...
{
	const x = zeros( [ 2, 2 ] );

	diagonal( x, [ 0, 1 ], '5', false ); // $ExpectError
	diagonal( x, [ 0, 1 ], true, false ); // $ExpectError
	diagonal( x, [ 0, 1 ], false, false ); // $ExpectError
	diagonal( x, [ 0, 1 ], null, false ); // $ExpectError
	diagonal( x, [ 0, 1 ], {}, false ); // $ExpectError
	diagonal( x, [ 0, 1 ], [], false ); // $ExpectError
	diagonal( x, [ 0, 1 ], ( x: number ): number => x, false ); // $ExpectError
}

// The compiler throws an error if the function is not provided a fourth argument which is a boolean...
{
	const x = zeros( [ 2, 2 ] );

	diagonal( x, [ 0, 1 ], 0, '5' ); // $ExpectError
	diagonal( x, [ 0, 1 ], 0, 5 ); // $ExpectError
	diagonal( x, [ 0, 1 ], 0, null ); // $ExpectError
	diagonal( x, [ 0, 1 ], 0, {} ); // $ExpectError
	diagonal( x, [ 0, 1 ], 0, [] ); // $ExpectError
	diagonal( x, [ 0, 1 ], 0, ( x: number ): number => x ); // $ExpectError
}

// The compiler throws an error if the function is provided an unsupported number of arguments...
{
	const x = zeros( [ 2, 2 ] );

	diagonal(); // $ExpectError
	diagonal( x ); // $ExpectError
	diagonal( x, [ 0, 1 ] ); // $ExpectError
	diagonal( x, [ 0, 1 ], 0 ); // $ExpectError
	diagonal( x, [ 0, 1 ], 0, false, {} ); // $ExpectError
}