@stdlib/stats/base/stdevtk/docs/types/test.ts

Standard library statistical functions.

/*
* @license Apache-2.0
*
* Copyright (c) 2020 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 stdevtk = require( './index' );


// TESTS //

// The function returns a number...
{
	const x = new Float64Array( 10 );

	stdevtk( x.length, 1, x, 1 ); // $ExpectType number
}

// The compiler throws an error if the function is provided a first argument which is not a number...
{
	const x = new Float64Array( 10 );

	stdevtk( '10', 1, x, 1 ); // $ExpectError
	stdevtk( true, 1, x, 1 ); // $ExpectError
	stdevtk( false, 1, x, 1 ); // $ExpectError
	stdevtk( null, 1, x, 1 ); // $ExpectError
	stdevtk( undefined, 1, x, 1 ); // $ExpectError
	stdevtk( [], 1, x, 1 ); // $ExpectError
	stdevtk( {}, 1, x, 1 ); // $ExpectError
	stdevtk( ( x: number ): number => x, 1, x, 1 ); // $ExpectError
}

// The compiler throws an error if the function is provided a second argument which is not a number...
{
	const x = new Float64Array( 10 );

	stdevtk( x.length, '10', x, 1 ); // $ExpectError
	stdevtk( x.length, true, x, 1 ); // $ExpectError
	stdevtk( x.length, false, x, 1 ); // $ExpectError
	stdevtk( x.length, null, x, 1 ); // $ExpectError
	stdevtk( x.length, undefined, x, 1 ); // $ExpectError
	stdevtk( x.length, [], x, 1 ); // $ExpectError
	stdevtk( x.length, {}, x, 1 ); // $ExpectError
	stdevtk( x.length, ( x: number ): number => x, x, 1 ); // $ExpectError
}

// The compiler throws an error if the function is provided a third argument which is not a numeric array...
{
	const x = new Float64Array( 10 );

	stdevtk( x.length, 1, 10, 1 ); // $ExpectError
	stdevtk( x.length, 1, '10', 1 ); // $ExpectError
	stdevtk( x.length, 1, true, 1 ); // $ExpectError
	stdevtk( x.length, 1, false, 1 ); // $ExpectError
	stdevtk( x.length, 1, null, 1 ); // $ExpectError
	stdevtk( x.length, 1, undefined, 1 ); // $ExpectError
	stdevtk( x.length, 1, [ '1' ], 1 ); // $ExpectError
	stdevtk( x.length, 1, {}, 1 ); // $ExpectError
	stdevtk( x.length, 1, ( x: number ): number => x, 1 ); // $ExpectError
}

// The compiler throws an error if the function is provided a fourth argument which is not a number...
{
	const x = new Float64Array( 10 );

	stdevtk( x.length, 1, x, '10' ); // $ExpectError
	stdevtk( x.length, 1, x, true ); // $ExpectError
	stdevtk( x.length, 1, x, false ); // $ExpectError
	stdevtk( x.length, 1, x, null ); // $ExpectError
	stdevtk( x.length, 1, x, undefined ); // $ExpectError
	stdevtk( x.length, 1, x, [] ); // $ExpectError
	stdevtk( x.length, 1, x, {} ); // $ExpectError
	stdevtk( x.length, 1, x, ( x: number ): number => x ); // $ExpectError
}

// The compiler throws an error if the function is provided an unsupported number of arguments...
{
	const x = new Float64Array( 10 );

	stdevtk(); // $ExpectError
	stdevtk( x.length ); // $ExpectError
	stdevtk( x.length, 1 ); // $ExpectError
	stdevtk( x.length, 1, x ); // $ExpectError
	stdevtk( x.length, 1, x, 1, 10 ); // $ExpectError
}

// Attached to main export is an `ndarray` method which returns a number...
{
	const x = new Float64Array( 10 );

	stdevtk.ndarray( x.length, 1, x, 1, 0 ); // $ExpectType number
}

// The compiler throws an error if the `ndarray` method is provided a first argument which is not a number...
{
	const x = new Float64Array( 10 );

	stdevtk.ndarray( '10', 1, x, 1, 0 ); // $ExpectError
	stdevtk.ndarray( true, 1, x, 1, 0 ); // $ExpectError
	stdevtk.ndarray( false, 1, x, 1, 0 ); // $ExpectError
	stdevtk.ndarray( null, 1, x, 1, 0 ); // $ExpectError
	stdevtk.ndarray( undefined, 1, x, 1, 0 ); // $ExpectError
	stdevtk.ndarray( [], 1, x, 1, 0 ); // $ExpectError
	stdevtk.ndarray( {}, 1, x, 1, 0 ); // $ExpectError
	stdevtk.ndarray( ( x: number ): number => x, 1, x, 1, 0 ); // $ExpectError
}

// The compiler throws an error if the `ndarray` method is provided a second argument which is not a number...
{
	const x = new Float64Array( 10 );

	stdevtk.ndarray( x.length, '10', x, 1, 0 ); // $ExpectError
	stdevtk.ndarray( x.length, true, x, 1, 0 ); // $ExpectError
	stdevtk.ndarray( x.length, false, x, 1, 0 ); // $ExpectError
	stdevtk.ndarray( x.length, null, x, 1, 0 ); // $ExpectError
	stdevtk.ndarray( x.length, undefined, x, 1, 0 ); // $ExpectError
	stdevtk.ndarray( x.length, [], x, 1, 0 ); // $ExpectError
	stdevtk.ndarray( x.length, {}, x, 1, 0 ); // $ExpectError
	stdevtk.ndarray( x.length, ( x: number ): number => x, x, 1, 0 ); // $ExpectError
}

// The compiler throws an error if the `ndarray` method is provided a third argument which is not a numeric array...
{
	const x = new Float64Array( 10 );

	stdevtk.ndarray( x.length, 1, 10, 1, 0 ); // $ExpectError
	stdevtk.ndarray( x.length, 1, '10', 1, 0 ); // $ExpectError
	stdevtk.ndarray( x.length, 1, true, 1, 0 ); // $ExpectError
	stdevtk.ndarray( x.length, 1, false, 1, 0 ); // $ExpectError
	stdevtk.ndarray( x.length, 1, null, 1, 0 ); // $ExpectError
	stdevtk.ndarray( x.length, 1, undefined, 1, 0 ); // $ExpectError
	stdevtk.ndarray( x.length, 1, [ '1' ], 1, 0 ); // $ExpectError
	stdevtk.ndarray( x.length, 1, {}, 1, 0 ); // $ExpectError
	stdevtk.ndarray( x.length, 1, ( x: number ): number => x, 1, 0 ); // $ExpectError
}

// The compiler throws an error if the `ndarray` method is provided a fourth argument which is not a number...
{
	const x = new Float64Array( 10 );

	stdevtk.ndarray( x.length, 1, x, '10', 0 ); // $ExpectError
	stdevtk.ndarray( x.length, 1, x, true, 0 ); // $ExpectError
	stdevtk.ndarray( x.length, 1, x, false, 0 ); // $ExpectError
	stdevtk.ndarray( x.length, 1, x, null, 0 ); // $ExpectError
	stdevtk.ndarray( x.length, 1, x, undefined, 0 ); // $ExpectError
	stdevtk.ndarray( x.length, 1, x, [], 0 ); // $ExpectError
	stdevtk.ndarray( x.length, 1, x, {}, 0 ); // $ExpectError
	stdevtk.ndarray( x.length, 1, x, ( x: number ): number => x, 0 ); // $ExpectError
}

// The compiler throws an error if the `ndarray` method is provided a fifth argument which is not a number...
{
	const x = new Float64Array( 10 );

	stdevtk.ndarray( x.length, 1, x, 1, '10' ); // $ExpectError
	stdevtk.ndarray( x.length, 1, x, 1, true ); // $ExpectError
	stdevtk.ndarray( x.length, 1, x, 1, false ); // $ExpectError
	stdevtk.ndarray( x.length, 1, x, 1, null ); // $ExpectError
	stdevtk.ndarray( x.length, 1, x, 1, undefined ); // $ExpectError
	stdevtk.ndarray( x.length, 1, x, 1, [] ); // $ExpectError
	stdevtk.ndarray( x.length, 1, x, 1, {} ); // $ExpectError
	stdevtk.ndarray( x.length, 1, x, 1, ( x: number ): number => x ); // $ExpectError
}

// The compiler throws an error if the `ndarray` method is provided an unsupported number of arguments...
{
	const x = new Float64Array( 10 );

	stdevtk.ndarray(); // $ExpectError
	stdevtk.ndarray( x.length ); // $ExpectError
	stdevtk.ndarray( x.length, 1 ); // $ExpectError
	stdevtk.ndarray( x.length, 1, x ); // $ExpectError
	stdevtk.ndarray( x.length, 1, x, 1 ); // $ExpectError
	stdevtk.ndarray( x.length, 1, x, 1, 0, 10 ); // $ExpectError
}