@stdlib/ndarray-numel/docs/types/index.d.ts

Return the number of elements in an ndarray.

/*
* @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 { ndarray } from '@stdlib/types/ndarray';

/**
* Returns the number of elements in an ndarray.
*
* @param x - input ndarray
* @returns number of elements
*
* @example
* var zeros = require( '@stdlib/ndarray-zeros' );
*
* var n = numel( zeros( [ 3, 3, 3 ] ) );
* // returns 27
*/
declare function numel( x: ndarray ): number;


// EXPORTS //

export = numel;