@stdlib/array-linspace

Generate a linearly spaced numeric array.

https://github.com/stdlib-js/array-linspace

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
○
DOI references
○
Academic publication links
○
Committers with academic emails
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (14.9%) to scientific vocabulary

Keywords

array generic javascript linear linspace math mathematics matlab node node-js nodejs stdlib utilities utils

Last synced: 6 months ago · JSON representation ·

Repository

Generate a linearly spaced numeric array.

Basic Info

Host: GitHub
Owner: stdlib-js
License: apache-2.0
Language: JavaScript
Default Branch: main
Homepage: https://github.com/stdlib-js/stdlib
Size: 1.58 MB

Statistics

Stars: 2
Watchers: 3
Forks: 0
Open Issues: 0
Releases: 0

Topics

array generic javascript linear linspace math mathematics matlab node node-js nodejs stdlib utilities utils

Created over 4 years ago · Last pushed 6 months ago

Metadata Files

Readme Changelog Contributing License Code of conduct Citation Security

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!

linspace

Generate a linearly spaced array over a specified interval.

## Installation ```bash npm install @stdlib/array-linspace ``` Alternatively, - To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]). - If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions). - For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]). The [branches.md][branches-url] 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 ```javascript var linspace = require( '@stdlib/array-linspace' ); ``` #### linspace( start, stop, length\[, options] ) Generates a linearly spaced array over a specified interval. ```javascript var arr = linspace( 0.0, 100.0, 6 ); // returns [ 0.0, 20.0, 40.0, 60.0, 80.0, 100.0 ] ``` If `length` is `0`, the function returns an empty array. ```javascript var arr = linspace( 0.0, 100.0, 0 ); // returns [] ``` If `length` is `1`, the function returns an array containing `stop`, but not `start`, when `endpoint` is `true`; otherwise, the function returns an array containing `start`, but not `stop`. ```javascript var arr = linspace( 0.0, 100.0, 1 ); // returns [ 100.0 ] arr = linspace( 0.0, 100.0, 1, { 'endpoint': true }); // returns [ 100.0 ] arr = linspace( 0.0, 100.0, 1, { 'endpoint': false }); // returns [ 0.0 ] ``` For real-valued `start` and `stop`, if `start` is less than `stop`, the output array will contain ascending values, and, if `start` is greater than `stop`, the output array will contain descending values. ```javascript var arr = linspace( 0.0, -100.0, 6 ); // returns [ 0.0, -20.0, -40.0, -60.0, -80.0, -100.0 ] ``` The function accepts the following `options`: - **dtype**: output array data type. Must be a [floating-point data type][@stdlib/array/typed-float-dtypes] or `'generic'`. If both `start` and `stop` are the same type (either `'float64'`, `'complex64'`, or `'complex128'`), the default output array data type is the same type as the input values (either `'float64'`, `'complex64'`, or `'complex128'`, respectively). Otherwise, the default output array data type is `'complex128'`. - **endpoint**: `boolean` indicating whether to include the `stop` value in the output array. If `false`, the function generates `length + 1` linearly spaced values over the interval `[start, stop]` and only writes `length` values to the output array, thus excluding `stop` from the output array. Accordingly, for a fixed `length`, the spacing between adjacent values in the output array changes depending on the value of `endpoint`. Default: `true`. By default, the function generates a linearly spaced array over the closed interval `[start, stop]`. To generate linearly spaced values over the half-open interval `[start, stop)`, set the `endpoint` option to `false`. ```javascript var opts = { 'endpoint': false }; var arr = linspace( 0.0, 100.0, 5, opts ); // returns [ 0.0, 20.0, 40.0, 60.0, 80.0 ] ``` When both `start` and `stop` are real-valued, the default output array data type is `'float64'`. To return an output array having a different data type, set the `dtype` option. ```javascript var opts = { 'dtype': 'generic' }; var arr = linspace( 0, 100, 6, opts ); // returns [ 0, 20, 40, 60, 80, 100 ] ``` When either `start` or `stop` is a complex number, the default output array data type is `'complex128'`. To return an output array having a different data type, set the `dtype` option. ```javascript var Complex128 = require( '@stdlib/complex-float64-ctor' ); var real = require( '@stdlib/complex-float64-real' ); var imag = require( '@stdlib/complex-float64-imag' ); var opts = { 'dtype': 'generic' }; var start = new Complex128( 0.0, 0.0 ); var stop = new Complex128( 100.0, 10.0 ); var arr = linspace( start, stop, 6, opts ); // returns [ , , , , , ] var z = arr[ 0 ]; // returns var re = real( z ); // returns 0.0 var im = imag( z ); // returns 0.0 z = arr[ 1 ]; // returns re = real( z ); // returns 20.0 im = imag( z ); // returns 2.0 // ... ``` #### linspace.assign( start, stop, out\[, options] ) Generates a linearly spaced sequence over a specified interval and assigns the results to a provided output array. ```javascript var Float64Array = require( '@stdlib/array-float64' ); var out = new Float64Array( 6 ); var arr = linspace.assign( 0.0, 100.0, out ); // returns [ 0.0, 20.0, 40.0, 60.0, 80.0, 100.0 ] var bool = ( arr === out ); // returns true ``` If the provided output array is empty, the function returns the provided output array unchanged. ```javascript var arr = linspace.assign( 0.0, 100.0, [] ); // returns [] ``` If the provided output array contains a single element, the function writes the `stop` value, but not `start`, when `endpoint` is `true`; otherwise, the function writes the `start` value, but not `stop`. ```javascript var arr = linspace.assign( 0.0, 100.0, [ -10.0 ] ); // returns [ 100.0 ] arr = linspace.assign( 0.0, 100.0, [ -10.0 ], { 'endpoint': true }); // returns [ 100.0 ] arr = linspace.assign( 0.0, 100.0, [ -10.0 ], { 'endpoint': false }); // returns [ 0.0 ] ``` For real-valued `start` and `stop`, if `start` is less than `stop`, the output array will contain ascending values, and, if `start` is greater than `stop`, the output array will contain descending values. ```javascript var Float64Array = require( '@stdlib/array-float64' ); var out = new Float64Array( 6 ); var arr = linspace.assign( 0.0, -100.0, out ); // returns [ 0.0, -20.0, -40.0, -60.0, -80.0, -100.0 ] ``` The function accepts the following `options`: - **endpoint**: `boolean` indicating whether to include the `stop` value in the output array. If `false`, the function generates `N + 1` linearly spaced values (where `N` is the length of the provided output array) over the interval `[start, stop]` and only writes `N` values to the output array, thus excluding `stop` from the output array. Accordingly, for a fixed `N`, the spacing between adjacent values in the output array changes depending on the value of `endpoint`. Default: `true`. By default, the function generates a linearly spaced array over the closed interval `[start, stop]`. To generate linearly spaced values over the half-open interval `[start, stop)`, set the `endpoint` option to `false`. ```javascript var Float64Array = require( '@stdlib/array-float64' ); var opts = { 'endpoint': false }; var out = new Float64Array( 5 ); var arr = linspace.assign( 0.0, 100.0, out, opts ); // returns [ 0.0, 20.0, 40.0, 60.0, 80.0 ] ```

## Notes - For `M >= 2`, the spacing between values is computed as ```text delta = (stop-start) / (M-1) ``` where `M` is the number of values to generate. Accordingly, values may not be evenly spaced due to floating-point rounding errors. - When the output array length is greater than `1` and `endpoint` is `true`, the output array is guaranteed to include the `start` and `stop` values. Beware, however, that values between `start` and `stop` are subject to floating-point rounding errors. Hence, ```javascript var arr = linspace( 0.0, 1.0, 3 ); // returns [ 0.0, ~0.5, 1.0 ] ``` where `arr[1]` is only guaranteed to be approximately equal to `0.5`. If you desire more control over element precision, consider using [`roundn`][@stdlib/math/base/special/roundn]: ```javascript var roundn = require( '@stdlib/math-base-special-roundn' ); // Create an array subject to floating-point rounding errors: var arr = linspace( 0.0, 1.0, 3, { 'dtype': 'generic' }); // Round each value to the nearest hundredth: var i; for ( i = 0; i < arr.length; i++ ) { arr[ i ] = roundn( arr[ i ], -2 ); } console.log( arr ); // => [ 0.0, 0.5, 1.0 ] ``` - For both functions, if both `start` and `stop` are real-valued, the output array data type may be any [floating-point data type][@stdlib/array/typed-float-dtypes] or `'generic'`. However, if either `start` or `stop` are complex numbers, the output array type must be a [complex floating-point data type][@stdlib/array/typed-complex-dtypes] or `'generic'`. - While the `assign` method accepts any array-like object for the output array when both `start` and `stop` are real-valued, providing an integer-valued typed array (e.g., [`Int32Array`][@stdlib/array/int32], etc) is not encouraged due to potential rounding errors during value generation and assignment and, thus, irregular spacing between adjacent values. Instead, consider using [`incrspace`][@stdlib/array/incrspace]. - When writing to a complex floating-point output array, real-valued `start` and `stop` values are treated as complex numbers having a real component equaling the provided value and having an imaginary component equaling `0`. - When generating linearly spaced complex floating-point numbers, the real and imaginary components are generated separately (i.e., real components are generated over the interval `[real(start), real(stop)]` and imaginary components are generated over the interval `[imag(start), imag(stop)]`).

## Examples ```javascript var linspace = require( '@stdlib/array-linspace' ); // Define function options: var opts = { 'dtype': 'generic' }; // Create arrays of varying lengths... var out = linspace( 0, 10, 10, opts ); console.log( out ); out = linspace( 0, 10, 11, opts ); console.log( out ); out = linspace( 0, 10, 21, opts ); console.log( out ); // Create an array with decremented values: out = linspace( 10, 0, 11, opts ); console.log( out ); ```

* * * ## Notice This package is part of [stdlib][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][stdlib], see the main project [repository][stdlib]. #### Community [![Chat][chat-image]][chat-url] --- ## License See [LICENSE][stdlib-license]. ## Copyright Copyright © 2016-2025. The Stdlib [Authors][stdlib-authors].

Owner

Name: stdlib
Login: stdlib-js
Kind: organization

Website: https://stdlib.io
Twitter: stdlibjs
Repositories: 3,692
Profile: https://github.com/stdlib-js

Standard library for JavaScript.

Citation (CITATION.cff)

cff-version: 1.2.0
title: stdlib
message: >-
  If you use this software, please cite it using the
  metadata from this file.

type: software

authors:
  - name: The Stdlib Authors
    url: https://github.com/stdlib-js/stdlib/graphs/contributors

repository-code: https://github.com/stdlib-js/stdlib
url: https://stdlib.io

abstract: |
  Standard library for JavaScript and Node.js.

keywords:
  - JavaScript
  - Node.js
  - TypeScript
  - standard library
  - scientific computing
  - numerical computing
  - statistical computing

license: Apache-2.0 AND BSL-1.0

date-released: 2016

GitHub Events

Total

Push event: 13

Last Year

Push event: 13

Committers

Last synced: about 2 years ago

All Time

Total Commits: 59
Total Committers: 1
Avg Commits per committer: 59.0
Development Distribution Score (DDS): 0.0

Past Year

Commits: 12
Committers: 1
Avg Commits per committer: 12.0
Development Distribution Score (DDS): 0.0

Top Committers

Name	Email	Commits
stdlib-bot	n**y@s**o	59

Committer Domains (Top 20 + Academic)

stdlib.io: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time

Total issues: 0
Total pull requests: 0
Average time to close issues: N/A
Average time to close pull requests: N/A
Total issue authors: 0
Total pull request authors: 0
Average comments per issue: 0
Average comments per pull request: 0
Merged pull requests: 0
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 0
Pull requests: 0
Average time to close issues: N/A
Average time to close pull requests: N/A
Issue authors: 0
Pull request authors: 0
Average comments per issue: 0
Average comments per pull request: 0
Merged pull requests: 0
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

Total packages: 1
Total downloads:
- npm 2,440 last-month

Total dependent packages: 66
Total dependent repositories: 1
Total versions: 10
Total maintainers: 4

npmjs.org: @stdlib/array-linspace

Generate a linearly spaced array over a specified interval.

Homepage: https://stdlib.io
License: Apache-2.0
Latest release: 0.2.1
published almost 2 years ago

Versions: 10
Dependent Packages: 66
Dependent Repositories: 1
Downloads: 2,440 Last month

Rankings

Dependent packages count: 0.5%

Downloads: 6.4%

Average: 10.1%

Dependent repos count: 10.6%

Forks count: 15.8%

Stargazers count: 17.2%

Maintainers (4)

planeshifter rreusser stdlib-bot kgryte

Funding

type: opencollective
url: https://opencollective.com/stdlib

Last synced: 6 months ago

Dependencies

package.json npm

@stdlib/array-base-zeros ^0.0.x development
@stdlib/array-complex128 ^0.0.x development
@stdlib/array-complex64 ^0.0.x development
@stdlib/array-float32 ^0.0.x development
@stdlib/array-float64 ^0.0.x development
@stdlib/assert-is-array ^0.0.x development
@stdlib/assert-is-array-like-object ^0.0.x development
@stdlib/assert-is-complex128 ^0.0.x development
@stdlib/assert-is-complex128array ^0.0.x development
@stdlib/assert-is-complex64 ^0.0.x development
@stdlib/assert-is-complex64array ^0.0.x development
@stdlib/assert-is-float32array ^0.0.x development
@stdlib/assert-is-float64array ^0.0.x development
@stdlib/bench ^0.0.x development
@stdlib/math-base-special-pow ^0.0.x development
@stdlib/utils-every-by ^0.0.x development
@stdlib/utils-nary-function ^0.0.x development
istanbul ^0.4.1 development
tap-spec 5.x.x development
tape git+https://github.com/kgryte/tape.git#fix/globby development
@stdlib/array-base-arraylike2object ^0.0.x
@stdlib/array-dtype ^0.0.x
@stdlib/array-typed-float-ctors ^0.0.x
@stdlib/assert-has-own-property ^0.0.x
@stdlib/assert-is-boolean ^0.0.x
@stdlib/assert-is-collection ^0.0.x
@stdlib/assert-is-complex-like ^0.0.x
@stdlib/assert-is-nonnegative-integer ^0.0.x
@stdlib/assert-is-number ^0.0.x
@stdlib/assert-is-plain-object ^0.0.x
@stdlib/assert-is-string ^0.0.x
@stdlib/complex-dtype ^0.0.x
@stdlib/complex-float32 ^0.0.x
@stdlib/complex-float64 ^0.0.x
@stdlib/complex-imag ^0.0.x
@stdlib/complex-imagf ^0.0.x
@stdlib/complex-real ^0.0.x
@stdlib/complex-realf ^0.0.x
@stdlib/math-base-assert-is-nan ^0.0.x
@stdlib/strided-base-reinterpret-complex128 ^0.0.x
@stdlib/strided-base-reinterpret-complex64 ^0.0.x
@stdlib/string-format ^0.0.x
@stdlib/types ^0.0.x
@stdlib/utils-define-nonenumerable-read-only-property ^0.0.x

.github/workflows/benchmark.yml actions

actions/checkout v3 composite
actions/setup-node v3 composite

.github/workflows/cancel.yml actions

styfle/cancel-workflow-action 0.11.0 composite

.github/workflows/close_pull_requests.yml actions

superbrothers/close-pull-request v3 composite

.github/workflows/examples.yml actions

actions/checkout v3 composite
actions/setup-node v3 composite

.github/workflows/npm_downloads.yml actions

actions/checkout v3 composite
actions/setup-node v3 composite
actions/upload-artifact v3 composite
distributhor/workflow-webhook v3 composite

.github/workflows/productionize.yml actions

act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite
stdlib-js/bundle-action main composite
stdlib-js/transform-errors-action main composite

.github/workflows/publish.yml actions

JS-DevTools/npm-publish v1 composite
act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite
styfle/cancel-workflow-action 0.11.0 composite

.github/workflows/test.yml actions

act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite

.github/workflows/test_bundles.yml actions

act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite
denoland/setup-deno v1 composite

.github/workflows/test_coverage.yml actions

act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite
codecov/codecov-action v3 composite
distributhor/workflow-webhook v3 composite

.github/workflows/test_install.yml actions

act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite

@stdlib/array-linspace

Science Score: 44.0%

Keywords

Repository

Basic Info

Statistics

Topics

Metadata Files

README.md

linspace

Owner

Citation (CITATION.cff)

GitHub Events

Total

Last Year

Committers

All Time

Past Year

Top Committers

Committer Domains (Top 20 + Academic)

Issues and Pull Requests

All Time

Past Year

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

npmjs.org: @stdlib/array-linspace

Rankings

Maintainers (4)

Funding

Dependencies