@stdlib/array
Version:
Arrays.
50 lines (41 loc) • 1.25 kB
TypeScript
/*
* @license Apache-2.0
*
* Copyright (c) 2024 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 { SignedIntegerDataType } from '@stdlib/types/array';
/**
* Output data type.
*/
type DataType = SignedIntegerDataType | 'float64';
/**
* Returns the minimum array data type for storing a provided signed integer value.
*
* @param value - scalar value
* @returns array data type
*
* @example
* var dt = minSignedIntegerDataType( 1280 );
* // returns 'int16'
*
* @example
* var dt = minSignedIntegerDataType( 3 );
* // returns 'int8'
*/
declare function minSignedIntegerDataType( value: number ): DataType;
// EXPORTS //
export = minSignedIntegerDataType;