@stdlib/strided/base/offset-view/docs/types/index.d.ts

Strided.

/*
* @license Apache-2.0
*
* Copyright (c) 2021 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.
*/

// TypeScript Version: 4.1

/// <reference types="@stdlib/types"/>

import { TypedArray, ComplexTypedArray } from '@stdlib/types/array';

/**
* Typed array or complex number typed array.
*/
type TypedArrayOrComplexTypedArray = TypedArray | ComplexTypedArray;

/**
* Returns a typed array view having the same data type as a provided input typed array and starting at a specified index offset.
*
* @param x - input array
* @param offset - starting index
* @returns typed array view
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
*
* var x = new Float64Array( 10 );
*
* var out = offsetView( x, 0 );
* // returns <Float64Array>
*
* var bool = ( out.buffer === x.buffer );
*/
declare function offsetView( x: TypedArrayOrComplexTypedArray, offset: number ): TypedArrayOrComplexTypedArray;


// EXPORTS //

export = offsetView;