ones

Create an array filled with ones and having a specified length.

Installation

npm install @stdlib/array-ones

Alternatively,

To load the package in a website via a script tag without installation and bundlers, use the ES Module available on the esm branch (see README).
If you are using Deno, visit the deno branch (see README for usage intructions).
For use in Observable, or in browser/node environments, use the Universal Module Definition (UMD) build available on the umd branch (see README).

The branches.md file summarizes the available branches and displays a diagram illustrating their relationships.

To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.

Usage

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

ones( length[, dtype] )

Creates an array filled with ones and having a specified length.

var arr = ones( 2 );
// returns <Float64Array>[ 1.0, 1.0 ]

The function recognizes 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 float64 (i.e., a typed array). To specify an alternative data type, provide a dtype argument.

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

Notes

For complex number arrays, each entry 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 ones = require( '@stdlib/array-ones' );

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

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

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.