@stdlib/array-ones-like
TypeScript icon, indicating that this package has built-in type declarations

0.2.1 • Public • Published
About stdlib...

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

onesLike

NPM version Build Status Coverage Status

Create an array filled with ones and having the same length and data type as a provided array.

Installation

npm install @stdlib/array-ones-like

Usage

var onesLike = require( '@stdlib/array-ones-like' );

onesLike( x[, dtype] )

Creates an array filled with ones and having the same length and data type as a provided array x.

var x = [ 1, 2, 3, 4, 5 ];

var arr = onesLike( x );
// returns [ 1, 1, 1, 1, 1 ]

The function supports the following data types:

  • float64: double-precision floating-point numbers (IEEE 754)
  • float32: single-precision floating-point numbers (IEEE 754)
  • complex128: double-precision complex floating-point numbers
  • complex64: single-precision complex floating-point numbers
  • int32: 32-bit two's complement signed integers
  • uint32: 32-bit unsigned integers
  • int16: 16-bit two's complement signed integers
  • uint16: 16-bit unsigned integers
  • int8: 8-bit two's complement signed integers
  • uint8: 8-bit unsigned integers
  • uint8c: 8-bit unsigned integers clamped to 0-255
  • generic: generic JavaScript values

By default, the output array data type is inferred from the provided array x. To return an array having a different data type, provide a dtype argument.

var x = [ 0, 0 ];

var arr = onesLike( x, 'int32' );
// returns <Int32Array>[ 1, 1 ]

Notes

  • If the output array has a complex number data type, each element of the returned array has a real component equal to 1 and an imaginary component equal to 0.

Examples

var dtypes = require( '@stdlib/array-dtypes' );
var zeros = require( '@stdlib/array-zeros' );
var onesLike = require( '@stdlib/array-ones-like' );

// Create a zero-filled array:
var x = zeros( 4, 'complex128' );

// Get a list of array data types:
var dt = dtypes();

// Generate filled arrays...
var y;
var i;
for ( i = 0; i < dt.length; i++ ) {
    y = onesLike( x, dt[ i ] );
    console.log( y );
}

See Also


Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

Community

Chat


License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.

Package Sidebar

Install

npm i @stdlib/array-ones-like

Homepage

stdlib.io

Weekly Downloads

4

Version

0.2.1

License

Apache-2.0

Unpacked Size

33.1 kB

Total Files

11

Last publish

Collaborators

  • stdlib-bot
  • kgryte
  • planeshifter
  • rreusser