UNPKG

@stdlib/array

Version:
127 lines (76 loc) 2.89 kB
<!-- @license Apache-2.0 Copyright (c) 2022 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. --> # Constructors > Unsigned integer typed array constructors. <!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. --> <section class="intro"> </section> <!-- /.intro --> <!-- Package usage documentation. --> <section class="usage"> ## Usage ```javascript var ctors = require( '@stdlib/array/typed-unsigned-integer-ctors' ); ``` #### ctors( dtype ) Returns an unsigned integer typed array constructor for a specified data type. ```javascript var ctor = ctors( 'uint32' ); // returns <Function> ``` The function returns constructors for the following data types: - `uint16`: unsigned 16-bit integers. - `uint32`: unsigned 32-bit integers. - `uint8`: unsigned 8-bit integers. - `uint8c`: unsigned clamped 8-bit integers. If provided an unknown or unsupported data type, the function returns `null`. ```javascript var ctor = ctors( 'uint' ); // returns null ``` </section> <!-- /.usage --> <!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. --> <section class="notes"> </section> <!-- /.notes --> <!-- Package usage examples. --> <section class="examples"> ## Examples <!-- eslint no-undef: "error" --> ```javascript var dtypes = require( '@stdlib/array/typed-unsigned-integer-dtypes' ); var ctors = require( '@stdlib/array/typed-unsigned-integer-ctors' ); var DTYPES = dtypes(); var ctor; var i; for ( i = 0; i < DTYPES.length; i++ ) { ctor = ctors( DTYPES[ i ] ); console.log( ctor ); } ``` </section> <!-- /.examples --> <!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. --> <section class="references"> </section> <!-- /.references --> <!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. --> <section class="related"> </section> <!-- /.related --> <!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. --> <section class="links"> </section> <!-- /.links -->