@stdlib/array/base/zeros2d/docs/types/index.d.ts

Arrays.

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

/**
* Two-dimensional nested array.
*/
type Array2D<T> = Array<Array<T>>;

/**
* Returns a zero-filled two-dimensional nested array.
*
* @param shape - array shape
* @returns output array
*
* @example
* var out = zeros2d( [ 1, 3 ] );
* // returns [ [ 0.0, 0.0, 0.0 ] ]
*/
declare function zeros2d( shape: Shape2D ): Array2D<number>;


// EXPORTS //

export = zeros2d;