offsetView

Return a typed array view having the same data type as a provided input typed array and starting at a specified index offset.

Installation

npm install @stdlib/strided-base-offset-view

Usage

var offsetView = require( '@stdlib/strided-base-offset-view' );

offsetView( x, offset )

Returns a typed array view having the same data type as a provided input typed array and starting at a specified index offset.

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

var x = new Float64Array( 10 );

var view = offsetView( x, 0 );
// returns <Float64Array>

var bool = ( view.buffer === x.buffer );
// returns true

var len = view.length;
// returns 10

The offset argument specifies the starting index of the returned typed array view relative to the input array x.

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

var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );

var view = offsetView( x, 2 );
// returns <Float64Array>

var len = view.length;
// returns 6

var v1 = view[ 0 ];
// returns 3.0

var v2 = view[ 1 ];
// returns 4.0

Examples

var Float64Array = require( '@stdlib/array-float64' );
var offsetView = require( '@stdlib/strided-base-offset-view' );

// Define a typed array:
var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
// returns <Float64Array>

// Create a view of the array:
var view = offsetView( x, 0 );
// returns <Float64Array>

// Set view elements:
view[ 0 ] = 9.0;
view[ 1 ] = 10.0;

// Get the first two elements of the original array:
var v0 = x[ 0 ];
// returns 9.0

var v1 = x[ 1 ];
// returns 10.0

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

License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.